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

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

#include <NeuroML_v2.3.hxx>

+ Inheritance diagram for neuroml2::IonChannelHH:
+ Collaboration diagram for neuroml2::IonChannelHH:

Constructors

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

Additional Inherited Members

- Public Types inherited from neuroml2::IonChannel
typedef ::neuroml2::GateHHUndetermined gate_type
 Element type.
 
typedef ::xsd::cxx::tree::sequence< gate_typegate_sequence
 Element sequence container type.
 
typedef gate_sequence::iterator gate_iterator
 Element iterator type.
 
typedef gate_sequence::const_iterator gate_const_iterator
 Element constant iterator type.
 
typedef ::xsd::cxx::tree::traits< gate_type, char > gate_traits
 Element traits type.
 
typedef ::neuroml2::GateHHRates gateHHrates_type
 Element type.
 
typedef ::xsd::cxx::tree::sequence< gateHHrates_typegateHHrates_sequence
 Element sequence container type.
 
typedef gateHHrates_sequence::iterator gateHHrates_iterator
 Element iterator type.
 
typedef gateHHrates_sequence::const_iterator gateHHrates_const_iterator
 Element constant iterator type.
 
typedef ::xsd::cxx::tree::traits< gateHHrates_type, char > gateHHrates_traits
 Element traits type.
 
typedef ::neuroml2::GateHHRatesTau gateHHratesTau_type
 Element type.
 
typedef ::xsd::cxx::tree::sequence< gateHHratesTau_typegateHHratesTau_sequence
 Element sequence container type.
 
typedef gateHHratesTau_sequence::iterator gateHHratesTau_iterator
 Element iterator type.
 
typedef gateHHratesTau_sequence::const_iterator gateHHratesTau_const_iterator
 Element constant iterator type.
 
typedef ::xsd::cxx::tree::traits< gateHHratesTau_type, char > gateHHratesTau_traits
 Element traits type.
 
typedef ::neuroml2::GateHHTauInf gateHHtauInf_type
 Element type.
 
typedef ::xsd::cxx::tree::sequence< gateHHtauInf_typegateHHtauInf_sequence
 Element sequence container type.
 
typedef gateHHtauInf_sequence::iterator gateHHtauInf_iterator
 Element iterator type.
 
typedef gateHHtauInf_sequence::const_iterator gateHHtauInf_const_iterator
 Element constant iterator type.
 
typedef ::xsd::cxx::tree::traits< gateHHtauInf_type, char > gateHHtauInf_traits
 Element traits type.
 
typedef ::neuroml2::GateHHRatesInf gateHHratesInf_type
 Element type.
 
typedef ::xsd::cxx::tree::sequence< gateHHratesInf_typegateHHratesInf_sequence
 Element sequence container type.
 
typedef gateHHratesInf_sequence::iterator gateHHratesInf_iterator
 Element iterator type.
 
typedef gateHHratesInf_sequence::const_iterator gateHHratesInf_const_iterator
 Element constant iterator type.
 
typedef ::xsd::cxx::tree::traits< gateHHratesInf_type, char > gateHHratesInf_traits
 Element traits type.
 
typedef ::neuroml2::GateHHRatesTauInf gateHHratesTauInf_type
 Element type.
 
typedef ::xsd::cxx::tree::sequence< gateHHratesTauInf_typegateHHratesTauInf_sequence
 Element sequence container type.
 
typedef gateHHratesTauInf_sequence::iterator gateHHratesTauInf_iterator
 Element iterator type.
 
typedef gateHHratesTauInf_sequence::const_iterator gateHHratesTauInf_const_iterator
 Element constant iterator type.
 
typedef ::xsd::cxx::tree::traits< gateHHratesTauInf_type, char > gateHHratesTauInf_traits
 Element traits type.
 
typedef ::neuroml2::GateHHInstantaneous gateHHInstantaneous_type
 Element type.
 
typedef ::xsd::cxx::tree::sequence< gateHHInstantaneous_typegateHHInstantaneous_sequence
 Element sequence container type.
 
typedef gateHHInstantaneous_sequence::iterator gateHHInstantaneous_iterator
 Element iterator type.
 
typedef gateHHInstantaneous_sequence::const_iterator gateHHInstantaneous_const_iterator
 Element constant iterator type.
 
typedef ::xsd::cxx::tree::traits< gateHHInstantaneous_type, char > gateHHInstantaneous_traits
 Element traits type.
 
