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

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

#include <NeuroML_v2.3.hxx>

+ Inheritance diagram for neuroml2::ElectricalProjection:
+ Collaboration diagram for neuroml2::ElectricalProjection:

electricalConnection

Accessor and modifier functions for the electricalConnection sequence element.

typedef ::neuroml2::ElectricalConnection electricalConnection_type
 Element type.
 
typedef ::xsd::cxx::tree::sequence< electricalConnection_typeelectricalConnection_sequence
 Element sequence container type.
 
typedef electricalConnection_sequence::iterator electricalConnection_iterator
 Element iterator type.
 
typedef electricalConnection_sequence::const_iterator electricalConnection_const_iterator
 Element constant iterator type.
 
typedef ::xsd::cxx::tree::traits< electricalConnection_type, char > electricalConnection_traits
 Element traits type.
 
const electricalConnection_sequenceelectricalConnection () const
 Return a read-only (constant) reference to the element sequence. More...
 
electricalConnection_sequenceelectricalConnection ()
 Return a read-write reference to the element sequence. More...
 
void electricalConnection (const electricalConnection_sequence &s)
 Copy elements from a given sequence. More...
 

electricalConnectionInstance

Accessor and modifier functions for the electricalConnectionInstance sequence element.

typedef ::neuroml2::ElectricalConnectionInstance electricalConnectionInstance_type
 Element type.
 
typedef ::xsd::cxx::tree::sequence< electricalConnectionInstance_typeelectricalConnectionInstance_sequence
 Element sequence container type.
 
typedef electricalConnectionInstance_sequence::iterator electricalConnectionInstance_iterator
 Element iterator type.
 
typedef electricalConnectionInstance_sequence::const_iterator electricalConnectionInstance_const_iterator
 Element constant iterator type.
 
typedef ::xsd::cxx::tree::traits< electricalConnectionInstance_type, char > electricalConnectionInstance_traits
 Element traits type.
 
const electricalConnectionInstance_sequenceelectricalConnectionInstance () const
 Return a read-only (constant) reference to the element sequence. More...
 
electricalConnectionInstance_sequenceelectricalConnectionInstance ()
 Return a read-write reference to the element sequence. More...
 
void electricalConnectionInstance (const electricalConnectionInstance_sequence &s)
 Copy elements from a given sequence. More...
 

electricalConnectionInstanceW

Accessor and modifier functions for the electricalConnectionInstanceW sequence element.

typedef ::neuroml2::ElectricalConnectionInstanceW electricalConnectionInstanceW_type
 Element type.
 
typedef ::xsd::cxx::tree::sequence< electricalConnectionInstanceW_typeelectricalConnectionInstanceW_sequence
 Element sequence container type.
 
typedef electricalConnectionInstanceW_sequence::iterator electricalConnectionInstanceW_iterator
 Element iterator type.
 
typedef electricalConnectionInstanceW_sequence::const_iterator electricalConnectionInstanceW_const_iterator
 Element constant iterator type.
 
typedef ::xsd::cxx::tree::traits< electricalConnectionInstanceW_type, char > electricalConnectionInstanceW_traits
 Element traits type.
 
const electricalConnectionInstanceW_sequenceelectricalConnectionInstanceW () const
 Return a read-only (constant) reference to the element sequence. More...
 
electricalConnectionInstanceW_sequenceelectricalConnectionInstanceW ()
 Return a read-write reference to the element sequence. More...
 
void electricalConnectionInstanceW (const electricalConnectionInstanceW_sequence &s)
 Copy elements from a given sequence. More...
 

Constructors

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

Additional Inherited Members

- Public Types inherited from neuroml2::BaseProjection
typedef ::neuroml2::NmlId presynapticPopulation_type
 Attribute type.
 
typedef ::xsd::cxx::tree::traits< presynapticPopulation_type, char > presynapticPopulation_traits
 Attribute traits type.
 
typedef ::neuroml2::NmlId postsynapticPopulation_type
 Attribute type.
 
typedef ::xsd::cxx::tree::traits< postsynapticPopulation_type, char > postsynapticPopulation_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::BaseProjection
const presynapticPopulation_typepresynapticPopulation () const
 Return a read-only (constant) reference to the attribute. More...
 
