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

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

#include <NeuroML_v2.3.hxx>

+ Inheritance diagram for neuroml2::IntracellularProperties:
+ Collaboration diagram for neuroml2::IntracellularProperties:

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...
 

resistivity

Accessor and modifier functions for the resistivity sequence element.

typedef ::neuroml2::Resistivity resistivity_type
 Element type.
 
typedef ::xsd::cxx::tree::sequence< resistivity_typeresistivity_sequence
 Element sequence container type.
 
typedef resistivity_sequence::iterator resistivity_iterator
 Element iterator type.
 
typedef resistivity_sequence::const_iterator resistivity_const_iterator
 Element constant iterator type.
 
typedef ::xsd::cxx::tree::traits< resistivity_type, char > resistivity_traits
 Element traits type.
 
const resistivity_sequenceresistivity () const
 Return a read-only (constant) reference to the element sequence. More...
 
resistivity_sequenceresistivity ()
 Return a read-write reference to the element sequence. More...
 
void resistivity (const resistivity_sequence &s)
 Copy elements from a given sequence. More...
 

Constructors

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

Additional Inherited Members

- 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 IntracellularProperties schema type.

Biophysical properties related to the intracellular space within the cell , such as the resistivity and the list of ionic species present. caConc and caConcExt are explicitly exposed here to facilitate accessing these values from other Components, even though caConcExt is clearly not an intracellular property

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

Constructor & Destructor Documentation

◆ IntracellularProperties() [1/2]

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

◆ IntracellularProperties() [2/2]

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

Member Function Documentation

◆ _clone()

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

Reimplemented in neuroml2::IntracellularProperties2CaPools.

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

◆ operator=()

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

◆ resistivity() [1/3]

IntracellularProperties::resistivity_sequence & neuroml2::IntracellularProperties::resistivity ( )

Return a read-write reference to the element sequence.

Returns
A reference to the sequence container.

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

◆ resistivity() [2/3]

const IntracellularProperties::resistivity_sequence & neuroml2::IntracellularProperties::resistivity ( ) const

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

Returns
A constant reference to the sequence container.

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

◆ resistivity() [3/3]

void neuroml2::IntracellularProperties::resistivity ( const resistivity_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 12356 of file NeuroML_v2.3.cxx.

◆ species() [1/3]

IntracellularProperties::species_sequence & neuroml2::IntracellularProperties::species ( )

Return a read-write reference to the element sequence.

Returns
A reference to the sequence container.

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

◆ species() [2/3]

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

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

Returns
A constant reference to the sequence container.

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

◆ species() [3/3]

void neuroml2::IntracellularProperties::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 12338 of file NeuroML_v2.3.cxx.


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