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

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

#include <NeuroML_v2.3.hxx>

+ Inheritance diagram for neuroml2::DoubleSynapse:
+ Collaboration diagram for neuroml2::DoubleSynapse:

synapse1

Accessor and modifier functions for the synapse1 required attribute.

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

synapse2

Accessor and modifier functions for the synapse2 required attribute.

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

synapse1Path

Accessor and modifier functions for the synapse1Path required attribute.

typedef ::xml_schema::string synapse1Path_type
 Attribute type.
 
typedef ::xsd::cxx::tree::traits< synapse1Path_type, char > synapse1Path_traits
 Attribute traits type.
 
const synapse1Path_typesynapse1Path () const
 Return a read-only (constant) reference to the attribute. More...
 
synapse1Path_typesynapse1Path ()
 Return a read-write reference to the attribute. More...
 
void synapse1Path (const synapse1Path_type &x)
 Set the attribute value. More...
 
void synapse1Path (::std::unique_ptr< synapse1Path_type > p)
 Set the attribute value without copying. More...
 

synapse2Path

Accessor and modifier functions for the synapse2Path required attribute.

typedef ::xml_schema::string synapse2Path_type
 Attribute type.
 
typedef ::xsd::cxx::tree::traits< synapse2Path_type, char > synapse2Path_traits
 Attribute traits type.
 
const synapse2Path_typesynapse2Path () const
 Return a read-only (constant) reference to the attribute. More...
 
synapse2Path_typesynapse2Path ()
 Return a read-write reference to the attribute. More...
 
void synapse2Path (const synapse2Path_type &x)
 Set the attribute value. More...
 
void synapse2Path (::std::unique_ptr< synapse2Path_type > p)
 Set the attribute value without copying. More...
 

