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

#include <NeuroML_v2.3.hxx>

Inheritance diagram for neuroml2::Species:

Collaboration diagram for neuroml2::Species:

concentrationModel
Accessor and modifier functions for the concentrationModel required attribute.
typedef ::neuroml2::NmlId	concentrationModel_type
	Attribute type.

typedef ::xsd::cxx::tree::traits< concentrationModel_type, char >	concentrationModel_traits
	Attribute traits type.

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

concentrationModel_type &	concentrationModel ()
	Return a read-write reference to the attribute. More...

void	concentrationModel (const concentrationModel_type &x)
	Set the attribute value. More...

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

ion
Accessor and modifier functions for the ion optional attribute.
typedef ::neuroml2::NmlId	ion_type
	Attribute type.

typedef ::xsd::cxx::tree::optional< ion_type >	ion_optional
	Attribute optional container type.

typedef ::xsd::cxx::tree::traits< ion_type, char >	ion_traits
	Attribute traits type.

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

ion_optional &	ion ()
	Return a read-write reference to the attribute container. More...

void	ion (const ion_type &x)
	Set the attribute value. More...

void	ion (const ion_optional &x)
	Set the attribute value. More...

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

initialConcentration
Accessor and modifier functions for the initialConcentration required attribute.
typedef ::neuroml2::Nml2Quantity_concentration	initialConcentration_type
	Attribute type.

typedef ::xsd::cxx::tree::traits< initialConcentration_type, char >	initialConcentration_traits
	Attribute traits type.

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

initialConcentration_type &	initialConcentration ()
	Return a read-write reference to the attribute. More...

void	initialConcentration (const initialConcentration_type &x)
	Set the attribute value. More...

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

initialExtConcentration
Accessor and modifier functions for the initialExtConcentration required attribute.
typedef ::neuroml2::Nml2Quantity_concentration	initialExtConcentration_type
	Attribute type.

typedef ::xsd::cxx::tree::traits< initialExtConcentration_type, char >	initialExtConcentration_traits
	Attribute traits type.

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

initialExtConcentration_type &	initialExtConcentration ()
	Return a read-write reference to the attribute. More...

void	initialExtConcentration (const initialExtConcentration_type &x)
	Set the attribute value. More...

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

segmentGroup
Accessor and modifier functions for the segmentGroup optional attribute with a default value.
typedef ::neuroml2::NmlId	segmentGroup_type
	Attribute type.

typedef ::xsd::cxx::tree::traits< segmentGroup_type, char >	segmentGroup_traits
	Attribute traits type.

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

segmentGroup_type &	segmentGroup ()
	Return a read-write reference to the attribute. More...

void	segmentGroup (const segmentGroup_type &x)
	Set the attribute value. More...

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

static const segmentGroup_type &	segmentGroup_default_value ()
	Return the default value for the attribute. More...

Constructors
	Species (const id_type &, const concentrationModel_type &, const initialConcentration_type &, const initialExtConcentration_type &)
	Create an instance from the ultimate base and initializers for required elements and attributes.

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

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

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

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

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

Description of a chemical species identified by ion, which has internal, concentration, and external, extConcentration values for its concentration
:param initialConcentration: :type initialConcentration: concentration :param initialExtConcentration: :type initialExtConcentration: concentration

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

Constructor & Destructor Documentation

◆ Species() [1/2]

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

◆ Species() [2/2]

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

Member Function Documentation

◆ _clone()

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

◆ concentrationModel() [1/4]

Species::concentrationModel_type & neuroml2::Species::concentrationModel ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ concentrationModel() [2/4]

const Species::concentrationModel_type & neuroml2::Species::concentrationModel ( ) const

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

Returns: A constant reference to the attribute.

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

◆ concentrationModel() [3/4]

