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

#include <NeuroML_v2.3.hxx>

Inheritance diagram for neuroml2::Dynamics:

Collaboration diagram for neuroml2::Dynamics:

StateVariable
Accessor and modifier functions for the StateVariable sequence element.
typedef ::neuroml2::StateVariable	StateVariable_type
	Element type.

typedef ::xsd::cxx::tree::sequence< StateVariable_type >	StateVariable_sequence
	Element sequence container type.

typedef StateVariable_sequence::iterator	StateVariable_iterator
	Element iterator type.

typedef StateVariable_sequence::const_iterator	StateVariable_const_iterator
	Element constant iterator type.

typedef ::xsd::cxx::tree::traits< StateVariable_type, char >	StateVariable_traits
	Element traits type.

const StateVariable_sequence &	StateVariable () const
	Return a read-only (constant) reference to the element sequence. More...

StateVariable_sequence &	StateVariable ()
	Return a read-write reference to the element sequence. More...

void	StateVariable (const StateVariable_sequence &s)
	Copy elements from a given sequence. More...

DerivedVariable
Accessor and modifier functions for the DerivedVariable sequence element.
typedef ::neuroml2::DerivedVariable	DerivedVariable_type
	Element type.

typedef ::xsd::cxx::tree::sequence< DerivedVariable_type >	DerivedVariable_sequence
	Element sequence container type.

typedef DerivedVariable_sequence::iterator	DerivedVariable_iterator
	Element iterator type.

typedef DerivedVariable_sequence::const_iterator	DerivedVariable_const_iterator
	Element constant iterator type.

typedef ::xsd::cxx::tree::traits< DerivedVariable_type, char >	DerivedVariable_traits
	Element traits type.

const DerivedVariable_sequence &	DerivedVariable () const
	Return a read-only (constant) reference to the element sequence. More...

DerivedVariable_sequence &	DerivedVariable ()
	Return a read-write reference to the element sequence. More...

void	DerivedVariable (const DerivedVariable_sequence &s)
	Copy elements from a given sequence. More...

ConditionalDerivedVariable
Accessor and modifier functions for the ConditionalDerivedVariable sequence element.
typedef ::neuroml2::ConditionalDerivedVariable	ConditionalDerivedVariable_type
	Element type.

typedef ::xsd::cxx::tree::sequence< ConditionalDerivedVariable_type >	ConditionalDerivedVariable_sequence
	Element sequence container type.

typedef ConditionalDerivedVariable_sequence::iterator	ConditionalDerivedVariable_iterator
	Element iterator type.

typedef ConditionalDerivedVariable_sequence::const_iterator	ConditionalDerivedVariable_const_iterator
	Element constant iterator type.

typedef ::xsd::cxx::tree::traits< ConditionalDerivedVariable_type, char >	ConditionalDerivedVariable_traits
	Element traits type.

const ConditionalDerivedVariable_sequence &	ConditionalDerivedVariable () const
	Return a read-only (constant) reference to the element sequence. More...

ConditionalDerivedVariable_sequence &	ConditionalDerivedVariable ()
	Return a read-write reference to the element sequence. More...

void	ConditionalDerivedVariable (const ConditionalDerivedVariable_sequence &s)
	Copy elements from a given sequence. More...

TimeDerivative
Accessor and modifier functions for the TimeDerivative sequence element.
typedef ::neuroml2::TimeDerivative	TimeDerivative_type
	Element type.

typedef ::xsd::cxx::tree::sequence< TimeDerivative_type >	TimeDerivative_sequence
	Element sequence container type.

typedef TimeDerivative_sequence::iterator	TimeDerivative_iterator
	Element iterator type.

typedef TimeDerivative_sequence::const_iterator	TimeDerivative_const_iterator
	Element constant iterator type.

typedef ::xsd::cxx::tree::traits< TimeDerivative_type, char >	TimeDerivative_traits
	Element traits type.

