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

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

#include <NeuroML_v2.3.hxx>

+ Inheritance diagram for neuroml2::BaseConnectionNewFormat:
+ Collaboration diagram for neuroml2::BaseConnectionNewFormat:

preCell

Accessor and modifier functions for the preCell required attribute.

typedef ::xml_schema::string preCell_type
 Attribute type.
 
typedef ::xsd::cxx::tree::traits< preCell_type, char > preCell_traits
 Attribute traits type.
 
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...
 

preSegment

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

typedef ::neuroml2::NonNegativeInteger preSegment_type
 Attribute type.
 
typedef ::xsd::cxx::tree::traits< preSegment_type, char > preSegment_traits
 Attribute traits type.
 
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...
 
static preSegment_type preSegment_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...
 

postCell

Accessor and modifier functions for the postCell required attribute.

typedef ::xml_schema::string postCell_type
 Attribute type.
 
typedef ::xsd::cxx::tree::traits< postCell_type, char > postCell_traits
 Attribute traits type.
 
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...
 

postSegment

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

typedef ::neuroml2::NonNegativeInteger postSegment_type
 Attribute type.
 
typedef ::xsd::cxx::tree::traits< postSegment_type, char > postSegment_traits
 Attribute traits type.
 
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...
 
static postSegment_type postSegment_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

 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...
 
virtual BaseConnectionNewFormat_clone (::xml_schema::flags f=0, ::xml_schema::container *c=0) const
 Copy the instance polymorphically. More...
 
BaseConnectionNewFormatoperator= (const BaseConnectionNewFormat &x)
 Copy assignment operator. More...
 
virtual ~BaseConnectionNewFormat ()
 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 BaseConnectionNewFormat schema type.

Base of all synaptic connections with preCell, postSegment, etc. See BaseConnectionOldFormat

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

Constructor & Destructor Documentation

◆ BaseConnectionNewFormat() [1/2]

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

◆ BaseConnectionNewFormat() [2/2]

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

Member Function Documentation

◆ _clone()

BaseConnectionNewFormat * neuroml2::BaseConnectionNewFormat::_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::ContinuousConnectionInstanceW, neuroml2::ContinuousConnectionInstance, neuroml2::ContinuousConnection, neuroml2::ElectricalConnectionInstanceW, neuroml2::ElectricalConnectionInstance, and neuroml2::ElectricalConnection.

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

◆ operator=()

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

◆ postCell() [1/4]

BaseConnectionNewFormat::postCell_type & neuroml2::BaseConnectionNewFormat::postCell ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.

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

◆ postCell() [2/4]

const BaseConnectionNewFormat::postCell_type & neuroml2::BaseConnectionNewFormat::postCell ( ) const

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

Returns
A constant reference to the attribute.

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

◆ postCell() [3/4]

void neuroml2::BaseConnectionNewFormat::postCell ( ::std::unique_ptr< postCell_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 15883 of file NeuroML_v2.3.cxx.

◆ postCell() [4/4]

void neuroml2::BaseConnectionNewFormat::postCell ( const postCell_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 15877 of file NeuroML_v2.3.cxx.

◆ postFractionAlong() [1/4]

BaseConnectionNewFormat::postFractionAlong_type & neuroml2::BaseConnectionNewFormat::postFractionAlong ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.

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

◆ postFractionAlong() [2/4]

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

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

Returns
A constant reference to the attribute.

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

◆ postFractionAlong() [3/4]

void neuroml2::BaseConnectionNewFormat::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 15937 of file NeuroML_v2.3.cxx.

◆ postFractionAlong() [4/4]

void neuroml2::BaseConnectionNewFormat::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 15931 of file NeuroML_v2.3.cxx.

◆ postFractionAlong_default_value()

BaseConnectionNewFormat::postFractionAlong_type neuroml2::BaseConnectionNewFormat::postFractionAlong_default_value ( )
static

Return the default value for the attribute.

Returns
The attribute's default value.

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

◆ postSegment() [1/4]

BaseConnectionNewFormat::postSegment_type & neuroml2::BaseConnectionNewFormat::postSegment ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.

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

◆ postSegment() [2/4]

const BaseConnectionNewFormat::postSegment_type & neuroml2::BaseConnectionNewFormat::postSegment ( ) const

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

Returns
A constant reference to the attribute.

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

◆ postSegment() [3/4]

void neuroml2::BaseConnectionNewFormat::postSegment ( ::std::unique_ptr< postSegment_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 15907 of file NeuroML_v2.3.cxx.

◆ postSegment() [4/4]

void neuroml2::BaseConnectionNewFormat::postSegment ( const postSegment_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 15901 of file NeuroML_v2.3.cxx.

◆ postSegment_default_value()

BaseConnectionNewFormat::postSegment_type neuroml2::BaseConnectionNewFormat::postSegment_default_value ( )
static

Return the default value for the attribute.

Returns
The attribute's default value.

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

◆ preCell() [1/4]

BaseConnectionNewFormat::preCell_type & neuroml2::BaseConnectionNewFormat::preCell ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.

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

◆ preCell() [2/4]

const BaseConnectionNewFormat::preCell_type & neuroml2::BaseConnectionNewFormat::preCell ( ) const

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

Returns
A constant reference to the attribute.

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

◆ preCell() [3/4]

void neuroml2::BaseConnectionNewFormat::preCell ( ::std::unique_ptr< preCell_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 15799 of file NeuroML_v2.3.cxx.

◆ preCell() [4/4]

void neuroml2::BaseConnectionNewFormat::preCell ( const preCell_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 15793 of file NeuroML_v2.3.cxx.

◆ preFractionAlong() [1/4]

BaseConnectionNewFormat::preFractionAlong_type & neuroml2::BaseConnectionNewFormat::preFractionAlong ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.

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

◆ preFractionAlong() [2/4]

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

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

Returns
A constant reference to the attribute.

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

◆ preFractionAlong() [3/4]

void neuroml2::BaseConnectionNewFormat::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 15853 of file NeuroML_v2.3.cxx.

◆ preFractionAlong() [4/4]

void neuroml2::BaseConnectionNewFormat::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 15847 of file NeuroML_v2.3.cxx.

◆ preFractionAlong_default_value()

BaseConnectionNewFormat::preFractionAlong_type neuroml2::BaseConnectionNewFormat::preFractionAlong_default_value ( )
static

Return the default value for the attribute.

Returns
The attribute's default value.

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

◆ preSegment() [1/4]

BaseConnectionNewFormat::preSegment_type & neuroml2::BaseConnectionNewFormat::preSegment ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.

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

◆ preSegment() [2/4]

const BaseConnectionNewFormat::preSegment_type & neuroml2::BaseConnectionNewFormat::preSegment ( ) const

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

Returns
A constant reference to the attribute.

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

◆ preSegment() [3/4]

void neuroml2::BaseConnectionNewFormat::preSegment ( ::std::unique_ptr< preSegment_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 15823 of file NeuroML_v2.3.cxx.

◆ preSegment() [4/4]

void neuroml2::BaseConnectionNewFormat::preSegment ( const preSegment_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 15817 of file NeuroML_v2.3.cxx.

◆ preSegment_default_value()

BaseConnectionNewFormat::preSegment_type neuroml2::BaseConnectionNewFormat::preSegment_default_value ( )
static

Return the default value for the attribute.

Returns
The attribute's default value.

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


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