neuroml2::GateHHRates Class Reference

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

#include <NeuroML_v2.3.hxx>

Inheritance diagram for neuroml2::GateHHRates:

Collaboration diagram for neuroml2::GateHHRates:

notes
Accessor and modifier functions for the notes optional element.
typedef ::neuroml2::Notes	notes_type
	Element type.
typedef ::xsd::cxx::tree::optional< notes_type >	notes_optional
	Element optional container type.
typedef ::xsd::cxx::tree::traits< notes_type, char >	notes_traits
	Element traits type.
const notes_optional &	notes () const
	Return a read-only (constant) reference to the element container. More...
notes_optional &	notes ()
	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_type >	q10Settings_optional
	Element optional container type.
typedef ::xsd::cxx::tree::traits< q10Settings_type, char >	q10Settings_traits
	Element traits type.
const q10Settings_optional &	q10Settings () const
	Return a read-only (constant) reference to the element container. More...
q10Settings_optional &	q10Settings ()
	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 required element.
typedef ::neuroml2::HHRate	forwardRate_type
	Element type.
typedef ::xsd::cxx::tree::traits< forwardRate_type, char >	forwardRate_traits
	Element traits type.
const forwardRate_type &	forwardRate () const
	Return a read-only (constant) reference to the element. More...
forwardRate_type &	forwardRate ()
	Return a read-write reference to the element. More...
