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

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

#include <NeuroML_v2.3.hxx>

+ Inheritance diagram for neuroml2::ChannelDensityNernstCa2:
+ Collaboration diagram for neuroml2::ChannelDensityNernstCa2:

Constructors

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

Additional Inherited Members

- Public Types inherited from neuroml2::ChannelDensityNernst
typedef ::neuroml2::VariableParameter variableParameter_type
 Element type.
 
typedef ::xsd::cxx::tree::sequence< variableParameter_typevariableParameter_sequence
 Element sequence container type.
 
typedef variableParameter_sequence::iterator variableParameter_iterator
 Element iterator type.
 
typedef variableParameter_sequence::const_iterator variableParameter_const_iterator
 Element constant iterator type.
 
typedef ::xsd::cxx::tree::traits< variableParameter_type, char > variableParameter_traits
 Element traits type.
 
typedef ::neuroml2::NmlId ionChannel_type
 Attribute type.
 
typedef ::xsd::cxx::tree::traits< ionChannel_type, char > ionChannel_traits
 Attribute traits type.
 
typedef ::neuroml2::Nml2Quantity_conductanceDensity condDensity_type
 Attribute type.
 
typedef ::xsd::cxx::tree::optional< condDensity_typecondDensity_optional
 Attribute optional container type.
 
typedef ::xsd::cxx::tree::traits< condDensity_type, char > condDensity_traits
 Attribute traits type.
 
typedef ::neuroml2::NmlId segmentGroup_type
 Attribute type.
 
typedef ::xsd::cxx::tree::traits< segmentGroup_type, char > segmentGroup_traits
 Attribute traits type.
 
typedef ::neuroml2::NmlId segment_type
 Attribute type.
 
typedef ::xsd::cxx::tree::optional< segment_typesegment_optional
 Attribute optional container type.
 
typedef ::xsd::cxx::tree::traits< segment_type, char > segment_traits
 Attribute traits type.
 
typedef ::neuroml2::NmlId ion_type
 Attribute type.
 
typedef ::xsd::cxx::tree::traits< ion_type, char > ion_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::ChannelDensityNernst
const variableParameter_sequencevariableParameter () const
 Return a read-only (constant) reference to the element sequence. More...
 
variableParameter_sequencevariableParameter ()
 Return a read-write reference to the element sequence. More...
 
void variableParameter (const variableParameter_sequence &s)
 Copy elements from a given sequence. More...
 
const ionChannel_typeionChannel () const
 Return a read-only (constant) reference to the attribute. More...
 
ionChannel_typeionChannel ()
 Return a read-write reference to the attribute. More...
 
void ionChannel (const ionChannel_type &x)
 Set the attribute value. More...
 
void ionChannel (::std::unique_ptr< ionChannel_type > p)
 Set the attribute value without copying. More...
 
const condDensity_optionalcondDensity () const
 Return a read-only (constant) reference to the attribute container. More...
 
condDensity_optionalcondDensity ()
 Return a read-write reference to the attribute container. More...
 
void condDensity (const condDensity_type &x)
 Set the attribute value. More...
 
void condDensity (const condDensity_optional &x)
 Set the attribute value. More...
 
void condDensity (::std::unique_ptr< condDensity_type > p)
 Set the attribute value without copying. More...
 
const segmentGroup_typesegmentGroup () const
 Return a read-only (constant) reference to the attribute. More...
 
segmentGroup_typesegmentGroup ()
 Return a read-write reference to the attribute. More...
 
void segmentGroup (const segmentGroup_type &x)
 Set the attribute value. More...
 
void segmentGroup (::std::unique_ptr< segmentGroup_type > p)
 Set the attribute value without copying. More...
 
const segment_optionalsegment () const
 Return a read-only (constant) reference to the attribute container. More...
 
segment_optionalsegment ()
 Return a read-write reference to the attribute container. More...
 
void segment (const segment_type &x)
 Set the attribute value. More...
 
void segment (const segment_optional &x)
 Set the attribute value. More...
 
void segment (::std::unique_ptr< segment_type > p)
 Set the attribute value without copying. More...
 
const ion_typeion () const
 Return a read-only (constant) reference to the attribute. More...
 
ion_typeion ()
 Return a read-write reference to the attribute. More...
 
void ion (const ion_type &x)
 Set the attribute value. More...
 
void ion (::std::unique_ptr< ion_type > p)
 Set the attribute value without copying. More...
 
 ChannelDensityNernst (const id_type &, const ionChannel_type &, const ion_type &)
 Create an instance from the ultimate base and initializers for required elements and attributes.
 
 ChannelDensityNernst (const ::xercesc::DOMElement &e, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Create an instance from a DOM element. More...
 
 ChannelDensityNernst (const ChannelDensityNernst &x, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Copy constructor. More...
 
ChannelDensityNernstoperator= (const ChannelDensityNernst &x)
 Copy assignment operator. More...
 
virtual ~ChannelDensityNernst ()
 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.
 
- Static Public Member Functions inherited from neuroml2::ChannelDensityNernst
static const segmentGroup_typesegmentGroup_default_value ()
 Return the default value for the attribute. More...
 

Detailed Description

Class corresponding to the ChannelDensityNernstCa2 schema type.

This component is similar to the original component type channelDensityNernst but it is changed in order to have a reversal potential that depends on a second independent Ca++ pool ( ca2 ). See https://github.com/OpenSourceBrain/ghk-nernst.
:param condDensity: :type condDensity: conductanceDensity

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

Constructor & Destructor Documentation

◆ ChannelDensityNernstCa2() [1/2]

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

◆ ChannelDensityNernstCa2() [2/2]

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

Member Function Documentation

◆ _clone()

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

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


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