typedef ::neuroml2::GateFractional gateFractional_type
 Element type.
 
typedef ::xsd::cxx::tree::sequence< gateFractional_typegateFractional_sequence
 Element sequence container type.
 
typedef gateFractional_sequence::iterator gateFractional_iterator
 Element iterator type.
 
typedef gateFractional_sequence::const_iterator gateFractional_const_iterator
 Element constant iterator type.
 
typedef ::xsd::cxx::tree::traits< gateFractional_type, char > gateFractional_traits
 Element traits type.
 
typedef ::neuroml2::NmlId species_type
 Attribute type.
 
typedef ::xsd::cxx::tree::optional< species_typespecies_optional
 Attribute optional container type.
 
typedef ::xsd::cxx::tree::traits< species_type, char > species_traits
 Attribute traits type.
 
typedef ::neuroml2::channelTypes type_type
 Attribute type.
 
typedef ::xsd::cxx::tree::optional< type_typetype_optional
 Attribute optional container type.
 
typedef ::xsd::cxx::tree::traits< type_type, char > type_traits
 Attribute traits type.
 
typedef ::neuroml2::Nml2Quantity_conductance conductance_type
 Attribute type.
 
typedef ::xsd::cxx::tree::optional< conductance_typeconductance_optional
 Attribute optional container type.
 
typedef ::xsd::cxx::tree::traits< conductance_type, char > conductance_traits
 Attribute traits type.
 
- Public Types inherited from neuroml2::IonChannelScalable
typedef ::neuroml2::Q10ConductanceScaling q10ConductanceScaling_type
 Element type.
 
typedef ::xsd::cxx::tree::sequence< q10ConductanceScaling_typeq10ConductanceScaling_sequence
 Element sequence container type.
 
typedef q10ConductanceScaling_sequence::iterator q10ConductanceScaling_iterator
 Element iterator type.
 
typedef q10ConductanceScaling_sequence::const_iterator q10ConductanceScaling_const_iterator
 Element constant iterator type.
 
typedef ::xsd::cxx::tree::traits< q10ConductanceScaling_type, char > q10ConductanceScaling_traits
 Element traits type.
 
typedef ::neuroml2::NeuroLexId neuroLexId_type
 Attribute type.
 
typedef ::xsd::cxx::tree::optional< neuroLexId_typeneuroLexId_optional
 Attribute optional container type.
 
typedef ::xsd::cxx::tree::traits< neuroLexId_type, char > neuroLexId_traits
 Attribute traits type.
 
- 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::IonChannel
const gate_sequencegate () const
 Return a read-only (constant) reference to the element sequence. More...
 
gate_sequencegate ()
 Return a read-write reference to the element sequence. More...
 
void gate (const gate_sequence &s)
 Copy elements from a given sequence. More...
 
const gateHHrates_sequencegateHHrates () const
 Return a read-only (constant) reference to the element sequence. More...
 
gateHHrates_sequencegateHHrates ()
 Return a read-write reference to the element sequence. More...
 
void gateHHrates (const gateHHrates_sequence &s)
 Copy elements from a given sequence. More...
 
const gateHHratesTau_sequencegateHHratesTau () const
 Return a read-only (constant) reference to the element sequence. More...
 
gateHHratesTau_sequencegateHHratesTau ()
 Return a read-write reference to the element sequence. More...
 
void gateHHratesTau (const gateHHratesTau_sequence &s)
 Copy elements from a given sequence. More...
 
const gateHHtauInf_sequencegateHHtauInf () const
 Return a read-only (constant) reference to the element sequence. More...
 
gateHHtauInf_sequencegateHHtauInf ()
 Return a read-write reference to the element sequence. More...
 
void gateHHtauInf (const gateHHtauInf_sequence &s)
 Copy elements from a given sequence. More...
 
const gateHHratesInf_sequencegateHHratesInf () const
 Return a read-only (constant) reference to the element sequence. More...
 
gateHHratesInf_sequencegateHHratesInf ()
 Return a read-write reference to the element sequence. More...
 
void gateHHratesInf (const gateHHratesInf_sequence &s)
 Copy elements from a given sequence. More...
 
const gateHHratesTauInf_sequencegateHHratesTauInf () const
 Return a read-only (constant) reference to the element sequence. More...
 
gateHHratesTauInf_sequencegateHHratesTauInf ()
 Return a read-write reference to the element sequence. More...
 
