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

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

#include <NeuroML_v2.3.hxx>

+ Inheritance diagram for neuroml2::GateHHUndetermined:
+ Collaboration diagram for neuroml2::GateHHUndetermined:

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

forwardRate

Accessor and modifier functions for the forwardRate optional element.

typedef ::neuroml2::HHRate forwardRate_type
 Element type.
 
typedef ::xsd::cxx::tree::optional< forwardRate_typeforwardRate_optional
 Element optional container type.
 
typedef ::xsd::cxx::tree::traits< forwardRate_type, char > forwardRate_traits
 Element traits type.
 
const forwardRate_optionalforwardRate () const
 Return a read-only (constant) reference to the element container. More...
 
forwardRate_optionalforwardRate ()
 Return a read-write reference to the element container. More...
 
void forwardRate (const forwardRate_type &x)
 Set the element value. More...
 
void forwardRate (const forwardRate_optional &x)
 Set the element value. More...
 
void forwardRate (::std::unique_ptr< forwardRate_type > p)
 Set the element value without copying. More...
 

reverseRate

Accessor and modifier functions for the reverseRate optional element.

typedef ::neuroml2::HHRate reverseRate_type
 Element type.
 
typedef ::xsd::cxx::tree::optional< reverseRate_typereverseRate_optional
 Element optional container type.
 
typedef ::xsd::cxx::tree::traits< reverseRate_type, char > reverseRate_traits
 Element traits type.
 
const reverseRate_optionalreverseRate () const
 Return a read-only (constant) reference to the element container. More...
 
reverseRate_optionalreverseRate ()
 Return a read-write reference to the element container. More...
 
void reverseRate (const reverseRate_type &x)
 Set the element value. More...
 
void reverseRate (const reverseRate_optional &x)
 Set the element value. More...
 
void reverseRate (::std::unique_ptr< reverseRate_type > p)
 Set the element value without copying. More...
 

timeCourse

Accessor and modifier functions for the timeCourse optional element.

typedef ::neuroml2::HHTime timeCourse_type
 Element type.
 
typedef ::xsd::cxx::tree::optional< timeCourse_typetimeCourse_optional
 Element optional container type.
 
typedef ::xsd::cxx::tree::traits< timeCourse_type, char > timeCourse_traits
 Element traits type.
 
const timeCourse_optionaltimeCourse () const
 Return a read-only (constant) reference to the element container. More...
 
timeCourse_optionaltimeCourse ()
 Return a read-write reference to the element container. More...
 
void timeCourse (const timeCourse_type &x)
 Set the element value. More...
 
