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

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

#include <NeuroML_v2.3.hxx>

+ Inheritance diagram for neuroml2::ConnectionWD:
+ Collaboration diagram for neuroml2::ConnectionWD:

weight

Accessor and modifier functions for the weight required attribute.

typedef ::xml_schema::float_ weight_type
 Attribute type.
 
typedef ::xsd::cxx::tree::traits< weight_type, char > weight_traits
 Attribute traits type.
 
const weight_typeweight () const
 Return a read-only (constant) reference to the attribute. More...
 
weight_typeweight ()
 Return a read-write reference to the attribute. More...
 
void weight (const weight_type &x)
 Set the attribute value. More...
 

delay

Accessor and modifier functions for the delay required attribute.

typedef ::neuroml2::Nml2Quantity_time delay_type
 Attribute type.
 
typedef ::xsd::cxx::tree::traits< delay_type, char > delay_traits
 Attribute traits type.
 
const delay_typedelay () const
 Return a read-only (constant) reference to the attribute. More...
 
delay_typedelay ()
 Return a read-write reference to the attribute. More...
 
void delay (const delay_type &x)
 Set the attribute value. More...
 
void delay (::std::unique_ptr< delay_type > p)
 Set the attribute value without copying. More...
 

Constructors

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

Additional Inherited Members

- Public Types inherited from neuroml2::BaseConnectionOldFormat
typedef ::neuroml2::Nml2PopulationReferencePath preCellId_type
 Attribute type.
 
typedef ::xsd::cxx::tree::traits< preCellId_type, char > preCellId_traits
 Attribute traits type.
 
typedef ::neuroml2::NonNegativeInteger preSegmentId_type
 Attribute type.
 
typedef ::xsd::cxx::tree::traits< preSegmentId_type, char > preSegmentId_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 ::neuroml2::Nml2PopulationReferencePath postCellId_type
 Attribute type.
 
typedef ::xsd::cxx::tree::traits< postCellId_type, char > postCellId_traits
 Attribute traits type.
 
typedef ::neuroml2::NonNegativeInteger postSegmentId_type
 Attribute type.
 
typedef ::xsd::cxx::tree::traits< postSegmentId_type, char > postSegmentId_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::BaseConnectionOldFormat
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...
 
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...
 
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 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...
 
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...
 
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...
 
 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...
 
BaseConnectionOldFormatoperator= (const BaseConnectionOldFormat &x)
 Copy assignment operator. More...
 
virtual ~BaseConnectionOldFormat ()
 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::BaseConnectionOldFormat
static preSegmentId_type preSegmentId_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 postSegmentId_type postSegmentId_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 ConnectionWD schema type.

Event connection between named components, which gets processed via a new instance of a synapse component which is created on the target component, includes setting of weight and delay for the synaptic connection
:param weight: :type weight: none :param delay: :type delay: time

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

Constructor & Destructor Documentation

◆ ConnectionWD() [1/2]

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

◆ ConnectionWD() [2/2]

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

Member Function Documentation

◆ _clone()

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

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

◆ delay() [1/4]

ConnectionWD::delay_type & neuroml2::ConnectionWD::delay ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.

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

◆ delay() [2/4]

const ConnectionWD::delay_type & neuroml2::ConnectionWD::delay ( ) const

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

Returns
A constant reference to the attribute.

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

◆ delay() [3/4]

void neuroml2::ConnectionWD::delay ( ::std::unique_ptr< delay_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 15993 of file NeuroML_v2.3.cxx.

◆ delay() [4/4]

void neuroml2::ConnectionWD::delay ( const delay_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 15987 of file NeuroML_v2.3.cxx.

◆ operator=()

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

◆ weight() [1/3]

ConnectionWD::weight_type & neuroml2::ConnectionWD::weight ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.

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

◆ weight() [2/3]

const ConnectionWD::weight_type & neuroml2::ConnectionWD::weight ( ) const

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

Returns
A constant reference to the attribute.

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

◆ weight() [3/3]

void neuroml2::ConnectionWD::weight ( const weight_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 15969 of file NeuroML_v2.3.cxx.


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