Constructors

 DoubleSynapse (const id_type &, const synapse1_type &, const synapse2_type &, const synapse1Path_type &, const synapse2Path_type &)
 Create an instance from the ultimate base and initializers for required elements and attributes.
 
 DoubleSynapse (const ::xercesc::DOMElement &e, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Create an instance from a DOM element. More...
 
 DoubleSynapse (const DoubleSynapse &x, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Copy constructor. More...
 
virtual DoubleSynapse_clone (::xml_schema::flags f=0, ::xml_schema::container *c=0) const
 Copy the instance polymorphically. More...
 
DoubleSynapseoperator= (const DoubleSynapse &x)
 Copy assignment operator. More...
 
virtual ~DoubleSynapse ()
 Destructor.
 

Additional Inherited Members

- Public Types inherited from neuroml2::BaseSynapse
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::Standalone
typedef ::neuroml2::Notes notes_type
 Element type.
 
typedef ::xsd::cxx::tree::optional< notes_typenotes_optional
 Element optional container type.
 
typedef ::xsd::cxx::tree::traits< notes_type, char > notes_traits
 Element traits type.
 
typedef ::neuroml2::Property property_type
 Element type.
 
typedef ::xsd::cxx::tree::sequence< property_typeproperty_sequence
 Element sequence container type.
 
typedef property_sequence::iterator property_iterator
 Element iterator type.
 
typedef property_sequence::const_iterator property_const_iterator
 Element constant iterator type.
 
typedef ::xsd::cxx::tree::traits< property_type, char > property_traits
 Element traits type.
 
typedef ::neuroml2::Annotation annotation_type
 Element type.
 
typedef ::xsd::cxx::tree::optional< annotation_typeannotation_optional
 Element optional container type.
 
typedef ::xsd::cxx::tree::traits< annotation_type, char > annotation_traits
 Element traits type.
 
typedef ::neuroml2::MetaId metaid_type
 Attribute type.
 
typedef ::xsd::cxx::tree::optional< metaid_typemetaid_optional
 Attribute optional container type.
 
typedef ::xsd::cxx::tree::traits< metaid_type, char > metaid_traits
 Attribute traits type.
 
- Public Types inherited from neuroml2::Base
typedef ::neuroml2::NmlId id_type
 Attribute type.
 
typedef ::xsd::cxx::tree::traits< id_type, char > id_traits
 Attribute traits type.
 
- Public Member Functions inherited from neuroml2::BaseVoltageDepSynapse
 BaseVoltageDepSynapse (const id_type &)
 Create an instance from the ultimate base and initializers for required elements and attributes.
 
 BaseVoltageDepSynapse (const ::xercesc::DOMElement &e, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Create an instance from a DOM element. More...
 
 BaseVoltageDepSynapse (const BaseVoltageDepSynapse &x, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Copy constructor. More...
 
virtual ~BaseVoltageDepSynapse ()
 Destructor.
 
- Public Member Functions inherited from neuroml2::BaseSynapse
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...
 
 BaseSynapse (const id_type &)
 Create an instance from the ultimate base and initializers for required elements and attributes.
 
 BaseSynapse (const ::xercesc::DOMElement &e, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Create an instance from a DOM element. More...
 
 BaseSynapse (const BaseSynapse &x, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Copy constructor. More...
 
BaseSynapseoperator= (const BaseSynapse &x)
 Copy assignment operator. More...
 
virtual ~BaseSynapse ()
 Destructor.
 
- Public Member Functions inherited from neuroml2::Standalone
const notes_optionalnotes () const
 Return a read-only (constant) reference to the element container. More...
 
notes_optionalnotes ()
 Return a read-write reference to the element container. More...
 
void notes (const notes_type &x)
 Set the element value. More...
 
void notes (const notes_optional &x)
 Set the element value. More...
 
void notes (::std::unique_ptr< notes_type > p)
 Set the element value without copying. More...
 
const property_sequenceproperty () const
 Return a read-only (constant) reference to the element sequence. More...
 
property_sequenceproperty ()
 Return a read-write reference to the element sequence. More...
 
void property (const property_sequence &s)
 Copy elements from a given sequence. More...
 
const annotation_optionalannotation () const
 Return a read-only (constant) reference to the element container. More...
 
annotation_optionalannotation ()
 Return a read-write reference to the element container. More...
 
void annotation (const annotation_type &x)
 Set the element value. More...
 
void annotation (const annotation_optional &x)
 Set the element value. More...
 
void annotation (::std::unique_ptr< annotation_type > p)
 Set the element value without copying. More...
 
const metaid_optionalmetaid () const
 Return a read-only (constant) reference to the attribute container. More...
 
metaid_optionalmetaid ()
 Return a read-write reference to the attribute container. More...
 
void metaid (const metaid_type &x)
 Set the attribute value. More...
 
void metaid (const metaid_optional &x)
 Set the attribute value. More...
 
void metaid (::std::unique_ptr< metaid_type > p)
 Set the attribute value without copying. More...
 
 Standalone (const id_type &)
 Create an instance from the ultimate base and initializers for required elements and attributes.
 
 Standalone (const ::xercesc::DOMElement &e, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Create an instance from a DOM element. More...
 
 Standalone (const Standalone &x, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Copy constructor. More...
 
Standaloneoperator= (const Standalone &x)
 Copy assignment operator. More...
 
virtual ~Standalone ()
 Destructor.
 
- Public Member Functions inherited from neuroml2::Base
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...
 
 Base (const id_type &)
 Create an instance from the ultimate base and initializers for required elements and attributes.
 
 Base (const ::xercesc::DOMElement &e, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Create an instance from a DOM element. More...
 
 Base (const Base &x, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Copy constructor. More...
 
Baseoperator= (const Base &x)
 Copy assignment operator. More...
 
virtual ~Base ()
 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 DoubleSynapse schema type.

Synapse consisting of two independent synaptic mechanisms ( e. g. AMPA-R and NMDA-R ), which can be easily colocated in connections

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

Constructor & Destructor Documentation

◆ DoubleSynapse() [1/2]

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

◆ DoubleSynapse() [2/2]

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

Member Function Documentation

◆ _clone()

DoubleSynapse * neuroml2::DoubleSynapse::_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::BaseVoltageDepSynapse.

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

◆ operator=()

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

◆ synapse1() [1/4]

DoubleSynapse::synapse1_type & neuroml2::DoubleSynapse::synapse1 ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.

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

◆ synapse1() [2/4]

const DoubleSynapse::synapse1_type & neuroml2::DoubleSynapse::synapse1 ( ) const

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

Returns
A constant reference to the attribute.

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

◆ synapse1() [3/4]

void neuroml2::DoubleSynapse::synapse1 ( ::std::unique_ptr< synapse1_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 6823 of file NeuroML_v2.3.cxx.

◆ synapse1() [4/4]

void neuroml2::DoubleSynapse::synapse1 ( const synapse1_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 6817 of file NeuroML_v2.3.cxx.

◆ synapse1Path() [1/4]

DoubleSynapse::synapse1Path_type & neuroml2::DoubleSynapse::synapse1Path ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.

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

◆ synapse1Path() [2/4]

const DoubleSynapse::synapse1Path_type & neuroml2::DoubleSynapse::synapse1Path ( ) const

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

Returns
A constant reference to the attribute.

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

◆ synapse1Path() [3/4]

void neuroml2::DoubleSynapse::synapse1Path ( ::std::unique_ptr< synapse1Path_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 6871 of file NeuroML_v2.3.cxx.

◆ synapse1Path() [4/4]

void neuroml2::DoubleSynapse::synapse1Path ( const synapse1Path_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 6865 of file NeuroML_v2.3.cxx.

◆ synapse2() [1/4]

DoubleSynapse::synapse2_type & neuroml2::DoubleSynapse::synapse2 ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.

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

◆ synapse2() [2/4]

const DoubleSynapse::synapse2_type & neuroml2::DoubleSynapse::synapse2 ( ) const

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

Returns
A constant reference to the attribute.

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

◆ synapse2() [3/4]

void neuroml2::DoubleSynapse::synapse2 ( ::std::unique_ptr< synapse2_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 6847 of file NeuroML_v2.3.cxx.

◆ synapse2() [4/4]

void neuroml2::DoubleSynapse::synapse2 ( const synapse2_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 6841 of file NeuroML_v2.3.cxx.

◆ synapse2Path() [1/4]

DoubleSynapse::synapse2Path_type & neuroml2::DoubleSynapse::synapse2Path ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.

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

◆ synapse2Path() [2/4]

const DoubleSynapse::synapse2Path_type & neuroml2::DoubleSynapse::synapse2Path ( ) const

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

Returns
A constant reference to the attribute.

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

◆ synapse2Path() [3/4]

void neuroml2::DoubleSynapse::synapse2Path ( ::std::unique_ptr< synapse2Path_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 6895 of file NeuroML_v2.3.cxx.

◆ synapse2Path() [4/4]

void neuroml2::DoubleSynapse::synapse2Path ( const synapse2Path_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 6889 of file NeuroML_v2.3.cxx.


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