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

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

#include <NeuroML_v2.3.hxx>

+ Inheritance diagram for neuroml2::BaseConnectionOldFormat:
+ Collaboration diagram for neuroml2::BaseConnectionOldFormat:

preCellId

Accessor and modifier functions for the preCellId required attribute.

typedef ::neuroml2::Nml2PopulationReferencePath preCellId_type
 Attribute type.
 
typedef ::xsd::cxx::tree::traits< preCellId_type, char > preCellId_traits
 Attribute traits type.
 
const preCellId_typepreCellId () const
 Return a read-only (constant) reference to the attribute. More...
 
preCellId_typepreCellId ()
 Return a read-write reference to the attribute. More...
 
void preCellId (const preCellId_type &x)
 Set the attribute value. More...
 
void preCellId (::std::unique_ptr< preCellId_type > p)
 Set the attribute value without copying. More...
 

preSegmentId

Accessor and modifier functions for the preSegmentId optional attribute with a default value.

typedef ::neuroml2::NonNegativeInteger preSegmentId_type
 Attribute type.
 
typedef ::xsd::cxx::tree::traits< preSegmentId_type, char > preSegmentId_traits
 Attribute traits type.
 
const preSegmentId_typepreSegmentId () const
 Return a read-only (constant) reference to the attribute. More...
 
preSegmentId_typepreSegmentId ()
 Return a read-write reference to the attribute. More...
 
void preSegmentId (const preSegmentId_type &x)
 Set the attribute value. More...
 
void preSegmentId (::std::unique_ptr< preSegmentId_type > p)
 Set the attribute value without copying. More...
 
static preSegmentId_type preSegmentId_default_value ()
 Return the default value for the attribute. More...
 

preFractionAlong

Accessor and modifier functions for the preFractionAlong optional attribute with a default value.

typedef ::neuroml2::ZeroToOne preFractionAlong_type
 Attribute type.
 
typedef ::xsd::cxx::tree::traits< preFractionAlong_type, char > preFractionAlong_traits
 Attribute traits type.
 
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...
 
static preFractionAlong_type preFractionAlong_default_value ()
 Return the default value for the attribute. More...
 

postCellId

Accessor and modifier functions for the postCellId required attribute.

typedef ::neuroml2::Nml2PopulationReferencePath postCellId_type
 Attribute type.
 
typedef ::xsd::cxx::tree::traits< postCellId_type, char > postCellId_traits
 Attribute traits type.
 
const postCellId_typepostCellId () const
 Return a read-only (constant) reference to the attribute. More...
 
postCellId_typepostCellId ()
 Return a read-write reference to the attribute. More...
 
void postCellId (const postCellId_type &x)
 Set the attribute value. More...
 
void postCellId (::std::unique_ptr< postCellId_type > p)
 Set the attribute value without copying. More...
 

postSegmentId

Accessor and modifier functions for the postSegmentId optional attribute with a default value.

typedef ::neuroml2::NonNegativeInteger postSegmentId_type
 Attribute type.
 
typedef ::xsd::cxx::tree::traits< postSegmentId_type, char > postSegmentId_traits
 Attribute traits type.
 
const postSegmentId_typepostSegmentId () const
 Return a read-only (constant) reference to the attribute. More...
 
postSegmentId_typepostSegmentId ()
 Return a read-write reference to the attribute. More...
 
void postSegmentId (const postSegmentId_type &x)
 Set the attribute value. More...
 
void postSegmentId (::std::unique_ptr< postSegmentId_type > p)
 Set the attribute value without copying. More...
 
static postSegmentId_type postSegmentId_default_value ()
 Return the default value for the attribute. More...
 

postFractionAlong

Accessor and modifier functions for the postFractionAlong optional attribute with a default value.

typedef ::neuroml2::ZeroToOne postFractionAlong_type
 Attribute type.
 
typedef ::xsd::cxx::tree::traits< postFractionAlong_type, char > postFractionAlong_traits
 Attribute traits type.
 
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...
 
