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

#include <NeuroML_v2.3.hxx>

Inheritance diagram for neuroml2::FixedFactorConcentrationModel:

Collaboration diagram for neuroml2::FixedFactorConcentrationModel:

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

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

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

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

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

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

restingConc
Accessor and modifier functions for the restingConc required attribute.
typedef ::neuroml2::Nml2Quantity_concentration	restingConc_type
	Attribute type.

typedef ::xsd::cxx::tree::traits< restingConc_type, char >	restingConc_traits
	Attribute traits type.

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

restingConc_type &	restingConc ()
	Return a read-write reference to the attribute. More...

void	restingConc (const restingConc_type &x)
	Set the attribute value. More...

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

decayConstant
Accessor and modifier functions for the decayConstant required attribute.
typedef ::neuroml2::Nml2Quantity_time	decayConstant_type
	Attribute type.

typedef ::xsd::cxx::tree::traits< decayConstant_type, char >	decayConstant_traits
	Attribute traits type.

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

decayConstant_type &	decayConstant ()
	Return a read-write reference to the attribute. More...

void	decayConstant (const decayConstant_type &x)
	Set the attribute value. More...

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

rho
Accessor and modifier functions for the rho required attribute.
typedef ::neuroml2::Nml2Quantity_rhoFactor	rho_type
	Attribute type.

typedef ::xsd::cxx::tree::traits< rho_type, char >	rho_traits
	Attribute traits type.

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

rho_type &	rho ()
	Return a read-write reference to the attribute. More...

void	rho (const rho_type &x)
	Set the attribute value. More...

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

Constructors
	FixedFactorConcentrationModel (const id_type &, const ion_type &, const restingConc_type &, const decayConstant_type &, const rho_type &)
	Create an instance from the ultimate base and initializers for required elements and attributes.

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

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

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

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

virtual	~FixedFactorConcentrationModel ()
	Destructor.

Additional Inherited Members
Public Types inherited from neuroml2::Standalone
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.

typedef ::neuroml2::Property	property_type
	Element type.

typedef ::xsd::cxx::tree::sequence< property_type >	property_sequence
	Element sequence container type.

typedef property_sequence::iterator	property_iterator
	Element iterator type.

typedef property_sequence::const_iterator	property_const_iterator
	Element constant iterator type.

typedef ::xsd::cxx::tree::traits< property_type, char >	property_traits
	Element traits type.

typedef ::neuroml2::Annotation	annotation_type
	Element type.

typedef ::xsd::cxx::tree::optional< annotation_type >	annotation_optional
	Element optional container type.

typedef ::xsd::cxx::tree::traits< annotation_type, char >	annotation_traits
	Element traits type.

typedef ::neuroml2::MetaId	metaid_type
	Attribute type.

typedef ::xsd::cxx::tree::optional< metaid_type >	metaid_optional
	Attribute optional container type.

typedef ::xsd::cxx::tree::traits< metaid_type, char >	metaid_traits
	Attribute traits type.

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

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

property_sequence &	property ()
	Return a read-write reference to the element sequence. More...

void	property (const property_sequence &s)
	Copy elements from a given sequence. More...

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

annotation_optional &	annotation ()
	Return a read-write reference to the element container. More...

void	annotation (const annotation_type &x)
	Set the element value. More...

void	annotation (const annotation_optional &x)
	Set the element value. More...

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

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

metaid_optional &	metaid ()
	Return a read-write reference to the attribute container. More...

void	metaid (const metaid_type &x)
	Set the attribute value. More...

void	metaid (const metaid_optional &x)
	Set the attribute value. More...

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

	Standalone (const id_type &)
	Create an instance from the ultimate base and initializers for required elements and attributes.

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

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

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

virtual	~Standalone ()
	Destructor.

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 FixedFactorConcentrationModel schema type.

