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

#include <NeuroML_v2.3.hxx>

Inheritance diagram for neuroml2::Regime:

Collaboration diagram for neuroml2::Regime:

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

OnEntry
Accessor and modifier functions for the OnEntry optional element.
typedef ::neuroml2::OnEntry	OnEntry_type
	Element type.

typedef ::xsd::cxx::tree::optional< OnEntry_type >	OnEntry_optional
	Element optional container type.

typedef ::xsd::cxx::tree::traits< OnEntry_type, char >	OnEntry_traits
	Element traits type.

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

OnEntry_optional &	OnEntry ()
	Return a read-write reference to the element container. More...

void	OnEntry (const OnEntry_type &x)
	Set the element value. More...

void	OnEntry (const OnEntry_optional &x)
	Set the element value. More...

void	OnEntry (::std::unique_ptr< OnEntry_type > p)
	Set the element value without copying. 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...

name
Accessor and modifier functions for the name required attribute.
typedef ::xml_schema::string	name_type
	Attribute type.

typedef ::xsd::cxx::tree::traits< name_type, char >	name_traits
	Attribute traits type.

const name_type &	name () const
	Return a read-only (constant) reference to the attribute. More...

name_type &	name ()
	Return a read-write reference to the attribute. More...

void	name (const name_type &x)
	Set the attribute value. More...

void	name (::std::unique_ptr< name_type > p)
	Set the attribute value without copying. More...

initial
Accessor and modifier functions for the initial optional attribute.
typedef ::neuroml2::TrueOrFalse	initial_type
	Attribute type.

typedef ::xsd::cxx::tree::optional< initial_type >	initial_optional
	Attribute optional container type.

typedef ::xsd::cxx::tree::traits< initial_type, char >	initial_traits
	Attribute traits type.

const initial_optional &	initial () const
	Return a read-only (constant) reference to the attribute container. More...

initial_optional &	initial ()
	Return a read-write reference to the attribute container. More...

void	initial (const initial_type &x)
	Set the attribute value. More...

void	initial (const initial_optional &x)
	Set the attribute value. More...

void	initial (::std::unique_ptr< initial_type > p)
	Set the attribute value without copying. More...

Constructors
	Regime (const name_type &)
	Create an instance from the ultimate base and initializers for required elements and attributes.

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

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

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

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

virtual	~Regime ()
	Destructor.

Detailed Description

Class corresponding to the Regime schema type.

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

Constructor & Destructor Documentation

◆ Regime() [1/2]

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

◆ Regime() [2/2]

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

Member Function Documentation

◆ _clone()

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

◆ initial() [1/5]

Regime::initial_optional & neuroml2::Regime::initial ( )

Return a read-write reference to the attribute container.

Returns: A reference to the optional container.

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

◆ initial() [2/5]

const Regime::initial_optional & neuroml2::Regime::initial ( ) const

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

Returns: A constant reference to the optional container.

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

◆ initial() [3/5]

void neuroml2::Regime::initial ( ::std::unique_ptr< initial_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 1726 of file NeuroML_v2.3.cxx.

◆ initial() [4/5]

void neuroml2::Regime::initial ( const initial_optional & x )

Set the attribute 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 attribute. Otherwise the attribute container is set the 'not present' state.

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

◆ initial() [5/5]

void neuroml2::Regime::initial ( const initial_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 1714 of file NeuroML_v2.3.cxx.

◆ name() [1/4]

Regime::name_type & neuroml2::Regime::name ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ name() [2/4]

const Regime::name_type & neuroml2::Regime::name ( ) const

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

Returns: A constant reference to the attribute.

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

◆ name() [3/4]

void neuroml2::Regime::name ( ::std::unique_ptr< name_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 1696 of file NeuroML_v2.3.cxx.

◆ name() [4/4]

void neuroml2::Regime::name ( const name_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 1690 of file NeuroML_v2.3.cxx.

◆ OnCondition() [1/3]

Regime::OnCondition_sequence & neuroml2::Regime::OnCondition ( )

Return a read-write reference to the element sequence.

Returns: A reference to the sequence container.

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

◆ OnCondition() [2/3]

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

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

Returns: A constant reference to the sequence container.

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

◆ OnCondition() [3/3]

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

◆ OnEntry() [1/5]

Regime::OnEntry_optional & neuroml2::Regime::OnEntry ( )

Return a read-write reference to the element container.

Returns: A reference to the optional container.

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

◆ OnEntry() [2/5]

const Regime::OnEntry_optional & neuroml2::Regime::OnEntry ( ) const

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

Returns: A constant reference to the optional container.

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

◆ OnEntry() [3/5]

void neuroml2::Regime::OnEntry ( ::std::unique_ptr< OnEntry_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 1654 of file NeuroML_v2.3.cxx.

◆ OnEntry() [4/5]

void neuroml2::Regime::OnEntry ( const OnEntry_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 1648 of file NeuroML_v2.3.cxx.

◆ OnEntry() [5/5]

void neuroml2::Regime::OnEntry ( const OnEntry_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 1642 of file NeuroML_v2.3.cxx.

◆ operator=()

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

◆ TimeDerivative() [1/3]

Regime::TimeDerivative_sequence & neuroml2::Regime::TimeDerivative ( )

Return a read-write reference to the element sequence.

Returns: A reference to the sequence container.

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

◆ TimeDerivative() [2/3]

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

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

Returns: A constant reference to the sequence container.

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

◆ TimeDerivative() [3/3]

void neuroml2::Regime::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 1624 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

TimeDerivative

OnEntry

OnCondition

name

initial

Constructors

Detailed Description

Constructor & Destructor Documentation

◆ Regime() [1/2]

◆ Regime() [2/2]

Member Function Documentation

◆ _clone()

◆ initial() [1/5]

◆ initial() [2/5]

◆ initial() [3/5]

◆ initial() [4/5]

◆ initial() [5/5]

◆ name() [1/4]

◆ name() [2/4]

◆ name() [3/4]

◆ name() [4/4]

◆ OnCondition() [1/3]

◆ OnCondition() [2/3]

◆ OnCondition() [3/3]

◆ OnEntry() [1/5]

◆ OnEntry() [2/5]

◆ OnEntry() [3/5]

◆ OnEntry() [4/5]

◆ OnEntry() [5/5]

◆ operator=()

◆ TimeDerivative() [1/3]

◆ TimeDerivative() [2/3]

◆ TimeDerivative() [3/3]