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

#include <NeuroML_v2.3.hxx>

Inheritance diagram for neuroml2::IonChannelKS:

Collaboration diagram for neuroml2::IonChannelKS:

gateKS
Accessor and modifier functions for the gateKS sequence element.
typedef ::neuroml2::GateKS	gateKS_type
	Element type.

typedef ::xsd::cxx::tree::sequence< gateKS_type >	gateKS_sequence
	Element sequence container type.

typedef gateKS_sequence::iterator	gateKS_iterator
	Element iterator type.

typedef gateKS_sequence::const_iterator	gateKS_const_iterator
	Element constant iterator type.

typedef ::xsd::cxx::tree::traits< gateKS_type, char >	gateKS_traits
	Element traits type.

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

gateKS_sequence &	gateKS ()
	Return a read-write reference to the element sequence. More...

void	gateKS (const gateKS_sequence &s)
	Copy elements from a given sequence. More...

species
Accessor and modifier functions for the species optional attribute.
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.

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

conductance
Accessor and modifier functions for the conductance optional attribute.
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.

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

neuroLexId
Accessor and modifier functions for the neuroLexId optional attribute.
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.

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

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

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

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

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

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

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

A kinetic scheme based ion channel with multiple gateKS s, each of which consists of multiple KSState s and KSTransition s giving the rates of transition between them
:param conductance: :type conductance: conductance

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

Constructor & Destructor Documentation

◆ IonChannelKS() [1/2]

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

◆ IonChannelKS() [2/2]

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

Member Function Documentation

◆ _clone()

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

◆ conductance() [1/5]

IonChannelKS::conductance_optional & neuroml2::IonChannelKS::conductance ( )

Return a read-write reference to the attribute container.

Returns: A reference to the optional container.

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

◆ conductance() [2/5]

const IonChannelKS::conductance_optional & neuroml2::IonChannelKS::conductance ( ) const

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

Returns: A constant reference to the optional container.

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

◆ conductance() [3/5]

void neuroml2::IonChannelKS::conductance ( ::std::unique_ptr< conductance_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 3327 of file NeuroML_v2.3.cxx.

◆ conductance() [4/5]

void neuroml2::IonChannelKS::conductance ( const conductance_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 3321 of file NeuroML_v2.3.cxx.

◆ conductance() [5/5]

void neuroml2::IonChannelKS::conductance ( const conductance_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 3315 of file NeuroML_v2.3.cxx.

◆ gateKS() [1/3]

IonChannelKS::gateKS_sequence & neuroml2::IonChannelKS::gateKS ( )

Return a read-write reference to the element sequence.

Returns: A reference to the sequence container.

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

◆ gateKS() [2/3]

const IonChannelKS::gateKS_sequence & neuroml2::IonChannelKS::gateKS ( ) const

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

Returns: A constant reference to the sequence container.

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

◆ gateKS() [3/3]

void neuroml2::IonChannelKS::gateKS ( const gateKS_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 3267 of file NeuroML_v2.3.cxx.

◆ neuroLexId() [1/5]

IonChannelKS::neuroLexId_optional & neuroml2::IonChannelKS::neuroLexId ( )

Return a read-write reference to the attribute container.

Returns: A reference to the optional container.

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

◆ neuroLexId() [2/5]

const IonChannelKS::neuroLexId_optional & neuroml2::IonChannelKS::neuroLexId ( ) const

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

Returns: A constant reference to the optional container.

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

◆ neuroLexId() [3/5]

void neuroml2::IonChannelKS::neuroLexId ( ::std::unique_ptr< neuroLexId_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 3357 of file NeuroML_v2.3.cxx.

◆ neuroLexId() [4/5]

void neuroml2::IonChannelKS::neuroLexId ( const neuroLexId_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 3351 of file NeuroML_v2.3.cxx.

◆ neuroLexId() [5/5]

void neuroml2::IonChannelKS::neuroLexId ( const neuroLexId_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 3345 of file NeuroML_v2.3.cxx.

◆ operator=()

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

◆ species() [1/5]

IonChannelKS::species_optional & neuroml2::IonChannelKS::species ( )

Return a read-write reference to the attribute container.

Returns: A reference to the optional container.

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

◆ species() [2/5]

const IonChannelKS::species_optional & neuroml2::IonChannelKS::species ( ) const

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

Returns: A constant reference to the optional container.

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

◆ species() [3/5]

void neuroml2::IonChannelKS::species ( ::std::unique_ptr< species_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 3297 of file NeuroML_v2.3.cxx.

◆ species() [4/5]

void neuroml2::IonChannelKS::species ( const species_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 3291 of file NeuroML_v2.3.cxx.

◆ species() [5/5]

void neuroml2::IonChannelKS::species ( const species_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 3285 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

gateKS

species

conductance

neuroLexId

Constructors

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IonChannelKS() [1/2]

◆ IonChannelKS() [2/2]

Member Function Documentation

◆ _clone()

◆ conductance() [1/5]

◆ conductance() [2/5]

◆ conductance() [3/5]

◆ conductance() [4/5]

◆ conductance() [5/5]

◆ gateKS() [1/3]

◆ gateKS() [2/3]

◆ gateKS() [3/3]

◆ neuroLexId() [1/5]

◆ neuroLexId() [2/5]

◆ neuroLexId() [3/5]

◆ neuroLexId() [4/5]

◆ neuroLexId() [5/5]

◆ operator=()

◆ species() [1/5]

◆ species() [2/5]

◆ species() [3/5]

◆ species() [4/5]

◆ species() [5/5]