Model of buffering of concentration of an ion ( currently hard coded to be calcium, due to requirement for iCa ) which has a baseline level restingConc and tends to this value with time course decayConstant. A fixed factor rho is used to scale the incoming current independently of the size of the compartment to produce a concentration change.
:param restingConc: :type restingConc: concentration :param decayConstant: :type decayConstant: time :param rho: :type rho: rho_factor

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

Constructor & Destructor Documentation

◆ FixedFactorConcentrationModel() [1/2]

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

◆ FixedFactorConcentrationModel() [2/2]

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

Member Function Documentation

◆ _clone()

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

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

◆ decayConstant() [1/4]

FixedFactorConcentrationModel::decayConstant_type & neuroml2::FixedFactorConcentrationModel::decayConstant ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ decayConstant() [2/4]

const FixedFactorConcentrationModel::decayConstant_type & neuroml2::FixedFactorConcentrationModel::decayConstant ( ) const

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

Returns: A constant reference to the attribute.

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

◆ decayConstant() [3/4]

void neuroml2::FixedFactorConcentrationModel::decayConstant ( ::std::unique_ptr< decayConstant_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 6181 of file NeuroML_v2.3.cxx.

◆ decayConstant() [4/4]

void neuroml2::FixedFactorConcentrationModel::decayConstant ( const decayConstant_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 6175 of file NeuroML_v2.3.cxx.

◆ ion() [1/4]

FixedFactorConcentrationModel::ion_type & neuroml2::FixedFactorConcentrationModel::ion ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ ion() [2/4]

const FixedFactorConcentrationModel::ion_type & neuroml2::FixedFactorConcentrationModel::ion ( ) const

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

Returns: A constant reference to the attribute.

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

◆ ion() [3/4]

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

◆ ion() [4/4]

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

◆ operator=()

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

◆ restingConc() [1/4]

FixedFactorConcentrationModel::restingConc_type & neuroml2::FixedFactorConcentrationModel::restingConc ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ restingConc() [2/4]

const FixedFactorConcentrationModel::restingConc_type & neuroml2::FixedFactorConcentrationModel::restingConc ( ) const

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

Returns: A constant reference to the attribute.

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

◆ restingConc() [3/4]

void neuroml2::FixedFactorConcentrationModel::restingConc ( ::std::unique_ptr< restingConc_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 6157 of file NeuroML_v2.3.cxx.

◆ restingConc() [4/4]

void neuroml2::FixedFactorConcentrationModel::restingConc ( const restingConc_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 6151 of file NeuroML_v2.3.cxx.

◆ rho() [1/4]

FixedFactorConcentrationModel::rho_type & neuroml2::FixedFactorConcentrationModel::rho ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ rho() [2/4]

const FixedFactorConcentrationModel::rho_type & neuroml2::FixedFactorConcentrationModel::rho ( ) const

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

Returns: A constant reference to the attribute.

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

◆ rho() [3/4]

void neuroml2::FixedFactorConcentrationModel::rho ( ::std::unique_ptr< rho_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 6205 of file NeuroML_v2.3.cxx.

◆ rho() [4/4]

void neuroml2::FixedFactorConcentrationModel::rho ( const rho_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 6199 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

ion

restingConc

decayConstant

rho

Constructors

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FixedFactorConcentrationModel() [1/2]

◆ FixedFactorConcentrationModel() [2/2]

Member Function Documentation

◆ _clone()

◆ decayConstant() [1/4]

◆ decayConstant() [2/4]

◆ decayConstant() [3/4]

◆ decayConstant() [4/4]

◆ ion() [1/4]

◆ ion() [2/4]

◆ ion() [3/4]

◆ ion() [4/4]

◆ operator=()

◆ restingConc() [1/4]

◆ restingConc() [2/4]

◆ restingConc() [3/4]

◆ restingConc() [4/4]

◆ rho() [1/4]

◆ rho() [2/4]

◆ rho() [3/4]

◆ rho() [4/4]