void	forwardRate (const forwardRate_type &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 required element.
typedef ::neuroml2::HHRate	reverseRate_type
	Element type.
typedef ::xsd::cxx::tree::traits< reverseRate_type, char >	reverseRate_traits
	Element traits type.
const reverseRate_type &	reverseRate () const
	Return a read-only (constant) reference to the element. More...
reverseRate_type &	reverseRate ()
	Return a read-write reference to the element. More...
void	reverseRate (const reverseRate_type &x)
	Set the element value. More...
void	reverseRate (::std::unique_ptr< reverseRate_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_type &	instances () const
	Return a read-only (constant) reference to the attribute. More...
instances_type &	instances ()
	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
	GateHHRates (const id_type &, const forwardRate_type &, const reverseRate_type &, const instances_type &)
	Create an instance from the ultimate base and initializers for required elements and attributes.
	GateHHRates (const id_type &, ::std::unique_ptr< forwardRate_type >, ::std::unique_ptr< reverseRate_type >, const instances_type &)
	Create an instance from the ultimate base and initializers for required elements and attributes (::std::unique_ptr version). More...
	GateHHRates (const ::xercesc::DOMElement &e, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
	Create an instance from a DOM element. More...
	GateHHRates (const GateHHRates &x, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
	Copy constructor. More...
virtual GateHHRates *	_clone (::xml_schema::flags f=0, ::xml_schema::container *c=0) const
	Copy the instance polymorphically. More...
GateHHRates &	operator= (const GateHHRates &x)
	Copy assignment operator. More...
virtual	~GateHHRates ()
	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_type &	id () const
	Return a read-only (constant) reference to the attribute. More...
id_type &	id ()
	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...
Base &	operator= (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 GateHHRates schema type.

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

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

Constructor & Destructor Documentation

GateHHRates() [1/3]

neuroml2::GateHHRates::GateHHRates	(	const id_type &	id,
		::std::unique_ptr< forwardRate_type >	forwardRate,
		::std::unique_ptr< reverseRate_type >	reverseRate,
		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 26173 of file NeuroML_v2.3.cxx.

GateHHRates() [2/3]

neuroml2::GateHHRates::GateHHRates	(	const ::xercesc::DOMElement &	e,
		::xml_schema::flags	f = 0,
		::xml_schema::container *	c = 0
	)

Create an instance from a DOM element.

Parameters

e	A DOM element to extract the data from.
f	Flags to create the new instance with.
c	A pointer to the object that will contain the new instance.

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

GateHHRates() [3/3]

neuroml2::GateHHRates::GateHHRates	(	const GateHHRates &	x,
		::xml_schema::flags	f = 0,
		::xml_schema::container *	c = 0
	)

Copy constructor.

Parameters

x	An instance to make a copy of.
f	Flags to create the copy with.
c	A pointer to the object that will contain the copy.

For polymorphic object models use the _clone function instead.

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

Member Function Documentation

_clone()

GateHHRates * neuroml2::GateHHRates::_clone ( ::xml_schema::flags  f = 0, ::xml_schema::container *  c = 0  ) const

virtual

Copy the instance polymorphically.

Parameters

f	Flags to create the copy with.
c	A 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 26326 of file NeuroML_v2.3.cxx.

forwardRate() [1/4]

GateHHRates::forwardRate_type & neuroml2::GateHHRates::forwardRate

(

)

Return a read-write reference to the element.

Returns

A reference to the element.

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

forwardRate() [2/4]

const GateHHRates::forwardRate_type & neuroml2::GateHHRates::forwardRate

(

)

const

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

Returns

A constant reference to the element.

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

forwardRate() [3/4]

void neuroml2::GateHHRates::forwardRate

(

::std::unique_ptr< forwardRate_type >

p

)

Set the element value without copying.

Parameters

p	A new value to use.

This function will try to use the passed value directly instead of making a copy.

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

forwardRate() [4/4]

void neuroml2::GateHHRates::forwardRate

(

const forwardRate_type &

x

)

Set the element value.

Parameters

x	A 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 4491 of file NeuroML_v2.3.cxx.

instances() [1/4]

GateHHRates::instances_type & neuroml2::GateHHRates::instances

(

)

Return a read-write reference to the attribute.

Returns

A reference to the attribute.

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

instances() [2/4]

const GateHHRates::instances_type & neuroml2::GateHHRates::instances

(

)

const

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

Returns

A constant reference to the attribute.

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

instances() [3/4]

void neuroml2::GateHHRates::instances

(

::std::unique_ptr< instances_type >

p

)

Set the attribute value without copying.

Parameters

p	A new value to use.

This function will try to use the passed value directly instead of making a copy.

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

instances() [4/4]

void neuroml2::GateHHRates::instances

(

const instances_type &

x

)

Set the attribute value.

Parameters

x	A 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 4539 of file NeuroML_v2.3.cxx.

notes() [1/5]

GateHHRates::notes_optional & neuroml2::GateHHRates::notes

(

)

Return a read-write reference to the element container.

Returns

A reference to the optional container.

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

notes() [2/5]

const GateHHRates::notes_optional & neuroml2::GateHHRates::notes

(

)

const

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

Returns

A constant reference to the optional container.

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

notes() [3/5]

void neuroml2::GateHHRates::notes

(

::std::unique_ptr< notes_type >

p

)

Set the element value without copying.

Parameters

p	A new value to use.

This function will try to use the passed value directly instead of making a copy.

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

notes() [4/5]

void neuroml2::GateHHRates::notes

(

const notes_optional &

x

)

Set the element value.

Parameters

x	An 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 4437 of file NeuroML_v2.3.cxx.

notes() [5/5]

void neuroml2::GateHHRates::notes

(

const notes_type &

x

)

Set the element value.

Parameters

x	A 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 4431 of file NeuroML_v2.3.cxx.

operator=()

GateHHRates & neuroml2::GateHHRates::operator=

(

const GateHHRates &

x

)

Copy assignment operator.

Parameters

x	An instance to make a copy of.

Returns

A reference to itself.

For polymorphic object models use the _clone function instead.

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

q10Settings() [1/5]

GateHHRates::q10Settings_optional & neuroml2::GateHHRates::q10Settings

(

)

Return a read-write reference to the element container.

Returns

A reference to the optional container.

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

q10Settings() [2/5]

const GateHHRates::q10Settings_optional & neuroml2::GateHHRates::q10Settings

(

)

const

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

Returns

A constant reference to the optional container.

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

q10Settings() [3/5]

void neuroml2::GateHHRates::q10Settings

(

::std::unique_ptr< q10Settings_type >

p

)

Set the element value without copying.

Parameters

p	A new value to use.

This function will try to use the passed value directly instead of making a copy.

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

q10Settings() [4/5]

void neuroml2::GateHHRates::q10Settings

(

const q10Settings_optional &

x

)

Set the element value.

Parameters

x	An 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 4467 of file NeuroML_v2.3.cxx.

q10Settings() [5/5]

void neuroml2::GateHHRates::q10Settings

(

const q10Settings_type &

x

)

Set the element value.

Parameters

x	A 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 4461 of file NeuroML_v2.3.cxx.

reverseRate() [1/4]

GateHHRates::reverseRate_type & neuroml2::GateHHRates::reverseRate

(

)

Return a read-write reference to the element.

Returns

A reference to the element.

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

reverseRate() [2/4]

const GateHHRates::reverseRate_type & neuroml2::GateHHRates::reverseRate

(

)

const

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

Returns

A constant reference to the element.

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

reverseRate() [3/4]

void neuroml2::GateHHRates::reverseRate

(

::std::unique_ptr< reverseRate_type >

p

)

Set the element value without copying.

Parameters

p	A new value to use.

This function will try to use the passed value directly instead of making a copy.

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

reverseRate() [4/4]

void neuroml2::GateHHRates::reverseRate

(

const reverseRate_type &

x

)

Set the element value.

Parameters

x	A 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 4515 of file NeuroML_v2.3.cxx.

---

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

• src/NeuroML_v2.3.hxx
• src/NeuroML_v2.3.cxx