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

#include <NeuroML_v2.3.hxx>

Inheritance diagram for neuroml2::ChannelDensityVShift:

Collaboration diagram for neuroml2::ChannelDensityVShift:

vShift
Accessor and modifier functions for the vShift required attribute.
typedef ::neuroml2::Nml2Quantity_voltage	vShift_type
	Attribute type.

typedef ::xsd::cxx::tree::traits< vShift_type, char >	vShift_traits
	Attribute traits type.

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

vShift_type &	vShift ()
	Return a read-write reference to the attribute. More...

void	vShift (const vShift_type &x)
	Set the attribute value. More...

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

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

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

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

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

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

virtual	~ChannelDensityVShift ()
	Destructor.

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

typedef ::neuroml2::NmlId	ionChannel_type
	Attribute type.

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

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.

typedef ::neuroml2::Nml2Quantity_voltage	erev_type
	Attribute type.

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

typedef ::neuroml2::NmlId	segmentGroup_type
	Attribute type.

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

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.

typedef ::neuroml2::NmlId	ion_type
	Attribute type.

typedef ::xsd::cxx::tree::traits< ion_type, char >	ion_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::ChannelDensity
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...

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

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

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

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

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

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

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

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

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

Static Public Member Functions inherited from neuroml2::ChannelDensity
static const segmentGroup_type &	segmentGroup_default_value ()
	Return the default value for the attribute. More...

Detailed Description

Class corresponding to the ChannelDensityVShift schema type.

Same as channelDensity , but with a vShift parameter to change voltage activation of gates. The exact usage of vShift in expressions for rates is determined by the individual gates.
:param vShift: :type vShift: voltage :param erev: The reversal potential of the current produced :type erev: voltage :param condDensity: :type condDensity: conductanceDensity

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

Constructor & Destructor Documentation

◆ ChannelDensityVShift() [1/2]

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

◆ ChannelDensityVShift() [2/2]

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

Member Function Documentation

◆ _clone()

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

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

◆ operator=()

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

◆ vShift() [1/4]

ChannelDensityVShift::vShift_type & neuroml2::ChannelDensityVShift::vShift ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ vShift() [2/4]

const ChannelDensityVShift::vShift_type & neuroml2::ChannelDensityVShift::vShift ( ) const

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

Returns: A constant reference to the attribute.

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

◆ vShift() [3/4]

void neuroml2::ChannelDensityVShift::vShift ( ::std::unique_ptr< vShift_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 11588 of file NeuroML_v2.3.cxx.

◆ vShift() [4/4]

void neuroml2::ChannelDensityVShift::vShift ( const vShift_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 11582 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

vShift

Constructors

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ChannelDensityVShift() [1/2]

◆ ChannelDensityVShift() [2/2]

Member Function Documentation

◆ _clone()

◆ operator=()

◆ vShift() [1/4]

◆ vShift() [2/4]

◆ vShift() [3/4]

◆ vShift() [4/4]