void neuroml2::Species::concentrationModel ( ::std::unique_ptr< concentrationModel_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 12192 of file NeuroML_v2.3.cxx.

◆ concentrationModel() [4/4]

void neuroml2::Species::concentrationModel ( const concentrationModel_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 12186 of file NeuroML_v2.3.cxx.

◆ initialConcentration() [1/4]

Species::initialConcentration_type & neuroml2::Species::initialConcentration ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ initialConcentration() [2/4]

const Species::initialConcentration_type & neuroml2::Species::initialConcentration ( ) const

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

Returns: A constant reference to the attribute.

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

◆ initialConcentration() [3/4]

void neuroml2::Species::initialConcentration ( ::std::unique_ptr< initialConcentration_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 12246 of file NeuroML_v2.3.cxx.

◆ initialConcentration() [4/4]

void neuroml2::Species::initialConcentration ( const initialConcentration_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 12240 of file NeuroML_v2.3.cxx.

◆ initialExtConcentration() [1/4]

Species::initialExtConcentration_type & neuroml2::Species::initialExtConcentration ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ initialExtConcentration() [2/4]

const Species::initialExtConcentration_type & neuroml2::Species::initialExtConcentration ( ) const

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

Returns: A constant reference to the attribute.

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

◆ initialExtConcentration() [3/4]

void neuroml2::Species::initialExtConcentration ( ::std::unique_ptr< initialExtConcentration_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 12270 of file NeuroML_v2.3.cxx.

◆ initialExtConcentration() [4/4]

void neuroml2::Species::initialExtConcentration ( const initialExtConcentration_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 12264 of file NeuroML_v2.3.cxx.

◆ ion() [1/5]

Species::ion_optional & neuroml2::Species::ion ( )

Return a read-write reference to the attribute container.

Returns: A reference to the optional container.

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

◆ ion() [2/5]

const Species::ion_optional & neuroml2::Species::ion ( ) const

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

Returns: A constant reference to the optional container.

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

◆ ion() [3/5]

void neuroml2::Species::ion ( ::std::unique_ptr< ion_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 12222 of file NeuroML_v2.3.cxx.

◆ ion() [4/5]

void neuroml2::Species::ion ( const ion_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 12216 of file NeuroML_v2.3.cxx.

◆ ion() [5/5]

void neuroml2::Species::ion ( const ion_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 12210 of file NeuroML_v2.3.cxx.

◆ operator=()

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

◆ segmentGroup() [1/4]

Species::segmentGroup_type & neuroml2::Species::segmentGroup ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ segmentGroup() [2/4]

const Species::segmentGroup_type & neuroml2::Species::segmentGroup ( ) const

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

Returns: A constant reference to the attribute.

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

◆ segmentGroup() [3/4]

void neuroml2::Species::segmentGroup ( ::std::unique_ptr< segmentGroup_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 12294 of file NeuroML_v2.3.cxx.

◆ segmentGroup() [4/4]

void neuroml2::Species::segmentGroup ( const segmentGroup_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 12288 of file NeuroML_v2.3.cxx.

◆ segmentGroup_default_value()

const Species::segmentGroup_type & neuroml2::Species::segmentGroup_default_value ( )

static

Return the default value for the attribute.

Returns: A read-only (constant) reference to the attribute's default value.

Definition at line 12300 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

concentrationModel

ion

initialConcentration

initialExtConcentration

segmentGroup

Constructors

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Species() [1/2]

◆ Species() [2/2]

Member Function Documentation

◆ _clone()

◆ concentrationModel() [1/4]

◆ concentrationModel() [2/4]

◆ concentrationModel() [3/4]

◆ concentrationModel() [4/4]

◆ initialConcentration() [1/4]

◆ initialConcentration() [2/4]

◆ initialConcentration() [3/4]

◆ initialConcentration() [4/4]

◆ initialExtConcentration() [1/4]

◆ initialExtConcentration() [2/4]

◆ initialExtConcentration() [3/4]

◆ initialExtConcentration() [4/4]

◆ ion() [1/5]

◆ ion() [2/5]

◆ ion() [3/5]

◆ ion() [4/5]

◆ ion() [5/5]

◆ operator=()

◆ segmentGroup() [1/4]

◆ segmentGroup() [2/4]

◆ segmentGroup() [3/4]

◆ segmentGroup() [4/4]

◆ segmentGroup_default_value()