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

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

#include <NeuroML_v2.3.hxx>

+ Inheritance diagram for neuroml2::BiophysicalProperties2CaPools:
+ Collaboration diagram for neuroml2::BiophysicalProperties2CaPools:

membraneProperties2CaPools

Accessor and modifier functions for the membraneProperties2CaPools required element.

typedef ::neuroml2::MembraneProperties2CaPools membraneProperties2CaPools_type
 Element type.
 
typedef ::xsd::cxx::tree::traits< membraneProperties2CaPools_type, char > membraneProperties2CaPools_traits
 Element traits type.
 
const membraneProperties2CaPools_typemembraneProperties2CaPools () const
 Return a read-only (constant) reference to the element. More...
 
membraneProperties2CaPools_typemembraneProperties2CaPools ()
 Return a read-write reference to the element. More...
 
void membraneProperties2CaPools (const membraneProperties2CaPools_type &x)
 Set the element value. More...
 
void membraneProperties2CaPools (::std::unique_ptr< membraneProperties2CaPools_type > p)
 Set the element value without copying. More...
 

intracellularProperties2CaPools

Accessor and modifier functions for the intracellularProperties2CaPools optional element.

typedef ::neuroml2::IntracellularProperties2CaPools intracellularProperties2CaPools_type
 Element type.
 
typedef ::xsd::cxx::tree::optional< intracellularProperties2CaPools_typeintracellularProperties2CaPools_optional
 Element optional container type.
 
typedef ::xsd::cxx::tree::traits< intracellularProperties2CaPools_type, char > intracellularProperties2CaPools_traits
 Element traits type.
 
const intracellularProperties2CaPools_optionalintracellularProperties2CaPools () const
 Return a read-only (constant) reference to the element container. More...
 
intracellularProperties2CaPools_optionalintracellularProperties2CaPools ()
 Return a read-write reference to the element container. More...
 
void intracellularProperties2CaPools (const intracellularProperties2CaPools_type &x)
 Set the element value. More...
 
void intracellularProperties2CaPools (const intracellularProperties2CaPools_optional &x)
 Set the element value. More...
 
void intracellularProperties2CaPools (::std::unique_ptr< intracellularProperties2CaPools_type > p)
 Set the element value without copying. More...
 

extracellularProperties

Accessor and modifier functions for the extracellularProperties optional element.

typedef ::neuroml2::ExtracellularProperties extracellularProperties_type
 Element type.
 
typedef ::xsd::cxx::tree::optional< extracellularProperties_typeextracellularProperties_optional
 Element optional container type.
 
typedef ::xsd::cxx::tree::traits< extracellularProperties_type, char > extracellularProperties_traits
 Element traits type.
 
const extracellularProperties_optionalextracellularProperties () const
 Return a read-only (constant) reference to the element container. More...
 
extracellularProperties_optionalextracellularProperties ()
 Return a read-write reference to the element container. More...
 
void extracellularProperties (const extracellularProperties_type &x)
 Set the element value. More...
 
void extracellularProperties (const extracellularProperties_optional &x)
 Set the element value. More...
 
void extracellularProperties (::std::unique_ptr< extracellularProperties_type > p)
 Set the element value without copying. More...
 

