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

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

#include <NeuroML_v2.3.hxx>

+ Inheritance diagram for neuroml2::GateHHTauInf:
+ Collaboration diagram for neuroml2::GateHHTauInf:

notes

Accessor and modifier functions for the notes optional element.

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

q10Settings

Accessor and modifier functions for the q10Settings optional element.

typedef ::neuroml2::Q10Settings q10Settings_type
 Element type.
 
typedef ::xsd::cxx::tree::optional< q10Settings_typeq10Settings_optional
 Element optional container type.
 
typedef ::xsd::cxx::tree::traits< q10Settings_type, char > q10Settings_traits
 Element traits type.
 
const q10Settings_optionalq10Settings () const
 Return a read-only (constant) reference to the element container. More...
 
q10Settings_optionalq10Settings ()
 Return a read-write reference to the element container. More...
 
void q10Settings (const q10Settings_type &x)
 Set the element value. More...
 
void q10Settings (const q10Settings_optional &x)
 Set the element value. More...
 
void q10Settings (::std::unique_ptr< q10Settings_type > p)
 Set the element value without copying. More...
 

timeCourse

Accessor and modifier functions for the timeCourse required element.

typedef ::neuroml2::HHTime timeCourse_type
 Element type.
 
typedef ::xsd::cxx::tree::traits< timeCourse_type, char > timeCourse_traits
 Element traits type.
 
const timeCourse_typetimeCourse () const
 Return a read-only (constant) reference to the element. More...
 
timeCourse_typetimeCourse ()
 Return a read-write reference to the element. More...
 
void timeCourse (const timeCourse_type &x)
 Set the element value. More...
 
void timeCourse (::std::unique_ptr< timeCourse_type > p)
 Set the element value without copying. More...
 

steadyState

Accessor and modifier functions for the steadyState required element.

typedef ::neuroml2::HHVariable steadyState_type
 Element type.
 
typedef ::xsd::cxx::tree::traits< steadyState_type, char > steadyState_traits
 Element traits type.
 
const steadyState_typesteadyState () const
 Return a read-only (constant) reference to the element. More...
 
steadyState_typesteadyState ()
 Return a read-write reference to the element. More...
 
void steadyState (const steadyState_type &x)
 Set the element value. More...
 
void steadyState (::std::unique_ptr< steadyState_type > p)
 Set the element value without copying. More...
 

instances

Accessor and modifier functions for the instances required attribute.

typedef ::neuroml2::PositiveInteger instances_type
 Attribute type.
 
typedef ::xsd::cxx::tree::traits< instances_type, char > instances_traits
 Attribute traits type.
 
const instances_typeinstances () const
 Return a read-only (constant) reference to the attribute. More...
 
instances_typeinstances ()
 Return a read-write reference to the attribute. More...
 
void instances (const instances_type &x)
 Set the attribute value. More...
 
void instances (::std::unique_ptr< instances_type > p)
 Set the attribute value without copying. More...
 

Constructors

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

Gate which follows the general Hodgkin Huxley formalism
:param instances: :type instances: none

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

Constructor & Destructor Documentation

◆ GateHHTauInf() [1/3]

neuroml2::GateHHTauInf::GateHHTauInf ( const id_type id,
::std::unique_ptr< timeCourse_type timeCourse,
::std::unique_ptr< steadyState_type steadyState,
const instances_type instances 
)

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 26402 of file NeuroML_v2.3.cxx.

◆ GateHHTauInf() [2/3]

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

◆ GateHHTauInf() [3/3]

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

Member Function Documentation

◆ _clone()

GateHHTauInf * neuroml2::GateHHTauInf::_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 26555 of file NeuroML_v2.3.cxx.

◆ instances() [1/4]

GateHHTauInf::instances_type & neuroml2::GateHHTauInf::instances ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.

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

◆ instances() [2/4]

const GateHHTauInf::instances_type & neuroml2::GateHHTauInf::instances ( ) const

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

Returns
A constant reference to the attribute.

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

◆ instances() [3/4]

void neuroml2::GateHHTauInf::instances ( ::std::unique_ptr< instances_type p)

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

◆ instances() [4/4]

void neuroml2::GateHHTauInf::instances ( const instances_type x)

Set the attribute value.

Parameters
xA new value to set.

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

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

◆ notes() [1/5]

GateHHTauInf::notes_optional & neuroml2::GateHHTauInf::notes ( )

Return a read-write reference to the element container.

Returns
A reference to the optional container.

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

◆ notes() [2/5]

const GateHHTauInf::notes_optional & neuroml2::GateHHTauInf::notes ( ) const

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

Returns
A constant reference to the optional container.

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

◆ notes() [3/5]

void neuroml2::GateHHTauInf::notes ( ::std::unique_ptr< notes_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 4579 of file NeuroML_v2.3.cxx.

◆ notes() [4/5]

void neuroml2::GateHHTauInf::notes ( const notes_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 4573 of file NeuroML_v2.3.cxx.

◆ notes() [5/5]

void neuroml2::GateHHTauInf::notes ( const notes_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 4567 of file NeuroML_v2.3.cxx.

◆ operator=()

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

◆ q10Settings() [1/5]

GateHHTauInf::q10Settings_optional & neuroml2::GateHHTauInf::q10Settings ( )

Return a read-write reference to the element container.

Returns
A reference to the optional container.

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

◆ q10Settings() [2/5]

const GateHHTauInf::q10Settings_optional & neuroml2::GateHHTauInf::q10Settings ( ) const

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

Returns
A constant reference to the optional container.

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

◆ q10Settings() [3/5]

void neuroml2::GateHHTauInf::q10Settings ( ::std::unique_ptr< q10Settings_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 4609 of file NeuroML_v2.3.cxx.

◆ q10Settings() [4/5]

void neuroml2::GateHHTauInf::q10Settings ( const q10Settings_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 4603 of file NeuroML_v2.3.cxx.

◆ q10Settings() [5/5]

void neuroml2::GateHHTauInf::q10Settings ( const q10Settings_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 4597 of file NeuroML_v2.3.cxx.

◆ steadyState() [1/4]

GateHHTauInf::steadyState_type & neuroml2::GateHHTauInf::steadyState ( )

Return a read-write reference to the element.

Returns
A reference to the element.

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

◆ steadyState() [2/4]

const GateHHTauInf::steadyState_type & neuroml2::GateHHTauInf::steadyState ( ) const

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

Returns
A constant reference to the element.

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

◆ steadyState() [3/4]

void neuroml2::GateHHTauInf::steadyState ( ::std::unique_ptr< steadyState_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 4657 of file NeuroML_v2.3.cxx.

◆ steadyState() [4/4]

void neuroml2::GateHHTauInf::steadyState ( const steadyState_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 4651 of file NeuroML_v2.3.cxx.

◆ timeCourse() [1/4]

GateHHTauInf::timeCourse_type & neuroml2::GateHHTauInf::timeCourse ( )

Return a read-write reference to the element.

Returns
A reference to the element.

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

◆ timeCourse() [2/4]

const GateHHTauInf::timeCourse_type & neuroml2::GateHHTauInf::timeCourse ( ) const

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

Returns
A constant reference to the element.

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

◆ timeCourse() [3/4]

void neuroml2::GateHHTauInf::timeCourse ( ::std::unique_ptr< timeCourse_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 4633 of file NeuroML_v2.3.cxx.

◆ timeCourse() [4/4]

void neuroml2::GateHHTauInf::timeCourse ( const timeCourse_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 4627 of file NeuroML_v2.3.cxx.


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