NeuroML C++ API  2.3.0
C++ API for NeuroML 2
List of all members
neuroml2::ContinuousConnection Class Reference

Class corresponding to the ContinuousConnection schema type. More...

#include <NeuroML_v2.3.hxx>

+ Inheritance diagram for neuroml2::ContinuousConnection:
+ Collaboration diagram for neuroml2::ContinuousConnection:

preComponent

Accessor and modifier functions for the preComponent required attribute.

typedef ::neuroml2::NmlId preComponent_type
 Attribute type.
 
typedef ::xsd::cxx::tree::traits< preComponent_type, char > preComponent_traits
 Attribute traits type.
 
const preComponent_typepreComponent () const
 Return a read-only (constant) reference to the attribute. More...
 
preComponent_typepreComponent ()
 Return a read-write reference to the attribute. More...
 
void preComponent (const preComponent_type &x)
 Set the attribute value. More...
 
void preComponent (::std::unique_ptr< preComponent_type > p)
 Set the attribute value without copying. More...
 

postComponent

Accessor and modifier functions for the postComponent required attribute.

typedef ::neuroml2::NmlId postComponent_type
 Attribute type.
 
typedef ::xsd::cxx::tree::traits< postComponent_type, char > postComponent_traits
 Attribute traits type.
 
const postComponent_typepostComponent () const
 Return a read-only (constant) reference to the attribute. More...
 
postComponent_typepostComponent ()
 Return a read-write reference to the attribute. More...
 
void postComponent (const postComponent_type &x)
 Set the attribute value. More...
 
void postComponent (::std::unique_ptr< postComponent_type > p)
 Set the attribute value without copying. More...
 

