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

#include <NeuroML_v2.3.hxx>

Inheritance diagram for neuroml2::ChannelDensityNonUniform:

Collaboration diagram for neuroml2::ChannelDensityNonUniform:

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

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

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

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

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

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

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

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

Specifies a time varying ohmic conductance density, which is distributed on a region of the cell. The conductance density of the channel is not uniform, but is set using the variableParameter . Note, there is no dynamical description of this in LEMS yet, as this type only makes sense for multicompartmental cells. A ComponentType for this needs to be present to enable export of NeuroML 2 multicompartmental cells via LEMS/jNeuroML to NEURON
:param erev: The reversal potential of the current produced :type erev: voltage

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

Constructor & Destructor Documentation

◆ ChannelDensityNonUniform() [1/2]

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

◆ ChannelDensityNonUniform() [2/2]

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

Member Function Documentation

◆ _clone()

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

◆ erev() [1/4]

ChannelDensityNonUniform::erev_type & neuroml2::ChannelDensityNonUniform::erev ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ erev() [2/4]

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

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

Returns: A constant reference to the attribute.

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

◆ erev() [3/4]

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

◆ erev() [4/4]

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

◆ ion() [1/4]

ChannelDensityNonUniform::ion_type & neuroml2::ChannelDensityNonUniform::ion ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ ion() [2/4]

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

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

Returns: A constant reference to the attribute.

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

◆ ion() [3/4]

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

◆ ion() [4/4]

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

◆ ionChannel() [1/4]

ChannelDensityNonUniform::ionChannel_type & neuroml2::ChannelDensityNonUniform::ionChannel ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ ionChannel() [2/4]

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

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

Returns: A constant reference to the attribute.

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

◆ ionChannel() [3/4]

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

◆ ionChannel() [4/4]

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

◆ operator=()

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

◆ variableParameter() [1/3]

ChannelDensityNonUniform::variableParameter_sequence & neuroml2::ChannelDensityNonUniform::variableParameter ( )

Return a read-write reference to the element sequence.

Returns: A reference to the sequence container.

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

◆ variableParameter() [2/3]

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

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

Returns: A constant reference to the sequence container.

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

◆ variableParameter() [3/3]

void neuroml2::ChannelDensityNonUniform::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 11164 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

erev

ion

Constructors

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ChannelDensityNonUniform() [1/2]

◆ ChannelDensityNonUniform() [2/2]

Member Function Documentation

◆ _clone()

◆ 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=()

◆ variableParameter() [1/3]

◆ variableParameter() [2/3]

◆ variableParameter() [3/3]