static postFractionAlong_type postFractionAlong_default_value ()
 Return the default value for the attribute. More...
 

Constructors

 BaseConnectionOldFormat (const id_type &, const preCellId_type &, const postCellId_type &)
 Create an instance from the ultimate base and initializers for required elements and attributes.
 
 BaseConnectionOldFormat (const ::xercesc::DOMElement &e, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Create an instance from a DOM element. More...
 
 BaseConnectionOldFormat (const BaseConnectionOldFormat &x, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Copy constructor. More...
 
virtual BaseConnectionOldFormat_clone (::xml_schema::flags f=0, ::xml_schema::container *c=0) const
 Copy the instance polymorphically. More...
 
BaseConnectionOldFormatoperator= (const BaseConnectionOldFormat &x)
 Copy assignment operator. More...
 
virtual ~BaseConnectionOldFormat ()
 Destructor.
 

Additional Inherited Members

- 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::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.
 

Detailed Description

Class corresponding to the BaseConnectionOldFormat schema type.

Base of all synaptic connections with preCellId, postSegmentId, etc. Note: this is not the best name for these attributes, since Id is superfluous, hence BaseConnectionNewFormat

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

Constructor & Destructor Documentation

◆ BaseConnectionOldFormat() [1/2]

neuroml2::BaseConnectionOldFormat::BaseConnectionOldFormat ( 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 45549 of file NeuroML_v2.3.cxx.

◆ BaseConnectionOldFormat() [2/2]

neuroml2::BaseConnectionOldFormat::BaseConnectionOldFormat ( const BaseConnectionOldFormat 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 45535 of file NeuroML_v2.3.cxx.

Member Function Documentation

◆ _clone()

BaseConnectionOldFormat * neuroml2::BaseConnectionOldFormat::_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::BaseConnection.

Reimplemented in neuroml2::Connection, neuroml2::ConnectionWD, and neuroml2::Connection_base.

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

◆ operator=()

BaseConnectionOldFormat & neuroml2::BaseConnectionOldFormat::operator= ( const BaseConnectionOldFormat 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 45661 of file NeuroML_v2.3.cxx.

◆ postCellId() [1/4]

BaseConnectionOldFormat::postCellId_type & neuroml2::BaseConnectionOldFormat::postCellId ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.

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

◆ postCellId() [2/4]

const BaseConnectionOldFormat::postCellId_type & neuroml2::BaseConnectionOldFormat::postCellId ( ) const

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

Returns
A constant reference to the attribute.

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

◆ postCellId() [3/4]

void neuroml2::BaseConnectionOldFormat::postCellId ( ::std::unique_ptr< postCellId_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 15711 of file NeuroML_v2.3.cxx.

◆ postCellId() [4/4]

void neuroml2::BaseConnectionOldFormat::postCellId ( const postCellId_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 15705 of file NeuroML_v2.3.cxx.

◆ postFractionAlong() [1/4]

BaseConnectionOldFormat::postFractionAlong_type & neuroml2::BaseConnectionOldFormat::postFractionAlong ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.

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

◆ postFractionAlong() [2/4]

const BaseConnectionOldFormat::postFractionAlong_type & neuroml2::BaseConnectionOldFormat::postFractionAlong ( ) const

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

Returns
A constant reference to the attribute.

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

◆ postFractionAlong() [3/4]

void neuroml2::BaseConnectionOldFormat::postFractionAlong ( ::std::unique_ptr< postFractionAlong_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 15765 of file NeuroML_v2.3.cxx.

◆ postFractionAlong() [4/4]

void neuroml2::BaseConnectionOldFormat::postFractionAlong ( const postFractionAlong_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 15759 of file NeuroML_v2.3.cxx.

◆ postFractionAlong_default_value()

BaseConnectionOldFormat::postFractionAlong_type neuroml2::BaseConnectionOldFormat::postFractionAlong_default_value ( )
static

Return the default value for the attribute.

Returns
The attribute's default value.

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

◆ postSegmentId() [1/4]

BaseConnectionOldFormat::postSegmentId_type & neuroml2::BaseConnectionOldFormat::postSegmentId ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.

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

◆ postSegmentId() [2/4]

const BaseConnectionOldFormat::postSegmentId_type & neuroml2::BaseConnectionOldFormat::postSegmentId ( ) const

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

Returns
A constant reference to the attribute.

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

◆ postSegmentId() [3/4]

void neuroml2::BaseConnectionOldFormat::postSegmentId ( ::std::unique_ptr< postSegmentId_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 15735 of file NeuroML_v2.3.cxx.

◆ postSegmentId() [4/4]

void neuroml2::BaseConnectionOldFormat::postSegmentId ( const postSegmentId_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 15729 of file NeuroML_v2.3.cxx.

◆ postSegmentId_default_value()

BaseConnectionOldFormat::postSegmentId_type neuroml2::BaseConnectionOldFormat::postSegmentId_default_value ( )
static

Return the default value for the attribute.

Returns
The attribute's default value.

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

◆ preCellId() [1/4]

BaseConnectionOldFormat::preCellId_type & neuroml2::BaseConnectionOldFormat::preCellId ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.

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

◆ preCellId() [2/4]

const BaseConnectionOldFormat::preCellId_type & neuroml2::BaseConnectionOldFormat::preCellId ( ) const

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

Returns
A constant reference to the attribute.

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

◆ preCellId() [3/4]

void neuroml2::BaseConnectionOldFormat::preCellId ( ::std::unique_ptr< preCellId_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 15627 of file NeuroML_v2.3.cxx.

◆ preCellId() [4/4]

void neuroml2::BaseConnectionOldFormat::preCellId ( const preCellId_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 15621 of file NeuroML_v2.3.cxx.

◆ preFractionAlong() [1/4]

BaseConnectionOldFormat::preFractionAlong_type & neuroml2::BaseConnectionOldFormat::preFractionAlong ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.

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

◆ preFractionAlong() [2/4]

const BaseConnectionOldFormat::preFractionAlong_type & neuroml2::BaseConnectionOldFormat::preFractionAlong ( ) const

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

Returns
A constant reference to the attribute.

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

◆ preFractionAlong() [3/4]

void neuroml2::BaseConnectionOldFormat::preFractionAlong ( ::std::unique_ptr< preFractionAlong_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 15681 of file NeuroML_v2.3.cxx.

◆ preFractionAlong() [4/4]

void neuroml2::BaseConnectionOldFormat::preFractionAlong ( const preFractionAlong_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 15675 of file NeuroML_v2.3.cxx.

◆ preFractionAlong_default_value()

BaseConnectionOldFormat::preFractionAlong_type neuroml2::BaseConnectionOldFormat::preFractionAlong_default_value ( )
static

Return the default value for the attribute.

Returns
The attribute's default value.

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

◆ preSegmentId() [1/4]

BaseConnectionOldFormat::preSegmentId_type & neuroml2::BaseConnectionOldFormat::preSegmentId ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.

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

◆ preSegmentId() [2/4]

const BaseConnectionOldFormat::preSegmentId_type & neuroml2::BaseConnectionOldFormat::preSegmentId ( ) const

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

Returns
A constant reference to the attribute.

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

◆ preSegmentId() [3/4]

void neuroml2::BaseConnectionOldFormat::preSegmentId ( ::std::unique_ptr< preSegmentId_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 15651 of file NeuroML_v2.3.cxx.

◆ preSegmentId() [4/4]

void neuroml2::BaseConnectionOldFormat::preSegmentId ( const preSegmentId_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 15645 of file NeuroML_v2.3.cxx.

◆ preSegmentId_default_value()

BaseConnectionOldFormat::preSegmentId_type neuroml2::BaseConnectionOldFormat::preSegmentId_default_value ( )
static

Return the default value for the attribute.

Returns
The attribute's default value.

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


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