Constructors

 BiophysicalProperties2CaPools (const id_type &, const membraneProperties2CaPools_type &)
 Create an instance from the ultimate base and initializers for required elements and attributes.
 
 BiophysicalProperties2CaPools (const id_type &, ::std::unique_ptr< membraneProperties2CaPools_type >)
 Create an instance from the ultimate base and initializers for required elements and attributes (::std::unique_ptr version). More...
 
 BiophysicalProperties2CaPools (const ::xercesc::DOMElement &e, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Create an instance from a DOM element. More...
 
 BiophysicalProperties2CaPools (const BiophysicalProperties2CaPools &x, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Copy constructor. More...
 
virtual BiophysicalProperties2CaPools_clone (::xml_schema::flags f=0, ::xml_schema::container *c=0) const
 Copy the instance polymorphically. More...
 
BiophysicalProperties2CaPoolsoperator= (const BiophysicalProperties2CaPools &x)
 Copy assignment operator. More...
 
virtual ~BiophysicalProperties2CaPools ()
 Destructor.
 

Additional Inherited Members

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

The biophysical properties of the cell , including the membraneProperties2CaPools and the intracellularProperties2CaPools for a cell with two Ca pools

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

Constructor & Destructor Documentation

◆ BiophysicalProperties2CaPools() [1/3]

neuroml2::BiophysicalProperties2CaPools::BiophysicalProperties2CaPools ( const id_type id,
::std::unique_ptr< membraneProperties2CaPools_type membraneProperties2CaPools 
)

Create an instance from the ultimate base and initializers for required elements and attributes (::std::unique_ptr version).

This constructor will try to use the passed values directly instead of making copies.

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

◆ BiophysicalProperties2CaPools() [2/3]

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

◆ BiophysicalProperties2CaPools() [3/3]

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

Member Function Documentation

◆ _clone()

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

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

◆ extracellularProperties() [1/5]

BiophysicalProperties2CaPools::extracellularProperties_optional & neuroml2::BiophysicalProperties2CaPools::extracellularProperties ( )

Return a read-write reference to the element container.

Returns
A reference to the optional container.

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

◆ extracellularProperties() [2/5]

const BiophysicalProperties2CaPools::extracellularProperties_optional & neuroml2::BiophysicalProperties2CaPools::extracellularProperties ( ) const

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

Returns
A constant reference to the optional container.

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

◆ extracellularProperties() [3/5]

void neuroml2::BiophysicalProperties2CaPools::extracellularProperties ( ::std::unique_ptr< extracellularProperties_type p)

Set the element 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 10490 of file NeuroML_v2.3.cxx.

◆ extracellularProperties() [4/5]

void neuroml2::BiophysicalProperties2CaPools::extracellularProperties ( const extracellularProperties_optional x)

Set the element value.

Parameters
xAn optional container with the new value to set.

If the value is present in x then this function makes a copy of this value and sets it as the new value of the element. Otherwise the element container is set the 'not present' state.

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

◆ extracellularProperties() [5/5]

void neuroml2::BiophysicalProperties2CaPools::extracellularProperties ( const extracellularProperties_type x)

Set the element value.

Parameters
xA new value to set.

This function makes a copy of its argument and sets it as the new value of the element.

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

◆ intracellularProperties2CaPools() [1/5]

BiophysicalProperties2CaPools::intracellularProperties2CaPools_optional & neuroml2::BiophysicalProperties2CaPools::intracellularProperties2CaPools ( )

Return a read-write reference to the element container.

Returns
A reference to the optional container.

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

◆ intracellularProperties2CaPools() [2/5]

const BiophysicalProperties2CaPools::intracellularProperties2CaPools_optional & neuroml2::BiophysicalProperties2CaPools::intracellularProperties2CaPools ( ) const

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

Returns
A constant reference to the optional container.

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

◆ intracellularProperties2CaPools() [3/5]

void neuroml2::BiophysicalProperties2CaPools::intracellularProperties2CaPools ( ::std::unique_ptr< intracellularProperties2CaPools_type p)

Set the element 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 10460 of file NeuroML_v2.3.cxx.

◆ intracellularProperties2CaPools() [4/5]

void neuroml2::BiophysicalProperties2CaPools::intracellularProperties2CaPools ( const intracellularProperties2CaPools_optional x)

Set the element value.

Parameters
xAn optional container with the new value to set.

If the value is present in x then this function makes a copy of this value and sets it as the new value of the element. Otherwise the element container is set the 'not present' state.

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

◆ intracellularProperties2CaPools() [5/5]

void neuroml2::BiophysicalProperties2CaPools::intracellularProperties2CaPools ( const intracellularProperties2CaPools_type x)

Set the element value.

Parameters
xA new value to set.

This function makes a copy of its argument and sets it as the new value of the element.

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

◆ membraneProperties2CaPools() [1/4]

BiophysicalProperties2CaPools::membraneProperties2CaPools_type & neuroml2::BiophysicalProperties2CaPools::membraneProperties2CaPools ( )

Return a read-write reference to the element.

Returns
A reference to the element.

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

◆ membraneProperties2CaPools() [2/4]

const BiophysicalProperties2CaPools::membraneProperties2CaPools_type & neuroml2::BiophysicalProperties2CaPools::membraneProperties2CaPools ( ) const

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

Returns
A constant reference to the element.

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

◆ membraneProperties2CaPools() [3/4]

void neuroml2::BiophysicalProperties2CaPools::membraneProperties2CaPools ( ::std::unique_ptr< membraneProperties2CaPools_type p)

Set the element 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 10430 of file NeuroML_v2.3.cxx.

◆ membraneProperties2CaPools() [4/4]

void neuroml2::BiophysicalProperties2CaPools::membraneProperties2CaPools ( const membraneProperties2CaPools_type x)

Set the element value.

Parameters
xA new value to set.

This function makes a copy of its argument and sets it as the new value of the element.

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

◆ operator=()

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


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