const TimeDerivative_sequence &	TimeDerivative () const
	Return a read-only (constant) reference to the element sequence. More...

TimeDerivative_sequence &	TimeDerivative ()
	Return a read-write reference to the element sequence. More...

void	TimeDerivative (const TimeDerivative_sequence &s)
	Copy elements from a given sequence. More...

OnStart
Accessor and modifier functions for the OnStart optional element.
typedef ::neuroml2::OnStart	OnStart_type
	Element type.

typedef ::xsd::cxx::tree::optional< OnStart_type >	OnStart_optional
	Element optional container type.

typedef ::xsd::cxx::tree::traits< OnStart_type, char >	OnStart_traits
	Element traits type.

const OnStart_optional &	OnStart () const
	Return a read-only (constant) reference to the element container. More...

OnStart_optional &	OnStart ()
	Return a read-write reference to the element container. More...

void	OnStart (const OnStart_type &x)
	Set the element value. More...

void	OnStart (const OnStart_optional &x)
	Set the element value. More...

void	OnStart (::std::unique_ptr< OnStart_type > p)
	Set the element value without copying. More...

OnEvent
Accessor and modifier functions for the OnEvent sequence element.
typedef ::neuroml2::OnEvent	OnEvent_type
	Element type.

typedef ::xsd::cxx::tree::sequence< OnEvent_type >	OnEvent_sequence
	Element sequence container type.

typedef OnEvent_sequence::iterator	OnEvent_iterator
	Element iterator type.

typedef OnEvent_sequence::const_iterator	OnEvent_const_iterator
	Element constant iterator type.

typedef ::xsd::cxx::tree::traits< OnEvent_type, char >	OnEvent_traits
	Element traits type.

const OnEvent_sequence &	OnEvent () const
	Return a read-only (constant) reference to the element sequence. More...

OnEvent_sequence &	OnEvent ()
	Return a read-write reference to the element sequence. More...

void	OnEvent (const OnEvent_sequence &s)
	Copy elements from a given sequence. More...

OnCondition
Accessor and modifier functions for the OnCondition sequence element.
typedef ::neuroml2::OnCondition	OnCondition_type
	Element type.

typedef ::xsd::cxx::tree::sequence< OnCondition_type >	OnCondition_sequence
	Element sequence container type.

typedef OnCondition_sequence::iterator	OnCondition_iterator
	Element iterator type.

typedef OnCondition_sequence::const_iterator	OnCondition_const_iterator
	Element constant iterator type.

typedef ::xsd::cxx::tree::traits< OnCondition_type, char >	OnCondition_traits
	Element traits type.

const OnCondition_sequence &	OnCondition () const
	Return a read-only (constant) reference to the element sequence. More...

OnCondition_sequence &	OnCondition ()
	Return a read-write reference to the element sequence. More...

void	OnCondition (const OnCondition_sequence &s)
	Copy elements from a given sequence. More...

Regime
Accessor and modifier functions for the Regime sequence element.
typedef ::neuroml2::Regime	Regime_type
	Element type.

typedef ::xsd::cxx::tree::sequence< Regime_type >	Regime_sequence
	Element sequence container type.

typedef Regime_sequence::iterator	Regime_iterator
	Element iterator type.

typedef Regime_sequence::const_iterator	Regime_const_iterator
	Element constant iterator type.

typedef ::xsd::cxx::tree::traits< Regime_type, char >	Regime_traits
	Element traits type.

const Regime_sequence &	Regime () const
	Return a read-only (constant) reference to the element sequence. More...

Regime_sequence &	Regime ()
	Return a read-write reference to the element sequence. More...

void	Regime (const Regime_sequence &s)
	Copy elements from a given sequence. More...