void gateHHratesTauInf (const gateHHratesTauInf_sequence &s)
 Copy elements from a given sequence. More...
 
const gateHHInstantaneous_sequencegateHHInstantaneous () const
 Return a read-only (constant) reference to the element sequence. More...
 
gateHHInstantaneous_sequencegateHHInstantaneous ()
 Return a read-write reference to the element sequence. More...
 
void gateHHInstantaneous (const gateHHInstantaneous_sequence &s)
 Copy elements from a given sequence. More...
 
const gateFractional_sequencegateFractional () const
 Return a read-only (constant) reference to the element sequence. More...
 
gateFractional_sequencegateFractional ()
 Return a read-write reference to the element sequence. More...
 
void gateFractional (const gateFractional_sequence &s)
 Copy elements from a given sequence. More...
 
const species_optionalspecies () const
 Return a read-only (constant) reference to the attribute container. More...
 
species_optionalspecies ()
 Return a read-write reference to the attribute container. More...
 
void species (const species_type &x)
 Set the attribute value. More...
 
void species (const species_optional &x)
 Set the attribute value. More...
 
void species (::std::unique_ptr< species_type > p)
 Set the attribute value without copying. More...
 
const type_optionaltype () const
 Return a read-only (constant) reference to the attribute container. More...
 
type_optionaltype ()
 Return a read-write reference to the attribute container. More...
 
void type (const type_type &x)
 Set the attribute value. More...
 
void type (const type_optional &x)
 Set the attribute value. More...
 
void type (::std::unique_ptr< type_type > p)
 Set the attribute value without copying. More...
 
const conductance_optionalconductance () const
 Return a read-only (constant) reference to the attribute container. More...
 
conductance_optionalconductance ()
 Return a read-write reference to the attribute container. More...
 
void conductance (const conductance_type &x)
 Set the attribute value. More...
 
void conductance (const conductance_optional &x)
 Set the attribute value. More...
 
void conductance (::std::unique_ptr< conductance_type > p)
 Set the attribute value without copying. More...
 
 IonChannel (const id_type &)
 Create an instance from the ultimate base and initializers for required elements and attributes.
 
 IonChannel (const ::xercesc::DOMElement &e, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Create an instance from a DOM element. More...
 
 IonChannel (const IonChannel &x, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Copy constructor. More...
 
IonChanneloperator= (const IonChannel &x)
 Copy assignment operator. More...
 
virtual ~IonChannel ()
 Destructor.
 
- Public Member Functions inherited from neuroml2::IonChannelScalable
const q10ConductanceScaling_sequenceq10ConductanceScaling () const
 Return a read-only (constant) reference to the element sequence. More...
 
q10ConductanceScaling_sequenceq10ConductanceScaling ()
 Return a read-write reference to the element sequence. More...
 
void q10ConductanceScaling (const q10ConductanceScaling_sequence &s)
 Copy elements from a given sequence. More...
 
const neuroLexId_optionalneuroLexId () const
 Return a read-only (constant) reference to the attribute container. More...
 
neuroLexId_optionalneuroLexId ()
 Return a read-write reference to the attribute container. More...
 
void neuroLexId (const neuroLexId_type &x)
 Set the attribute value. More...
 
void neuroLexId (const neuroLexId_optional &x)
 Set the attribute value. More...
 
void neuroLexId (::std::unique_ptr< neuroLexId_type > p)
 Set the attribute value without copying. More...
 
 IonChannelScalable (const id_type &)
 Create an instance from the ultimate base and initializers for required elements and attributes.
 
 IonChannelScalable (const ::xercesc::DOMElement &e, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Create an instance from a DOM element. More...
 
 IonChannelScalable (const IonChannelScalable &x, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Copy constructor. More...
 
IonChannelScalableoperator= (const IonChannelScalable &x)
 Copy assignment operator. More...
 
virtual ~IonChannelScalable ()
 Destructor.
 
- 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 IonChannelHH schema type.

Note ionChannel and ionChannelHH are currently functionally identical. This is needed since many existing examples use ionChannel, some use ionChannelHH. NeuroML v2beta4 should remove one of these, probably ionChannelHH.
:param conductance: :type conductance: conductance

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

Constructor & Destructor Documentation

◆ IonChannelHH() [1/2]

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

◆ IonChannelHH() [2/2]

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

Member Function Documentation

◆ _clone()

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

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


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