neuroml2::IonChannelVShift Class Reference

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

#include <NeuroML_v2.3.hxx>

Inheritance diagram for neuroml2::IonChannelVShift:

Collaboration diagram for neuroml2::IonChannelVShift:

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
	IonChannelVShift (const id_type &, const vShift_type &)
	Create an instance from the ultimate base and initializers for required elements and attributes.
	IonChannelVShift (const ::xercesc::DOMElement &e, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
	Create an instance from a DOM element. More...
	IonChannelVShift (const IonChannelVShift &x, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
	Copy constructor. More...
virtual IonChannelVShift *	_clone (::xml_schema::flags f=0, ::xml_schema::container *c=0) const
	Copy the instance polymorphically. More...
IonChannelVShift &	operator= (const IonChannelVShift &x)
	Copy assignment operator. More...
virtual	~IonChannelVShift ()
	Destructor.

Additional Inherited Members
Public Types inherited from neuroml2::IonChannel
typedef ::neuroml2::GateHHUndetermined	gate_type
	Element type.
typedef ::xsd::cxx::tree::sequence< gate_type >	gate_sequence
	Element sequence container type.
typedef gate_sequence::iterator	gate_iterator
	Element iterator type.
typedef gate_sequence::const_iterator	gate_const_iterator
	Element constant iterator type.
typedef ::xsd::cxx::tree::traits< gate_type, char >	gate_traits
	Element traits type.
typedef ::neuroml2::GateHHRates	gateHHrates_type
	Element type.
typedef ::xsd::cxx::tree::sequence< gateHHrates_type >	gateHHrates_sequence
	Element sequence container type.
typedef gateHHrates_sequence::iterator	gateHHrates_iterator
	Element iterator type.
typedef gateHHrates_sequence::const_iterator	gateHHrates_const_iterator
	Element constant iterator type.
typedef ::xsd::cxx::tree::traits< gateHHrates_type, char >	gateHHrates_traits
	Element traits type.
typedef ::neuroml2::GateHHRatesTau	gateHHratesTau_type
	Element type.
typedef ::xsd::cxx::tree::sequence< gateHHratesTau_type >	gateHHratesTau_sequence
	Element sequence container type.
typedef gateHHratesTau_sequence::iterator	gateHHratesTau_iterator
	Element iterator type.
typedef gateHHratesTau_sequence::const_iterator	gateHHratesTau_const_iterator
	Element constant iterator type.
typedef ::xsd::cxx::tree::traits< gateHHratesTau_type, char >	gateHHratesTau_traits
	Element traits type.
typedef ::neuroml2::GateHHTauInf	gateHHtauInf_type
	Element type.
typedef ::xsd::cxx::tree::sequence< gateHHtauInf_type >	gateHHtauInf_sequence
	Element sequence container type.
typedef gateHHtauInf_sequence::iterator	gateHHtauInf_iterator
	Element iterator type.
typedef gateHHtauInf_sequence::const_iterator	gateHHtauInf_const_iterator
	Element constant iterator type.
typedef ::xsd::cxx::tree::traits< gateHHtauInf_type, char >	gateHHtauInf_traits
	Element traits type.
typedef ::neuroml2::GateHHRatesInf	gateHHratesInf_type
	Element type.
typedef ::xsd::cxx::tree::sequence< gateHHratesInf_type >	gateHHratesInf_sequence
	Element sequence container type.
typedef gateHHratesInf_sequence::iterator	gateHHratesInf_iterator
	Element iterator type.
typedef gateHHratesInf_sequence::const_iterator	gateHHratesInf_const_iterator
	Element constant iterator type.
typedef ::xsd::cxx::tree::traits< gateHHratesInf_type, char >	gateHHratesInf_traits
	Element traits type.
typedef ::neuroml2::GateHHRatesTauInf	gateHHratesTauInf_type
	Element type.
typedef ::xsd::cxx::tree::sequence< gateHHratesTauInf_type >	gateHHratesTauInf_sequence
	Element sequence container type.
typedef gateHHratesTauInf_sequence::iterator	gateHHratesTauInf_iterator
	Element iterator type.
typedef gateHHratesTauInf_sequence::const_iterator	gateHHratesTauInf_const_iterator
	Element constant iterator type.
typedef ::xsd::cxx::tree::traits< gateHHratesTauInf_type, char >	gateHHratesTauInf_traits
	Element traits type.
typedef ::neuroml2::GateHHInstantaneous	gateHHInstantaneous_type
	Element type.
typedef ::xsd::cxx::tree::sequence< gateHHInstantaneous_type >	gateHHInstantaneous_sequence
	Element sequence container type.
typedef gateHHInstantaneous_sequence::iterator	gateHHInstantaneous_iterator
	Element iterator type.
typedef gateHHInstantaneous_sequence::const_iterator	gateHHInstantaneous_const_iterator
	Element constant iterator type.
typedef ::xsd::cxx::tree::traits< gateHHInstantaneous_type, char >	gateHHInstantaneous_traits
	Element traits type.
typedef ::neuroml2::GateFractional	gateFractional_type
	Element type.
typedef ::xsd::cxx::tree::sequence< gateFractional_type >	gateFractional_sequence
	Element sequence container type.
typedef gateFractional_sequence::iterator	gateFractional_iterator
	Element iterator type.
typedef gateFractional_sequence::const_iterator	gateFractional_const_iterator
	Element constant iterator type.
typedef ::xsd::cxx::tree::traits< gateFractional_type, char >	gateFractional_traits
	Element traits type.
typedef ::neuroml2::NmlId	species_type
	Attribute type.
typedef ::xsd::cxx::tree::optional< species_type >	species_optional
	Attribute optional container type.
typedef ::xsd::cxx::tree::traits< species_type, char >	species_traits
	Attribute traits type.
typedef ::neuroml2::channelTypes	type_type
	Attribute type.
typedef ::xsd::cxx::tree::optional< type_type >	type_optional
	Attribute optional container type.
typedef ::xsd::cxx::tree::traits< type_type, char >	type_traits
	Attribute traits type.
typedef ::neuroml2::Nml2Quantity_conductance	conductance_type
	Attribute type.
typedef ::xsd::cxx::tree::optional< conductance_type >	conductance_optional
	Attribute optional container type.
typedef ::xsd::cxx::tree::traits< conductance_type, char >	conductance_traits
	Attribute traits type.
Public Types inherited from neuroml2::IonChannelScalable
typedef ::neuroml2::Q10ConductanceScaling	q10ConductanceScaling_type
	Element type.
typedef ::xsd::cxx::tree::sequence< q10ConductanceScaling_type >	q10ConductanceScaling_sequence
	Element sequence container type.
typedef q10ConductanceScaling_sequence::iterator	q10ConductanceScaling_iterator
	Element iterator type.
typedef q10ConductanceScaling_sequence::const_iterator	q10ConductanceScaling_const_iterator
	Element constant iterator type.
typedef ::xsd::cxx::tree::traits< q10ConductanceScaling_type, char >	q10ConductanceScaling_traits
	Element traits type.
typedef ::neuroml2::NeuroLexId	neuroLexId_type
	Attribute type.
typedef ::xsd::cxx::tree::optional< neuroLexId_type >	neuroLexId_optional
	Attribute optional container type.
typedef ::xsd::cxx::tree::traits< neuroLexId_type, char >	neuroLexId_traits
	Attribute traits type.
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::IonChannel
const gate_sequence &	gate () const
	Return a read-only (constant) reference to the element sequence. More...
gate_sequence &	gate ()
	Return a read-write reference to the element sequence. More...
void	gate (const gate_sequence &s)
	Copy elements from a given sequence. More...
const gateHHrates_sequence &	gateHHrates () const
	Return a read-only (constant) reference to the element sequence. More...
gateHHrates_sequence &	gateHHrates ()
	Return a read-write reference to the element sequence. More...
void	gateHHrates (const gateHHrates_sequence &s)
	Copy elements from a given sequence. More...
const gateHHratesTau_sequence &	gateHHratesTau () const
	Return a read-only (constant) reference to the element sequence. More...
gateHHratesTau_sequence &	gateHHratesTau ()
	Return a read-write reference to the element sequence. More...
void	gateHHratesTau (const gateHHratesTau_sequence &s)
	Copy elements from a given sequence. More...
const gateHHtauInf_sequence &	gateHHtauInf () const
	Return a read-only (constant) reference to the element sequence. More...
gateHHtauInf_sequence &	gateHHtauInf ()
	Return a read-write reference to the element sequence. More...
void	gateHHtauInf (const gateHHtauInf_sequence &s)
	Copy elements from a given sequence. More...
const gateHHratesInf_sequence &	gateHHratesInf () const
	Return a read-only (constant) reference to the element sequence. More...
gateHHratesInf_sequence &	gateHHratesInf ()
	Return a read-write reference to the element sequence. More...
void	gateHHratesInf (const gateHHratesInf_sequence &s)
	Copy elements from a given sequence. More...
const gateHHratesTauInf_sequence &	gateHHratesTauInf () const
	Return a read-only (constant) reference to the element sequence. More...
gateHHratesTauInf_sequence &	gateHHratesTauInf ()
	Return a read-write reference to the element sequence. More...
void	gateHHratesTauInf (const gateHHratesTauInf_sequence &s)
	Copy elements from a given sequence. More...
const gateHHInstantaneous_sequence &	gateHHInstantaneous () const
	Return a read-only (constant) reference to the element sequence. More...
gateHHInstantaneous_sequence &	gateHHInstantaneous ()
	Return a read-write reference to the element sequence. More...
void	gateHHInstantaneous (const gateHHInstantaneous_sequence &s)
	Copy elements from a given sequence. More...
const gateFractional_sequence &	gateFractional () const
	Return a read-only (constant) reference to the element sequence. More...
gateFractional_sequence &	gateFractional ()
	Return a read-write reference to the element sequence. More...
void	gateFractional (const gateFractional_sequence &s)
	Copy elements from a given sequence. More...
const species_optional &	species () const
	Return a read-only (constant) reference to the attribute container. More...
species_optional &	species ()
	Return a read-write reference to the attribute container. More...
void	species (const species_type &x)
	Set the attribute value. More...
void	species (const species_optional &x)
	Set the attribute value. More...
void	species (::std::unique_ptr< species_type > p)
	Set the attribute value without copying. More...
const type_optional &	type () const
	Return a read-only (constant) reference to the attribute container. More...
type_optional &	type ()
	Return a read-write reference to the attribute container. More...
void	type (const type_type &x)
	Set the attribute value. More...
void	type (const type_optional &x)
	Set the attribute value. More...
void	type (::std::unique_ptr< type_type > p)
	Set the attribute value without copying. More...
const conductance_optional &	conductance () const
	Return a read-only (constant) reference to the attribute container. More...
conductance_optional &	conductance ()
	Return a read-write reference to the attribute container. More...
void	conductance (const conductance_type &x)
	Set the attribute value. More...
void	conductance (const conductance_optional &x)
	Set the attribute value. More...
void	conductance (::std::unique_ptr< conductance_type > p)
	Set the attribute value without copying. More...
	IonChannel (const id_type &)
	Create an instance from the ultimate base and initializers for required elements and attributes.
	IonChannel (const ::xercesc::DOMElement &e, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
	Create an instance from a DOM element. More...
	IonChannel (const IonChannel &x, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
	Copy constructor. More...
IonChannel &	operator= (const IonChannel &x)
	Copy assignment operator. More...
virtual	~IonChannel ()
	Destructor.
Public Member Functions inherited from neuroml2::IonChannelScalable
const q10ConductanceScaling_sequence &	q10ConductanceScaling () const
	Return a read-only (constant) reference to the element sequence. More...
q10ConductanceScaling_sequence &	q10ConductanceScaling ()
	Return a read-write reference to the element sequence. More...
void	q10ConductanceScaling (const q10ConductanceScaling_sequence &s)
	Copy elements from a given sequence. More...
const neuroLexId_optional &	neuroLexId () const
	Return a read-only (constant) reference to the attribute container. More...
neuroLexId_optional &	neuroLexId ()
	Return a read-write reference to the attribute container. More...
void	neuroLexId (const neuroLexId_type &x)
	Set the attribute value. More...
void	neuroLexId (const neuroLexId_optional &x)
	Set the attribute value. More...
void	neuroLexId (::std::unique_ptr< neuroLexId_type > p)
	Set the attribute value without copying. More...
	IonChannelScalable (const id_type &)
	Create an instance from the ultimate base and initializers for required elements and attributes.
	IonChannelScalable (const ::xercesc::DOMElement &e, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
	Create an instance from a DOM element. More...
	IonChannelScalable (const IonChannelScalable &x, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
	Copy constructor. More...
IonChannelScalable &	operator= (const IonChannelScalable &x)
	Copy assignment operator. More...
virtual	~IonChannelScalable ()
	Destructor.
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 IonChannelVShift schema type.

Same as ionChannel , 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 conductance: :type conductance: conductance

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

Constructor & Destructor Documentation

IonChannelVShift() [1/2]

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

IonChannelVShift() [2/2]

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

Member Function Documentation

_clone()

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

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

operator=()

IonChannelVShift & neuroml2::IonChannelVShift::operator=

(

const IonChannelVShift &

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 24769 of file NeuroML_v2.3.cxx.

vShift() [1/4]

IonChannelVShift::vShift_type & neuroml2::IonChannelVShift::vShift

(

)

Return a read-write reference to the attribute.

Returns

A reference to the attribute.

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

vShift() [2/4]

const IonChannelVShift::vShift_type & neuroml2::IonChannelVShift::vShift

(

)

const

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

Returns

A constant reference to the attribute.

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

vShift() [3/4]

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

vShift() [4/4]

void neuroml2::IonChannelVShift::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 3621 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