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

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

#include <NeuroML_v2.3.hxx>

+ Inheritance diagram for neuroml2::ReverseTransition:
+ Collaboration diagram for neuroml2::ReverseTransition:

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

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

A reverse only KSTransition for a gateKS which specifies a rate ( type baseHHRate ) which follows one of the standard Hodgkin Huxley forms ( e. g. HHExpRate , HHSigmoidRate , HHExpLinearRate

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

Constructor & Destructor Documentation

◆ ReverseTransition() [1/2]

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

◆ ReverseTransition() [2/2]

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

Member Function Documentation

◆ _clone()

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

◆ from() [1/4]

ReverseTransition::from_type & neuroml2::ReverseTransition::from ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.

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

◆ from() [2/4]

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

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

Returns
A constant reference to the attribute.

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

◆ from() [3/4]

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

◆ from() [4/4]

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

◆ operator=()

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

◆ to() [1/4]

ReverseTransition::to_type & neuroml2::ReverseTransition::to ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.

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

◆ to() [2/4]

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

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

Returns
A constant reference to the attribute.

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

◆ to() [3/4]

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

◆ to() [4/4]

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


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