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

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

#include <NeuroML_v2.3.hxx>

+ Inheritance diagram for neuroml2::BaseProjection:
+ Collaboration diagram for neuroml2::BaseProjection:

presynapticPopulation

Accessor and modifier functions for the presynapticPopulation required attribute.

typedef ::neuroml2::NmlId presynapticPopulation_type
 Attribute type.
 
typedef ::xsd::cxx::tree::traits< presynapticPopulation_type, char > presynapticPopulation_traits
 Attribute traits type.
 
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...
 

postsynapticPopulation

Accessor and modifier functions for the postsynapticPopulation required attribute.

typedef ::neuroml2::NmlId postsynapticPopulation_type
 Attribute type.
 
typedef ::xsd::cxx::tree::traits< postsynapticPopulation_type, char > postsynapticPopulation_traits
 Attribute traits type.
 
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...
 

Constructors

 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...
 
virtual BaseProjection_clone (::xml_schema::flags f=0, ::xml_schema::container *c=0) const
 Copy the instance polymorphically. More...
 
BaseProjectionoperator= (const BaseProjection &x)
 Copy assignment operator. More...
 
virtual ~BaseProjection ()
 Destructor.
 

Additional Inherited Members

- 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::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 BaseProjection schema type.

Base for projection (set of synaptic connections) between two populations

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

Constructor & Destructor Documentation

◆ BaseProjection() [1/2]

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

◆ BaseProjection() [2/2]

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

Member Function Documentation

◆ _clone()

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

Reimplemented in neuroml2::ContinuousProjection, neuroml2::ElectricalProjection, and neuroml2::Projection.

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

◆ operator=()

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

◆ postsynapticPopulation() [1/4]

BaseProjection::postsynapticPopulation_type & neuroml2::BaseProjection::postsynapticPopulation ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.

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

◆ postsynapticPopulation() [2/4]

const BaseProjection::postsynapticPopulation_type & neuroml2::BaseProjection::postsynapticPopulation ( ) const

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

Returns
A constant reference to the attribute.

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

◆ postsynapticPopulation() [3/4]

void neuroml2::BaseProjection::postsynapticPopulation ( ::std::unique_ptr< postsynapticPopulation_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 15501 of file NeuroML_v2.3.cxx.

◆ postsynapticPopulation() [4/4]

void neuroml2::BaseProjection::postsynapticPopulation ( const postsynapticPopulation_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 15495 of file NeuroML_v2.3.cxx.

◆ presynapticPopulation() [1/4]

BaseProjection::presynapticPopulation_type & neuroml2::BaseProjection::presynapticPopulation ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.

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

◆ presynapticPopulation() [2/4]

const BaseProjection::presynapticPopulation_type & neuroml2::BaseProjection::presynapticPopulation ( ) const

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

Returns
A constant reference to the attribute.

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

◆ presynapticPopulation() [3/4]

void neuroml2::BaseProjection::presynapticPopulation ( ::std::unique_ptr< presynapticPopulation_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 15477 of file NeuroML_v2.3.cxx.

◆ presynapticPopulation() [4/4]

void neuroml2::BaseProjection::presynapticPopulation ( const presynapticPopulation_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 15471 of file NeuroML_v2.3.cxx.


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