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

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

#include <NeuroML_v2.3.hxx>

+ Inheritance diagram for neuroml2::TauInfTransition:
+ Collaboration diagram for neuroml2::TauInfTransition:

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

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

from

Accessor and modifier functions for the from required attribute.

typedef ::neuroml2::NmlId from_type
 Attribute type.
 
typedef ::xsd::cxx::tree::traits< from_type, char > from_traits
 Attribute traits type.
 
const from_typefrom () const
 Return a read-only (constant) reference to the attribute. More...
 
from_typefrom ()
 Return a read-write reference to the attribute. More...
 
void from (const from_type &x)
 Set the attribute value. More...
 
void from (::std::unique_ptr< from_type > p)
 Set the attribute value without copying. More...
 

to

Accessor and modifier functions for the to required attribute.

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

Constructors

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

KS Transition specified in terms of time constant tau and steady state inf

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

Constructor & Destructor Documentation

◆ TauInfTransition() [1/3]

neuroml2::TauInfTransition::TauInfTransition ( const id_type id,
::std::unique_ptr< steadyState_type steadyState,
::std::unique_ptr< timeCourse_type timeCourse,
const from_type from,
const to_type to 
)

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

◆ TauInfTransition() [2/3]

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

◆ TauInfTransition() [3/3]

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

Member Function Documentation

◆ _clone()

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

◆ from() [1/4]

TauInfTransition::from_type & neuroml2::TauInfTransition::from ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.

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

◆ from() [2/4]

const TauInfTransition::from_type & neuroml2::TauInfTransition::from ( ) const

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

Returns
A constant reference to the attribute.

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

◆ from() [3/4]

void neuroml2::TauInfTransition::from ( ::std::unique_ptr< from_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 3957 of file NeuroML_v2.3.cxx.

◆ from() [4/4]

void neuroml2::TauInfTransition::from ( const from_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 3951 of file NeuroML_v2.3.cxx.

◆ operator=()

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

◆ steadyState() [1/4]

TauInfTransition::steadyState_type & neuroml2::TauInfTransition::steadyState ( )

Return a read-write reference to the element.

Returns
A reference to the element.

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

◆ steadyState() [2/4]

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

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

Returns
A constant reference to the element.

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

◆ steadyState() [3/4]

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

◆ steadyState() [4/4]

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

◆ timeCourse() [1/4]

TauInfTransition::timeCourse_type & neuroml2::TauInfTransition::timeCourse ( )

Return a read-write reference to the element.

Returns
A reference to the element.

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

◆ timeCourse() [2/4]

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

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

Returns
A constant reference to the element.

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

◆ timeCourse() [3/4]

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

◆ timeCourse() [4/4]

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

◆ to() [1/4]

TauInfTransition::to_type & neuroml2::TauInfTransition::to ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.

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

◆ to() [2/4]

const TauInfTransition::to_type & neuroml2::TauInfTransition::to ( ) const

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

Returns
A constant reference to the attribute.

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

◆ to() [3/4]

void neuroml2::TauInfTransition::to ( ::std::unique_ptr< to_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 3981 of file NeuroML_v2.3.cxx.

◆ to() [4/4]

void neuroml2::TauInfTransition::to ( const to_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 3975 of file NeuroML_v2.3.cxx.


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