Constructors

 ContinuousConnection (const id_type &, const preCell_type &, const postCell_type &, const preComponent_type &, const postComponent_type &)
 Create an instance from the ultimate base and initializers for required elements and attributes.
 
 ContinuousConnection (const ::xercesc::DOMElement &e, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Create an instance from a DOM element. More...
 
 ContinuousConnection (const ContinuousConnection &x, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Copy constructor. More...
 
virtual ContinuousConnection_clone (::xml_schema::flags f=0, ::xml_schema::container *c=0) const
 Copy the instance polymorphically. More...
 
ContinuousConnectionoperator= (const ContinuousConnection &x)
 Copy assignment operator. More...
 
virtual ~ContinuousConnection ()
 Destructor.
 

Additional Inherited Members

- Public Types inherited from neuroml2::BaseConnectionNewFormat
typedef ::xml_schema::string preCell_type
 Attribute type.
 
typedef ::xsd::cxx::tree::traits< preCell_type, char > preCell_traits
 Attribute traits type.
 
typedef ::neuroml2::NonNegativeInteger preSegment_type
 Attribute type.
 
typedef ::xsd::cxx::tree::traits< preSegment_type, char > preSegment_traits
 Attribute traits type.
 
typedef ::neuroml2::ZeroToOne preFractionAlong_type
 Attribute type.
 
typedef ::xsd::cxx::tree::traits< preFractionAlong_type, char > preFractionAlong_traits
 Attribute traits type.
 
typedef ::xml_schema::string postCell_type
 Attribute type.
 
typedef ::xsd::cxx::tree::traits< postCell_type, char > postCell_traits
 Attribute traits type.
 
typedef ::neuroml2::NonNegativeInteger postSegment_type
 Attribute type.
 
typedef ::xsd::cxx::tree::traits< postSegment_type, char > postSegment_traits
 Attribute traits type.
 
typedef ::neuroml2::ZeroToOne postFractionAlong_type
 Attribute type.
 
typedef ::xsd::cxx::tree::traits< postFractionAlong_type, char > postFractionAlong_traits
 Attribute traits type.
 
- Public Types inherited from neuroml2::BaseConnection
typedef ::neuroml2::NeuroLexId neuroLexId_type
 Attribute type.
 
typedef ::xsd::cxx::tree::optional< neuroLexId_typeneuroLexId_optional
 Attribute optional container type.
 
typedef ::xsd::cxx::tree::traits< neuroLexId_type, char > neuroLexId_traits
 Attribute traits type.
 
- Public Types inherited from neuroml2::BaseNonNegativeIntegerId
typedef ::neuroml2::NonNegativeInteger id_type
 Attribute type.
 
typedef ::xsd::cxx::tree::traits< id_type, char > id_traits
 Attribute traits type.
 
- Public Member Functions inherited from neuroml2::BaseConnectionNewFormat
const preCell_typepreCell () const
 Return a read-only (constant) reference to the attribute. More...
 
preCell_typepreCell ()
 Return a read-write reference to the attribute. More...
 
void preCell (const preCell_type &x)
 Set the attribute value. More...
 
void preCell (::std::unique_ptr< preCell_type > p)
 Set the attribute value without copying. More...
 
const preSegment_typepreSegment () const
 Return a read-only (constant) reference to the attribute. More...
 
preSegment_typepreSegment ()
 Return a read-write reference to the attribute. More...
 
void preSegment (const preSegment_type &x)
 Set the attribute value. More...
 
void preSegment (::std::unique_ptr< preSegment_type > p)
 Set the attribute value without copying. More...
 
const preFractionAlong_typepreFractionAlong () const
 Return a read-only (constant) reference to the attribute. More...
 
preFractionAlong_typepreFractionAlong ()
 Return a read-write reference to the attribute. More...
 
void preFractionAlong (const preFractionAlong_type &x)
 Set the attribute value. More...
 
void preFractionAlong (::std::unique_ptr< preFractionAlong_type > p)
 Set the attribute value without copying. More...
 
const postCell_typepostCell () const
 Return a read-only (constant) reference to the attribute. More...
 
postCell_typepostCell ()
 Return a read-write reference to the attribute. More...
 
void postCell (const postCell_type &x)
 Set the attribute value. More...
 
void postCell (::std::unique_ptr< postCell_type > p)
 Set the attribute value without copying. More...
 
const postSegment_typepostSegment () const
 Return a read-only (constant) reference to the attribute. More...
 
postSegment_typepostSegment ()
 Return a read-write reference to the attribute. More...
 
void postSegment (const postSegment_type &x)
 Set the attribute value. More...
 
void postSegment (::std::unique_ptr< postSegment_type > p)
 Set the attribute value without copying. More...
 
const postFractionAlong_typepostFractionAlong () const
 Return a read-only (constant) reference to the attribute. More...
 
postFractionAlong_typepostFractionAlong ()
 Return a read-write reference to the attribute. More...
 
void postFractionAlong (const postFractionAlong_type &x)
 Set the attribute value. More...
 
void postFractionAlong (::std::unique_ptr< postFractionAlong_type > p)
 Set the attribute value without copying. More...
 
 BaseConnectionNewFormat (const id_type &, const preCell_type &, const postCell_type &)
 Create an instance from the ultimate base and initializers for required elements and attributes.
 
 BaseConnectionNewFormat (const ::xercesc::DOMElement &e, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Create an instance from a DOM element. More...
 
 BaseConnectionNewFormat (const BaseConnectionNewFormat &x, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Copy constructor. More...
 
BaseConnectionNewFormatoperator= (const BaseConnectionNewFormat &x)
 Copy assignment operator. More...
 
virtual ~BaseConnectionNewFormat ()
 Destructor.
 
- Public Member Functions inherited from neuroml2::BaseConnection
const neuroLexId_optionalneuroLexId () const
 Return a read-only (constant) reference to the attribute container. More...
 
neuroLexId_optionalneuroLexId ()
 Return a read-write reference to the attribute container. More...
 
void neuroLexId (const neuroLexId_type &x)
 Set the attribute value. More...
 
void neuroLexId (const neuroLexId_optional &x)
 Set the attribute value. More...
 
void neuroLexId (::std::unique_ptr< neuroLexId_type > p)
 Set the attribute value without copying. More...
 
 BaseConnection (const id_type &)
 Create an instance from the ultimate base and initializers for required elements and attributes.
 
 BaseConnection (const ::xercesc::DOMElement &e, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Create an instance from a DOM element. More...
 
 BaseConnection (const BaseConnection &x, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Copy constructor. More...
 
BaseConnectionoperator= (const BaseConnection &x)
 Copy assignment operator. More...
 
virtual ~BaseConnection ()
 Destructor.
 
- Public Member Functions inherited from neuroml2::BaseNonNegativeIntegerId
const id_typeid () const
 Return a read-only (constant) reference to the attribute. More...
 
id_typeid ()
 Return a read-write reference to the attribute. More...
 
void id (const id_type &x)
 Set the attribute value. More...
 
void id (::std::unique_ptr< id_type > p)
 Set the attribute value without copying. More...
 
 BaseNonNegativeIntegerId (const id_type &)
 Create an instance from the ultimate base and initializers for required elements and attributes.
 
 BaseNonNegativeIntegerId (const ::xercesc::DOMElement &e, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Create an instance from a DOM element. More...
 
 BaseNonNegativeIntegerId (const BaseNonNegativeIntegerId &x, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Copy constructor. More...
 
BaseNonNegativeIntegerIdoperator= (const BaseNonNegativeIntegerId &x)
 Copy assignment operator. More...
 
virtual ~BaseNonNegativeIntegerId ()
 Destructor.
 
- Public Member Functions inherited from neuroml2::BaseWithoutId
 BaseWithoutId ()
 Create an instance from the ultimate base and initializers for required elements and attributes.
 
 BaseWithoutId (const ::xercesc::DOMElement &e, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Create an instance from a DOM element. More...
 
 BaseWithoutId (const ::xercesc::DOMAttr &a, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Create an instance from a DOM attribute. More...
 
 BaseWithoutId (const ::std::string &s, const ::xercesc::DOMElement *e, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Create an instance from a string fragment. More...
 
 BaseWithoutId (const BaseWithoutId &x, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Copy constructor. More...
 
virtual ~BaseWithoutId ()
 Destructor.
 
- Static Public Member Functions inherited from neuroml2::BaseConnectionNewFormat
static preSegment_type preSegment_default_value ()
 Return the default value for the attribute. More...
 
static preFractionAlong_type preFractionAlong_default_value ()
 Return the default value for the attribute. More...
 
static postSegment_type postSegment_default_value ()
 Return the default value for the attribute. More...
 
static postFractionAlong_type postFractionAlong_default_value ()
 Return the default value for the attribute. More...
 

Detailed Description

Class corresponding to the ContinuousConnection schema type.

An instance of a connection in a continuousProjection between presynapticPopulation to another postsynapticPopulation through a preComponent at the start and postComponent at the end. Can be used for analog synapses.

Definition at line 64681 of file NeuroML_v2.3.hxx.

Constructor & Destructor Documentation

◆ ContinuousConnection() [1/2]

neuroml2::ContinuousConnection::ContinuousConnection ( const ::xercesc::DOMElement &  e,
::xml_schema::flags  f = 0,
::xml_schema::container c = 0 
)

Create an instance from a DOM element.

Parameters
eA DOM element to extract the data from.
fFlags to create the new instance with.
cA pointer to the object that will contain the new instance.

Definition at line 46666 of file NeuroML_v2.3.cxx.

◆ ContinuousConnection() [2/2]

neuroml2::ContinuousConnection::ContinuousConnection ( const ContinuousConnection x,
::xml_schema::flags  f = 0,
::xml_schema::container c = 0 
)

Copy constructor.

Parameters
xAn instance to make a copy of.
fFlags to create the copy with.
cA pointer to the object that will contain the copy.

For polymorphic object models use the _clone function instead.

Definition at line 46656 of file NeuroML_v2.3.cxx.

Member Function Documentation

◆ _clone()

ContinuousConnection * neuroml2::ContinuousConnection::_clone ( ::xml_schema::flags  f = 0,
::xml_schema::container c = 0 
) const
virtual

Copy the instance polymorphically.

Parameters
fFlags to create the copy with.
cA pointer to the object that will contain the copy.
Returns
A pointer to the dynamically allocated copy.

This function ensures that the dynamic type of the instance is used for copying and should be used for polymorphic object models instead of the copy constructor.

Reimplemented from neuroml2::BaseConnectionNewFormat.

Reimplemented in neuroml2::ContinuousConnectionInstanceW, and neuroml2::ContinuousConnectionInstance.

Definition at line 46723 of file NeuroML_v2.3.cxx.

◆ operator=()

ContinuousConnection & neuroml2::ContinuousConnection::operator= ( const ContinuousConnection x)

Copy assignment operator.

Parameters
xAn instance to make a copy of.
Returns
A reference to itself.

For polymorphic object models use the _clone function instead.

Definition at line 46730 of file NeuroML_v2.3.cxx.

◆ postComponent() [1/4]

ContinuousConnection::postComponent_type & neuroml2::ContinuousConnection::postComponent ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.

Definition at line 16203 of file NeuroML_v2.3.cxx.

◆ postComponent() [2/4]

const ContinuousConnection::postComponent_type & neuroml2::ContinuousConnection::postComponent ( ) const

Return a read-only (constant) reference to the attribute.

Returns
A constant reference to the attribute.

Definition at line 16197 of file NeuroML_v2.3.cxx.

◆ postComponent() [3/4]

void neuroml2::ContinuousConnection::postComponent ( ::std::unique_ptr< postComponent_type p)

Set the attribute value without copying.

Parameters
pA new value to use.

This function will try to use the passed value directly instead of making a copy.

Definition at line 16215 of file NeuroML_v2.3.cxx.

◆ postComponent() [4/4]

void neuroml2::ContinuousConnection::postComponent ( const postComponent_type x)

Set the attribute value.

Parameters
xA new value to set.

This function makes a copy of its argument and sets it as the new value of the attribute.

Definition at line 16209 of file NeuroML_v2.3.cxx.

◆ preComponent() [1/4]

ContinuousConnection::preComponent_type & neuroml2::ContinuousConnection::preComponent ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.

Definition at line 16179 of file NeuroML_v2.3.cxx.

◆ preComponent() [2/4]

const ContinuousConnection::preComponent_type & neuroml2::ContinuousConnection::preComponent ( ) const

Return a read-only (constant) reference to the attribute.

Returns
A constant reference to the attribute.

Definition at line 16173 of file NeuroML_v2.3.cxx.

◆ preComponent() [3/4]

void neuroml2::ContinuousConnection::preComponent ( ::std::unique_ptr< preComponent_type p)

Set the attribute value without copying.

Parameters
pA new value to use.

This function will try to use the passed value directly instead of making a copy.

Definition at line 16191 of file NeuroML_v2.3.cxx.

◆ preComponent() [4/4]

void neuroml2::ContinuousConnection::preComponent ( const preComponent_type x)

Set the attribute value.

Parameters
xA new value to set.

This function makes a copy of its argument and sets it as the new value of the attribute.

Definition at line 16185 of file NeuroML_v2.3.cxx.


The documentation for this class was generated from the following files: