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

#include <NeuroML_v2.3.hxx>

Inheritance diagram for neuroml2::ChannelDensity:

Collaboration diagram for neuroml2::ChannelDensity:

variableParameter
Accessor and modifier functions for the variableParameter sequence element.
typedef ::neuroml2::VariableParameter	variableParameter_type
	Element type.

typedef ::xsd::cxx::tree::sequence< variableParameter_type >	variableParameter_sequence
	Element sequence container type.

typedef variableParameter_sequence::iterator	variableParameter_iterator
	Element iterator type.

typedef variableParameter_sequence::const_iterator	variableParameter_const_iterator
	Element constant iterator type.

typedef ::xsd::cxx::tree::traits< variableParameter_type, char >	variableParameter_traits
	Element traits type.

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

variableParameter_sequence &	variableParameter ()
	Return a read-write reference to the element sequence. More...

void	variableParameter (const variableParameter_sequence &s)
	Copy elements from a given sequence. More...

ionChannel
Accessor and modifier functions for the ionChannel required attribute.
typedef ::neuroml2::NmlId	ionChannel_type
	Attribute type.

typedef ::xsd::cxx::tree::traits< ionChannel_type, char >	ionChannel_traits
	Attribute traits type.

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

ionChannel_type &	ionChannel ()
	Return a read-write reference to the attribute. More...

void	ionChannel (const ionChannel_type &x)
	Set the attribute value. More...

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

condDensity
Accessor and modifier functions for the condDensity optional attribute.
typedef ::neuroml2::Nml2Quantity_conductanceDensity	condDensity_type
	Attribute type.

typedef ::xsd::cxx::tree::optional< condDensity_type >	condDensity_optional
	Attribute optional container type.

typedef ::xsd::cxx::tree::traits< condDensity_type, char >	condDensity_traits
	Attribute traits type.

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

condDensity_optional &	condDensity ()
	Return a read-write reference to the attribute container. More...

void	condDensity (const condDensity_type &x)
	Set the attribute value. More...

void	condDensity (const condDensity_optional &x)
	Set the attribute value. More...

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

erev
Accessor and modifier functions for the erev required attribute.
typedef ::neuroml2::Nml2Quantity_voltage	erev_type
	Attribute type.

typedef ::xsd::cxx::tree::traits< erev_type, char >	erev_traits
	Attribute traits type.

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

erev_type &	erev ()
	Return a read-write reference to the attribute. More...

void	erev (const erev_type &x)
	Set the attribute value. More...

void	erev (::std::unique_ptr< erev_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...

segment
Accessor and modifier functions for the segment optional attribute.
typedef ::neuroml2::NonNegativeInteger	segment_type
	Attribute type.

typedef ::xsd::cxx::tree::optional< segment_type >	segment_optional
	Attribute optional container type.

typedef ::xsd::cxx::tree::traits< segment_type, char >	segment_traits
	Attribute traits type.

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

segment_optional &	segment ()
	Return a read-write reference to the attribute container. More...

void	segment (const segment_type &x)
	Set the attribute value. More...

void	segment (const segment_optional &x)
	Set the attribute value. More...

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

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

Constructors
	ChannelDensity (const id_type &, const ionChannel_type &, const erev_type &, const ion_type &)
	Create an instance from the ultimate base and initializers for required elements and attributes.

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

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

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

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

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

Specifies a time varying ohmic conductance density, gDensity, which is distributed on an area of the cell ( specified in membraneProperties ) with fixed reversal potential erev producing a current density iDensity
:param erev: The reversal potential of the current produced :type erev: voltage :param condDensity: :type condDensity: conductanceDensity

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

Constructor & Destructor Documentation

◆ ChannelDensity() [1/2]

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

◆ ChannelDensity() [2/2]

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

Member Function Documentation

◆ _clone()

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

Reimplemented in neuroml2::ChannelDensityVShift.

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

◆ condDensity() [1/5]

ChannelDensity::condDensity_optional & neuroml2::ChannelDensity::condDensity ( )

Return a read-write reference to the attribute container.

Returns: A reference to the optional container.

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

◆ condDensity() [2/5]

const ChannelDensity::condDensity_optional & neuroml2::ChannelDensity::condDensity ( ) const

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

Returns: A constant reference to the optional container.

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

◆ condDensity() [3/5]

void neuroml2::ChannelDensity::condDensity ( ::std::unique_ptr< condDensity_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 11452 of file NeuroML_v2.3.cxx.

◆ condDensity() [4/5]

void neuroml2::ChannelDensity::condDensity ( const condDensity_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 11446 of file NeuroML_v2.3.cxx.

◆ condDensity() [5/5]

void neuroml2::ChannelDensity::condDensity ( const condDensity_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 11440 of file NeuroML_v2.3.cxx.

◆ erev() [1/4]

ChannelDensity::erev_type & neuroml2::ChannelDensity::erev ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ erev() [2/4]

const ChannelDensity::erev_type & neuroml2::ChannelDensity::erev ( ) const

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

Returns: A constant reference to the attribute.

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

◆ erev() [3/4]

void neuroml2::ChannelDensity::erev ( ::std::unique_ptr< erev_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 11476 of file NeuroML_v2.3.cxx.

◆ erev() [4/4]

void neuroml2::ChannelDensity::erev ( const erev_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 11470 of file NeuroML_v2.3.cxx.

◆ ion() [1/4]

ChannelDensity::ion_type & neuroml2::ChannelDensity::ion ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ ion() [2/4]

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

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

Returns: A constant reference to the attribute.

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

◆ ion() [3/4]

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

◆ ion() [4/4]

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

◆ ionChannel() [1/4]

ChannelDensity::ionChannel_type & neuroml2::ChannelDensity::ionChannel ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ ionChannel() [2/4]

const ChannelDensity::ionChannel_type & neuroml2::ChannelDensity::ionChannel ( ) const

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

Returns: A constant reference to the attribute.

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

◆ ionChannel() [3/4]

void neuroml2::ChannelDensity::ionChannel ( ::std::unique_ptr< ionChannel_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 11422 of file NeuroML_v2.3.cxx.

◆ ionChannel() [4/4]

void neuroml2::ChannelDensity::ionChannel ( const ionChannel_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 11416 of file NeuroML_v2.3.cxx.

◆ operator=()

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

◆ segment() [1/5]

ChannelDensity::segment_optional & neuroml2::ChannelDensity::segment ( )

Return a read-write reference to the attribute container.

Returns: A reference to the optional container.

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

◆ segment() [2/5]

const ChannelDensity::segment_optional & neuroml2::ChannelDensity::segment ( ) const

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

Returns: A constant reference to the optional container.

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

◆ segment() [3/5]

void neuroml2::ChannelDensity::segment ( ::std::unique_ptr< segment_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 11536 of file NeuroML_v2.3.cxx.

◆ segment() [4/5]

void neuroml2::ChannelDensity::segment ( const segment_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 11530 of file NeuroML_v2.3.cxx.

◆ segment() [5/5]

void neuroml2::ChannelDensity::segment ( const segment_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 11524 of file NeuroML_v2.3.cxx.

◆ segmentGroup() [1/4]

ChannelDensity::segmentGroup_type & neuroml2::ChannelDensity::segmentGroup ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ segmentGroup() [2/4]

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

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

Returns: A constant reference to the attribute.

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

◆ segmentGroup() [3/4]

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

◆ segmentGroup() [4/4]

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

◆ segmentGroup_default_value()

const ChannelDensity::segmentGroup_type & neuroml2::ChannelDensity::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 11506 of file NeuroML_v2.3.cxx.

◆ variableParameter() [1/3]

ChannelDensity::variableParameter_sequence & neuroml2::ChannelDensity::variableParameter ( )

Return a read-write reference to the element sequence.

Returns: A reference to the sequence container.

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

◆ variableParameter() [2/3]

const ChannelDensity::variableParameter_sequence & neuroml2::ChannelDensity::variableParameter ( ) const

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

Returns: A constant reference to the sequence container.

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

◆ variableParameter() [3/3]

void neuroml2::ChannelDensity::variableParameter ( const variableParameter_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 11398 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

variableParameter

ionChannel

condDensity

erev

segmentGroup

segment

ion

Constructors

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ChannelDensity() [1/2]

◆ ChannelDensity() [2/2]

Member Function Documentation

◆ _clone()

◆ condDensity() [1/5]

◆ condDensity() [2/5]

◆ condDensity() [3/5]

◆ condDensity() [4/5]

◆ condDensity() [5/5]

◆ erev() [1/4]

◆ erev() [2/4]

◆ erev() [3/4]

◆ erev() [4/4]

◆ ion() [1/4]

◆ ion() [2/4]

◆ ion() [3/4]

◆ ion() [4/4]

◆ ionChannel() [1/4]

◆ ionChannel() [2/4]

◆ ionChannel() [3/4]

◆ ionChannel() [4/4]

◆ operator=()

◆ segment() [1/5]

◆ segment() [2/5]

◆ segment() [3/5]

◆ segment() [4/5]

◆ segment() [5/5]

◆ segmentGroup() [1/4]

◆ segmentGroup() [2/4]

◆ segmentGroup() [3/4]

◆ segmentGroup() [4/4]

◆ segmentGroup_default_value()

◆ variableParameter() [1/3]

◆ variableParameter() [2/3]

◆ variableParameter() [3/3]