presynapticPopulation_typepresynapticPopulation ()
 Return a read-write reference to the attribute. More...
 
void presynapticPopulation (const presynapticPopulation_type &x)
 Set the attribute value. More...
 
void presynapticPopulation (::std::unique_ptr< presynapticPopulation_type > p)
 Set the attribute value without copying. More...
 
const postsynapticPopulation_typepostsynapticPopulation () const
 Return a read-only (constant) reference to the attribute. More...
 
postsynapticPopulation_typepostsynapticPopulation ()
 Return a read-write reference to the attribute. More...
 
void postsynapticPopulation (const postsynapticPopulation_type &x)
 Set the attribute value. More...
 
void postsynapticPopulation (::std::unique_ptr< postsynapticPopulation_type > p)
 Set the attribute value without copying. More...
 
 BaseProjection (const id_type &, const presynapticPopulation_type &, const postsynapticPopulation_type &)
 Create an instance from the ultimate base and initializers for required elements and attributes.
 
 BaseProjection (const ::xercesc::DOMElement &e, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Create an instance from a DOM element. More...
 
 BaseProjection (const BaseProjection &x, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Copy constructor. More...
 
BaseProjectionoperator= (const BaseProjection &x)
 Copy assignment operator. More...
 
virtual ~BaseProjection ()
 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 ElectricalProjection schema type.

A projection between presynapticPopulation to another postsynapticPopulation through gap junctions.

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

Constructor & Destructor Documentation

◆ ElectricalProjection() [1/2]

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

◆ ElectricalProjection() [2/2]

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

Member Function Documentation

◆ _clone()

ElectricalProjection * neuroml2::ElectricalProjection::_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::BaseProjection.

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

◆ electricalConnection() [1/3]

ElectricalProjection::electricalConnection_sequence & neuroml2::ElectricalProjection::electricalConnection ( )

Return a read-write reference to the element sequence.

Returns
A reference to the sequence container.

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

◆ electricalConnection() [2/3]

const ElectricalProjection::electricalConnection_sequence & neuroml2::ElectricalProjection::electricalConnection ( ) const

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

Returns
A constant reference to the sequence container.

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

◆ electricalConnection() [3/3]

void neuroml2::ElectricalProjection::electricalConnection ( const electricalConnection_sequence s)

Copy elements from a given sequence.

Parameters
sA sequence to copy elements from.

For each element in s this function makes a copy and adds it to the sequence. Note that this operation completely changes the sequence and all old elements will be lost.

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

◆ electricalConnectionInstance() [1/3]

ElectricalProjection::electricalConnectionInstance_sequence & neuroml2::ElectricalProjection::electricalConnectionInstance ( )

Return a read-write reference to the element sequence.

Returns
A reference to the sequence container.

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

◆ electricalConnectionInstance() [2/3]

const ElectricalProjection::electricalConnectionInstance_sequence & neuroml2::ElectricalProjection::electricalConnectionInstance ( ) const

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

Returns
A constant reference to the sequence container.

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

◆ electricalConnectionInstance() [3/3]

void neuroml2::ElectricalProjection::electricalConnectionInstance ( const electricalConnectionInstance_sequence s)

Copy elements from a given sequence.

Parameters
sA sequence to copy elements from.

For each element in s this function makes a copy and adds it to the sequence. Note that this operation completely changes the sequence and all old elements will be lost.

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

◆ electricalConnectionInstanceW() [1/3]

ElectricalProjection::electricalConnectionInstanceW_sequence & neuroml2::ElectricalProjection::electricalConnectionInstanceW ( )

Return a read-write reference to the element sequence.

Returns
A reference to the sequence container.

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

◆ electricalConnectionInstanceW() [2/3]

const ElectricalProjection::electricalConnectionInstanceW_sequence & neuroml2::ElectricalProjection::electricalConnectionInstanceW ( ) const

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

Returns
A constant reference to the sequence container.

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

◆ electricalConnectionInstanceW() [3/3]

void neuroml2::ElectricalProjection::electricalConnectionInstanceW ( const electricalConnectionInstanceW_sequence s)

Copy elements from a given sequence.

Parameters
sA sequence to copy elements from.

For each element in s this function makes a copy and adds it to the sequence. Note that this operation completely changes the sequence and all old elements will be lost.

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

◆ operator=()

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


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