void timeCourse (const timeCourse_optional &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 optional element.

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

subGate

Accessor and modifier functions for the subGate sequence element.

typedef ::neuroml2::GateFractionalSubgate subGate_type
 Element type.
 
typedef ::xsd::cxx::tree::sequence< subGate_typesubGate_sequence
 Element sequence container type.
 
typedef subGate_sequence::iterator subGate_iterator
 Element iterator type.
 
typedef subGate_sequence::const_iterator subGate_const_iterator
 Element constant iterator type.
 
typedef ::xsd::cxx::tree::traits< subGate_type, char > subGate_traits
 Element traits type.
 
const subGate_sequencesubGate () const
 Return a read-only (constant) reference to the element sequence. More...
 
subGate_sequencesubGate ()
 Return a read-write reference to the element sequence. More...
 
void subGate (const subGate_sequence &s)
 Copy elements from a given sequence. 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...
 

type

Accessor and modifier functions for the type required attribute.

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

Constructors

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

Note all sub elements for gateHHrates, gateHHratesTau, gateFractional etc. allowed here. Which are valid should be constrained by what type is set

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

Constructor & Destructor Documentation

◆ GateHHUndetermined() [1/2]

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

◆ GateHHUndetermined() [2/2]

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

Member Function Documentation

◆ _clone()

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

◆ forwardRate() [1/5]

GateHHUndetermined::forwardRate_optional & neuroml2::GateHHUndetermined::forwardRate ( )

Return a read-write reference to the element container.

Returns
A reference to the optional container.

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

◆ forwardRate() [2/5]

const GateHHUndetermined::forwardRate_optional & neuroml2::GateHHUndetermined::forwardRate ( ) const

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

Returns
A constant reference to the optional container.

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

◆ forwardRate() [3/5]

void neuroml2::GateHHUndetermined::forwardRate ( ::std::unique_ptr< forwardRate_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 4253 of file NeuroML_v2.3.cxx.

◆ forwardRate() [4/5]

void neuroml2::GateHHUndetermined::forwardRate ( const forwardRate_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 4247 of file NeuroML_v2.3.cxx.

◆ forwardRate() [5/5]

void neuroml2::GateHHUndetermined::forwardRate ( const forwardRate_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 4241 of file NeuroML_v2.3.cxx.

◆ instances() [1/4]

GateHHUndetermined::instances_type & neuroml2::GateHHUndetermined::instances ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.

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

◆ instances() [2/4]

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

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

Returns
A constant reference to the attribute.

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

◆ instances() [3/4]

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

◆ instances() [4/4]

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

◆ notes() [1/5]

GateHHUndetermined::notes_optional & neuroml2::GateHHUndetermined::notes ( )

Return a read-write reference to the element container.

Returns
A reference to the optional container.

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

◆ notes() [2/5]

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

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

Returns
A constant reference to the optional container.

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

◆ notes() [3/5]

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

◆ notes() [4/5]

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

◆ notes() [5/5]

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

◆ operator=()

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

◆ q10Settings() [1/5]

GateHHUndetermined::q10Settings_optional & neuroml2::GateHHUndetermined::q10Settings ( )

Return a read-write reference to the element container.

Returns
A reference to the optional container.

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

◆ q10Settings() [2/5]

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

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

Returns
A constant reference to the optional container.

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

◆ q10Settings() [3/5]

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

◆ q10Settings() [4/5]

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

◆ q10Settings() [5/5]

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

◆ reverseRate() [1/5]

GateHHUndetermined::reverseRate_optional & neuroml2::GateHHUndetermined::reverseRate ( )

Return a read-write reference to the element container.

Returns
A reference to the optional container.

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

◆ reverseRate() [2/5]

const GateHHUndetermined::reverseRate_optional & neuroml2::GateHHUndetermined::reverseRate ( ) const

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

Returns
A constant reference to the optional container.

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

◆ reverseRate() [3/5]

void neuroml2::GateHHUndetermined::reverseRate ( ::std::unique_ptr< reverseRate_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 4283 of file NeuroML_v2.3.cxx.

◆ reverseRate() [4/5]

void neuroml2::GateHHUndetermined::reverseRate ( const reverseRate_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 4277 of file NeuroML_v2.3.cxx.

◆ reverseRate() [5/5]

void neuroml2::GateHHUndetermined::reverseRate ( const reverseRate_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 4271 of file NeuroML_v2.3.cxx.

◆ steadyState() [1/5]

GateHHUndetermined::steadyState_optional & neuroml2::GateHHUndetermined::steadyState ( )

Return a read-write reference to the element container.

Returns
A reference to the optional container.

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

◆ steadyState() [2/5]

const GateHHUndetermined::steadyState_optional & neuroml2::GateHHUndetermined::steadyState ( ) const

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

Returns
A constant reference to the optional container.

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

◆ steadyState() [3/5]

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

◆ steadyState() [4/5]

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

◆ steadyState() [5/5]

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

◆ subGate() [1/3]

GateHHUndetermined::subGate_sequence & neuroml2::GateHHUndetermined::subGate ( )

Return a read-write reference to the element sequence.

Returns
A reference to the sequence container.

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

◆ subGate() [2/3]

const GateHHUndetermined::subGate_sequence & neuroml2::GateHHUndetermined::subGate ( ) const

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

Returns
A constant reference to the sequence container.

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

◆ subGate() [3/3]

void neuroml2::GateHHUndetermined::subGate ( const subGate_sequence s)

Copy elements from a given sequence.

Parameters
sA sequence to copy elements from.

For each element in s this function makes a copy and adds it to the sequence. Note that this operation completely changes the sequence and all old elements will be lost.

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

◆ timeCourse() [1/5]

GateHHUndetermined::timeCourse_optional & neuroml2::GateHHUndetermined::timeCourse ( )

Return a read-write reference to the element container.

Returns
A reference to the optional container.

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

◆ timeCourse() [2/5]

const GateHHUndetermined::timeCourse_optional & neuroml2::GateHHUndetermined::timeCourse ( ) const

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

Returns
A constant reference to the optional container.

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

◆ timeCourse() [3/5]

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

◆ timeCourse() [4/5]

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

◆ timeCourse() [5/5]

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

◆ type() [1/4]

GateHHUndetermined::type_type & neuroml2::GateHHUndetermined::type ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.

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

◆ type() [2/4]

const GateHHUndetermined::type_type & neuroml2::GateHHUndetermined::type ( ) const

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

Returns
A constant reference to the attribute.

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

◆ type() [3/4]

void neuroml2::GateHHUndetermined::type ( ::std::unique_ptr< type_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 4409 of file NeuroML_v2.3.cxx.

◆ type() [4/4]

void neuroml2::GateHHUndetermined::type ( const type_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 4403 of file NeuroML_v2.3.cxx.


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