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

#include <NeuroML_v2.3.hxx>

Inheritance diagram for neuroml2::GateKS:

Collaboration diagram for neuroml2::GateKS:

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

closedState
Accessor and modifier functions for the closedState sequence element.
typedef ::neuroml2::ClosedState	closedState_type
	Element type.

typedef ::xsd::cxx::tree::sequence< closedState_type >	closedState_sequence
	Element sequence container type.

typedef closedState_sequence::iterator	closedState_iterator
	Element iterator type.

typedef closedState_sequence::const_iterator	closedState_const_iterator
	Element constant iterator type.

typedef ::xsd::cxx::tree::traits< closedState_type, char >	closedState_traits
	Element traits type.

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

closedState_sequence &	closedState ()
	Return a read-write reference to the element sequence. More...

void	closedState (const closedState_sequence &s)
	Copy elements from a given sequence. More...

openState
Accessor and modifier functions for the openState sequence element.
typedef ::neuroml2::OpenState	openState_type
	Element type.

typedef ::xsd::cxx::tree::sequence< openState_type >	openState_sequence
	Element sequence container type.

typedef openState_sequence::iterator	openState_iterator
	Element iterator type.

typedef openState_sequence::const_iterator	openState_const_iterator
	Element constant iterator type.

typedef ::xsd::cxx::tree::traits< openState_type, char >	openState_traits
	Element traits type.

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

openState_sequence &	openState ()
	Return a read-write reference to the element sequence. More...

void	openState (const openState_sequence &s)
	Copy elements from a given sequence. More...

forwardTransition
Accessor and modifier functions for the forwardTransition sequence element.
typedef ::neuroml2::ForwardTransition	forwardTransition_type
	Element type.

typedef ::xsd::cxx::tree::sequence< forwardTransition_type >	forwardTransition_sequence
	Element sequence container type.

typedef forwardTransition_sequence::iterator	forwardTransition_iterator
	Element iterator type.

typedef forwardTransition_sequence::const_iterator	forwardTransition_const_iterator
	Element constant iterator type.

typedef ::xsd::cxx::tree::traits< forwardTransition_type, char >	forwardTransition_traits
	Element traits type.

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

forwardTransition_sequence &	forwardTransition ()
	Return a read-write reference to the element sequence. More...

void	forwardTransition (const forwardTransition_sequence &s)
	Copy elements from a given sequence. More...

reverseTransition
Accessor and modifier functions for the reverseTransition sequence element.
typedef ::neuroml2::ReverseTransition	reverseTransition_type
	Element type.

typedef ::xsd::cxx::tree::sequence< reverseTransition_type >	reverseTransition_sequence
	Element sequence container type.

typedef reverseTransition_sequence::iterator	reverseTransition_iterator
	Element iterator type.

typedef reverseTransition_sequence::const_iterator	reverseTransition_const_iterator
	Element constant iterator type.

typedef ::xsd::cxx::tree::traits< reverseTransition_type, char >	reverseTransition_traits
	Element traits type.

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

reverseTransition_sequence &	reverseTransition ()
	Return a read-write reference to the element sequence. More...

void	reverseTransition (const reverseTransition_sequence &s)
	Copy elements from a given sequence. More...

tauInfTransition
Accessor and modifier functions for the tauInfTransition sequence element.
typedef ::neuroml2::TauInfTransition	tauInfTransition_type
	Element type.

typedef ::xsd::cxx::tree::sequence< tauInfTransition_type >	tauInfTransition_sequence
	Element sequence container type.

typedef tauInfTransition_sequence::iterator	tauInfTransition_iterator
	Element iterator type.

typedef tauInfTransition_sequence::const_iterator	tauInfTransition_const_iterator
	Element constant iterator type.

typedef ::xsd::cxx::tree::traits< tauInfTransition_type, char >	tauInfTransition_traits
	Element traits type.

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

tauInfTransition_sequence &	tauInfTransition ()
	Return a read-write reference to the element sequence. More...

