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

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

#include <NeuroML_v2.3.hxx>

+ Inheritance diagram for neuroml2::ExtracellularProperties:
+ Collaboration diagram for neuroml2::ExtracellularProperties:

species

Accessor and modifier functions for the species sequence element.

typedef ::neuroml2::Species species_type
 Element type.
 
typedef ::xsd::cxx::tree::sequence< species_typespecies_sequence
 Element sequence container type.
 
typedef species_sequence::iterator species_iterator
 Element iterator type.
 
typedef species_sequence::const_iterator species_const_iterator
 Element constant iterator type.
 
typedef ::xsd::cxx::tree::traits< species_type, char > species_traits
 Element traits type.
 
const species_sequencespecies () const
 Return a read-only (constant) reference to the element sequence. More...
 
species_sequencespecies ()
 Return a read-write reference to the element sequence. More...
 
void species (const species_sequence &s)
 Copy elements from a given sequence. More...
 

Constructors

 ExtracellularProperties (const id_type &)
 Create an instance from the ultimate base and initializers for required elements and attributes.
 
 ExtracellularProperties (const ::xercesc::DOMElement &e, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Create an instance from a DOM element. More...
 
 ExtracellularProperties (const ExtracellularProperties &x, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Copy constructor. More...
 
virtual ExtracellularProperties_clone (::xml_schema::flags f=0, ::xml_schema::container *c=0) const
 Copy the instance polymorphically. More...
 
ExtracellularPropertiesoperator= (const ExtracellularProperties &x)
 Copy assignment operator. More...
 
virtual ~ExtracellularProperties ()
 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 ExtracellularProperties schema type.

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

Constructor & Destructor Documentation

◆ ExtracellularProperties() [1/2]

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

◆ ExtracellularProperties() [2/2]

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

Member Function Documentation

◆ _clone()

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

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

◆ operator=()

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

◆ species() [1/3]

ExtracellularProperties::species_sequence & neuroml2::ExtracellularProperties::species ( )

Return a read-write reference to the element sequence.

Returns
A reference to the sequence container.

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

◆ species() [2/3]

const ExtracellularProperties::species_sequence & neuroml2::ExtracellularProperties::species ( ) const

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

Returns
A constant reference to the sequence container.

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

◆ species() [3/3]

void neuroml2::ExtracellularProperties::species ( const species_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 12382 of file NeuroML_v2.3.cxx.


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