Constructors
	Dynamics ()
	Create an instance from the ultimate base and initializers for required elements and attributes.

	Dynamics (const ::xercesc::DOMElement &e, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
	Create an instance from a DOM element. More...

	Dynamics (const Dynamics &x, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
	Copy constructor. More...

virtual Dynamics *	_clone (::xml_schema::flags f=0, ::xml_schema::container *c=0) const
	Copy the instance polymorphically. More...

Dynamics &	operator= (const Dynamics &x)
	Copy assignment operator. More...

virtual	~Dynamics ()
	Destructor.

Detailed Description

Class corresponding to the Dynamics schema type.

LEMS ComponentType for Dynamics

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

Constructor & Destructor Documentation

◆ Dynamics() [1/2]

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

◆ Dynamics() [2/2]

neuroml2::Dynamics::Dynamics	(	const Dynamics &	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 20634 of file NeuroML_v2.3.cxx.

Member Function Documentation

◆ _clone()

Dynamics * neuroml2::Dynamics::_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.

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

◆ ConditionalDerivedVariable() [1/3]

Dynamics::ConditionalDerivedVariable_sequence & neuroml2::Dynamics::ConditionalDerivedVariable ( )

Return a read-write reference to the element sequence.

Returns: A reference to the sequence container.

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

◆ ConditionalDerivedVariable() [2/3]

const Dynamics::ConditionalDerivedVariable_sequence & neuroml2::Dynamics::ConditionalDerivedVariable ( ) const

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

Returns: A constant reference to the sequence container.

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

◆ ConditionalDerivedVariable() [3/3]

void neuroml2::Dynamics::ConditionalDerivedVariable ( const ConditionalDerivedVariable_sequence & s )

Copy elements from a given sequence.

Parameters

s	A 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 1012 of file NeuroML_v2.3.cxx.

◆ DerivedVariable() [1/3]

Dynamics::DerivedVariable_sequence & neuroml2::Dynamics::DerivedVariable ( )

Return a read-write reference to the element sequence.

Returns: A reference to the sequence container.

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

◆ DerivedVariable() [2/3]

const Dynamics::DerivedVariable_sequence & neuroml2::Dynamics::DerivedVariable ( ) const

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

Returns: A constant reference to the sequence container.

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

◆ DerivedVariable() [3/3]

void neuroml2::Dynamics::DerivedVariable ( const DerivedVariable_sequence & s )

Copy elements from a given sequence.

Parameters

s	A 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 994 of file NeuroML_v2.3.cxx.

◆ OnCondition() [1/3]

Dynamics::OnCondition_sequence & neuroml2::Dynamics::OnCondition ( )

Return a read-write reference to the element sequence.

Returns: A reference to the sequence container.

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

◆ OnCondition() [2/3]

const Dynamics::OnCondition_sequence & neuroml2::Dynamics::OnCondition ( ) const

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

Returns: A constant reference to the sequence container.

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

◆ OnCondition() [3/3]

void neuroml2::Dynamics::OnCondition ( const OnCondition_sequence & s )

Copy elements from a given sequence.

Parameters

s	A 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 1096 of file NeuroML_v2.3.cxx.

◆ OnEvent() [1/3]

Dynamics::OnEvent_sequence & neuroml2::Dynamics::OnEvent ( )

Return a read-write reference to the element sequence.

Returns: A reference to the sequence container.

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

◆ OnEvent() [2/3]

const Dynamics::OnEvent_sequence & neuroml2::Dynamics::OnEvent ( ) const

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

Returns: A constant reference to the sequence container.

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

◆ OnEvent() [3/3]

void neuroml2::Dynamics::OnEvent ( const OnEvent_sequence & s )

Copy elements from a given sequence.

Parameters

s	A 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 1078 of file NeuroML_v2.3.cxx.

◆ OnStart() [1/5]

Dynamics::OnStart_optional & neuroml2::Dynamics::OnStart ( )

Return a read-write reference to the element container.

Returns: A reference to the optional container.

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

◆ OnStart() [2/5]

const Dynamics::OnStart_optional & neuroml2::Dynamics::OnStart ( ) const

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

Returns: A constant reference to the optional container.

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

◆ OnStart() [3/5]

void neuroml2::Dynamics::OnStart ( ::std::unique_ptr< OnStart_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 1060 of file NeuroML_v2.3.cxx.

◆ OnStart() [4/5]

void neuroml2::Dynamics::OnStart ( const OnStart_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 1054 of file NeuroML_v2.3.cxx.

◆ OnStart() [5/5]

void neuroml2::Dynamics::OnStart ( const OnStart_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 1048 of file NeuroML_v2.3.cxx.

◆ operator=()

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

◆ Regime() [1/3]

Dynamics::Regime_sequence & neuroml2::Dynamics::Regime ( )

Return a read-write reference to the element sequence.

Returns: A reference to the sequence container.

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

◆ Regime() [2/3]

const Dynamics::Regime_sequence & neuroml2::Dynamics::Regime ( ) const

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

Returns: A constant reference to the sequence container.

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

◆ Regime() [3/3]

void neuroml2::Dynamics::Regime ( const Regime_sequence & s )

Copy elements from a given sequence.

Parameters

s	A 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 1114 of file NeuroML_v2.3.cxx.

◆ StateVariable() [1/3]

Dynamics::StateVariable_sequence & neuroml2::Dynamics::StateVariable ( )

Return a read-write reference to the element sequence.

Returns: A reference to the sequence container.

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

◆ StateVariable() [2/3]

const Dynamics::StateVariable_sequence & neuroml2::Dynamics::StateVariable ( ) const

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

Returns: A constant reference to the sequence container.

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

◆ StateVariable() [3/3]

void neuroml2::Dynamics::StateVariable ( const StateVariable_sequence & s )

Copy elements from a given sequence.

Parameters

s	A 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 976 of file NeuroML_v2.3.cxx.

◆ TimeDerivative() [1/3]

Dynamics::TimeDerivative_sequence & neuroml2::Dynamics::TimeDerivative ( )

Return a read-write reference to the element sequence.

Returns: A reference to the sequence container.

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

◆ TimeDerivative() [2/3]

const Dynamics::TimeDerivative_sequence & neuroml2::Dynamics::TimeDerivative ( ) const

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

Returns: A constant reference to the sequence container.

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

◆ TimeDerivative() [3/3]

void neuroml2::Dynamics::TimeDerivative ( const TimeDerivative_sequence & s )

Copy elements from a given sequence.

Parameters

s	A 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 1030 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

StateVariable

DerivedVariable

ConditionalDerivedVariable

TimeDerivative

OnStart

OnEvent

OnCondition

Regime

Constructors

Detailed Description

Constructor & Destructor Documentation

◆ Dynamics() [1/2]

◆ Dynamics() [2/2]

Member Function Documentation

◆ _clone()

◆ ConditionalDerivedVariable() [1/3]

◆ ConditionalDerivedVariable() [2/3]

◆ ConditionalDerivedVariable() [3/3]

◆ DerivedVariable() [1/3]

◆ DerivedVariable() [2/3]

◆ DerivedVariable() [3/3]

◆ OnCondition() [1/3]

◆ OnCondition() [2/3]

◆ OnCondition() [3/3]

◆ OnEvent() [1/3]

◆ OnEvent() [2/3]

◆ OnEvent() [3/3]

◆ OnStart() [1/5]

◆ OnStart() [2/5]

◆ OnStart() [3/5]

◆ OnStart() [4/5]

◆ OnStart() [5/5]

◆ operator=()

◆ Regime() [1/3]

◆ Regime() [2/3]

◆ Regime() [3/3]

◆ StateVariable() [1/3]

◆ StateVariable() [2/3]

◆ StateVariable() [3/3]

◆ TimeDerivative() [1/3]

◆ TimeDerivative() [2/3]

◆ TimeDerivative() [3/3]