void	tauInfTransition (const tauInfTransition_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_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
	GateKS (const id_type &, const instances_type &)
	Create an instance from the ultimate base and initializers for required elements and attributes.

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

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

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

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

virtual	~GateKS ()
	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 GateKS schema type.

A gate which consists of multiple KSState s and KSTransition s giving the rates of transition between them
:param instances: :type instances: none

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

Constructor & Destructor Documentation

◆ GateKS() [1/2]

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

◆ GateKS() [2/2]

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

Member Function Documentation

◆ _clone()

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

◆ closedState() [1/3]

GateKS::closedState_sequence & neuroml2::GateKS::closedState ( )

Return a read-write reference to the element sequence.

Returns: A reference to the sequence container.

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

◆ closedState() [2/3]

const GateKS::closedState_sequence & neuroml2::GateKS::closedState ( ) const

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

Returns: A constant reference to the sequence container.

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

◆ closedState() [3/3]

void neuroml2::GateKS::closedState ( const closedState_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 4063 of file NeuroML_v2.3.cxx.

◆ forwardTransition() [1/3]

GateKS::forwardTransition_sequence & neuroml2::GateKS::forwardTransition ( )

Return a read-write reference to the element sequence.

Returns: A reference to the sequence container.

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

◆ forwardTransition() [2/3]

const GateKS::forwardTransition_sequence & neuroml2::GateKS::forwardTransition ( ) const

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

Returns: A constant reference to the sequence container.

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

◆ forwardTransition() [3/3]

void neuroml2::GateKS::forwardTransition ( const forwardTransition_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 4099 of file NeuroML_v2.3.cxx.

◆ instances() [1/4]

GateKS::instances_type & neuroml2::GateKS::instances ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ instances() [2/4]

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

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

Returns: A constant reference to the attribute.

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

◆ instances() [3/4]

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

◆ instances() [4/4]

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

◆ notes() [1/5]

GateKS::notes_optional & neuroml2::GateKS::notes ( )

Return a read-write reference to the element container.

Returns: A reference to the optional container.

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

◆ notes() [2/5]

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

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

Returns: A constant reference to the optional container.

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

◆ notes() [3/5]

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

◆ notes() [4/5]

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

◆ notes() [5/5]

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

◆ openState() [1/3]

GateKS::openState_sequence & neuroml2::GateKS::openState ( )

Return a read-write reference to the element sequence.

Returns: A reference to the sequence container.

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

◆ openState() [2/3]

const GateKS::openState_sequence & neuroml2::GateKS::openState ( ) const

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

Returns: A constant reference to the sequence container.

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

◆ openState() [3/3]

void neuroml2::GateKS::openState ( const openState_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 4081 of file NeuroML_v2.3.cxx.

◆ operator=()

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

◆ q10Settings() [1/5]

GateKS::q10Settings_optional & neuroml2::GateKS::q10Settings ( )

Return a read-write reference to the element container.

Returns: A reference to the optional container.

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

◆ q10Settings() [2/5]

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

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

Returns: A constant reference to the optional container.

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

◆ q10Settings() [3/5]

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

◆ q10Settings() [4/5]

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

◆ q10Settings() [5/5]

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

◆ reverseTransition() [1/3]

GateKS::reverseTransition_sequence & neuroml2::GateKS::reverseTransition ( )

Return a read-write reference to the element sequence.

Returns: A reference to the sequence container.

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

◆ reverseTransition() [2/3]

const GateKS::reverseTransition_sequence & neuroml2::GateKS::reverseTransition ( ) const

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

Returns: A constant reference to the sequence container.

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

◆ reverseTransition() [3/3]

void neuroml2::GateKS::reverseTransition ( const reverseTransition_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 4117 of file NeuroML_v2.3.cxx.

◆ tauInfTransition() [1/3]

GateKS::tauInfTransition_sequence & neuroml2::GateKS::tauInfTransition ( )

Return a read-write reference to the element sequence.

Returns: A reference to the sequence container.

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

◆ tauInfTransition() [2/3]

const GateKS::tauInfTransition_sequence & neuroml2::GateKS::tauInfTransition ( ) const

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

Returns: A constant reference to the sequence container.

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

◆ tauInfTransition() [3/3]

void neuroml2::GateKS::tauInfTransition ( const tauInfTransition_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 4135 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

notes

q10Settings

closedState

openState

forwardTransition

reverseTransition

tauInfTransition

instances

Constructors

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ GateKS() [1/2]

◆ GateKS() [2/2]

Member Function Documentation

◆ _clone()

◆ closedState() [1/3]

◆ closedState() [2/3]

◆ closedState() [3/3]

◆ forwardTransition() [1/3]

◆ forwardTransition() [2/3]

◆ forwardTransition() [3/3]

◆ instances() [1/4]

◆ instances() [2/4]

◆ instances() [3/4]

◆ instances() [4/4]

◆ notes() [1/5]

◆ notes() [2/5]

◆ notes() [3/5]

◆ notes() [4/5]

◆ notes() [5/5]

◆ openState() [1/3]

◆ openState() [2/3]

◆ openState() [3/3]

◆ operator=()

◆ q10Settings() [1/5]

◆ q10Settings() [2/5]

◆ q10Settings() [3/5]

◆ q10Settings() [4/5]

◆ q10Settings() [5/5]

◆ reverseTransition() [1/3]

◆ reverseTransition() [2/3]

◆ reverseTransition() [3/3]

◆ tauInfTransition() [1/3]

◆ tauInfTransition() [2/3]

◆ tauInfTransition() [3/3]