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

#include <NeuroML_v2.3.hxx>

Inheritance diagram for neuroml2::ChannelPopulation:

Collaboration diagram for neuroml2::ChannelPopulation:

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

number
Accessor and modifier functions for the number required attribute.
typedef ::neuroml2::NonNegativeInteger	number_type
	Attribute type.

typedef ::xsd::cxx::tree::traits< number_type, char >	number_traits
	Attribute traits type.

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

number_type &	number ()
	Return a read-write reference to the attribute. More...

void	number (const number_type &x)
	Set the attribute value. More...

void	number (::std::unique_ptr< number_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
	ChannelPopulation (const id_type &, const ionChannel_type &, const number_type &, const erev_type &, const ion_type &)
	Create an instance from the ultimate base and initializers for required elements and attributes.

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

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

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

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

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

Population of a number of ohmic ion channels. These each produce a conductance channelg across a reversal potential erev, giving a total current i. Note that active membrane currents are more frequently specified as a density over an area of the cell using channelDensity
:param number: The number of channels present. This will be multiplied by the time varying conductance of the individual ion channel ( which extends baseIonChannel ) to produce the total conductance :type number: none :param erev: The reversal potential of the current produced :type erev: voltage

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

Constructor & Destructor Documentation

◆ ChannelPopulation() [1/2]

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

◆ ChannelPopulation() [2/2]

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

Member Function Documentation

◆ _clone()

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

◆ erev() [1/4]

ChannelPopulation::erev_type & neuroml2::ChannelPopulation::erev ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ erev() [2/4]

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

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

Returns: A constant reference to the attribute.

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

◆ erev() [3/4]

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

◆ erev() [4/4]

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

◆ ion() [1/4]

ChannelPopulation::ion_type & neuroml2::ChannelPopulation::ion ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ ion() [2/4]

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

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

Returns: A constant reference to the attribute.

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

◆ ion() [3/4]

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

◆ ion() [4/4]

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

◆ ionChannel() [1/4]

ChannelPopulation::ionChannel_type & neuroml2::ChannelPopulation::ionChannel ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ ionChannel() [2/4]

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

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

Returns: A constant reference to the attribute.

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

◆ ionChannel() [3/4]

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

◆ ionChannel() [4/4]

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

◆ number() [1/4]

ChannelPopulation::number_type & neuroml2::ChannelPopulation::number ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ number() [2/4]

const ChannelPopulation::number_type & neuroml2::ChannelPopulation::number ( ) const

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

Returns: A constant reference to the attribute.

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

◆ number() [3/4]

void neuroml2::ChannelPopulation::number ( ::std::unique_ptr< number_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 11034 of file NeuroML_v2.3.cxx.

◆ number() [4/4]

void neuroml2::ChannelPopulation::number ( const number_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 11028 of file NeuroML_v2.3.cxx.

◆ operator=()

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

◆ segment() [1/5]

ChannelPopulation::segment_optional & neuroml2::ChannelPopulation::segment ( )

Return a read-write reference to the attribute container.

Returns: A reference to the optional container.

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

◆ segment() [2/5]

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

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

Returns: A constant reference to the optional container.

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

◆ segment() [3/5]

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

◆ segment() [4/5]

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

◆ segment() [5/5]

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

◆ segmentGroup() [1/4]

ChannelPopulation::segmentGroup_type & neuroml2::ChannelPopulation::segmentGroup ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ segmentGroup() [2/4]

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

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

Returns: A constant reference to the attribute.

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

◆ segmentGroup() [3/4]

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

◆ segmentGroup() [4/4]

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

◆ segmentGroup_default_value()

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

◆ variableParameter() [1/3]

ChannelPopulation::variableParameter_sequence & neuroml2::ChannelPopulation::variableParameter ( )

Return a read-write reference to the element sequence.

Returns: A reference to the sequence container.

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

◆ variableParameter() [2/3]

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

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

Returns: A constant reference to the sequence container.

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

◆ variableParameter() [3/3]

void neuroml2::ChannelPopulation::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 10986 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

number

erev

segmentGroup

segment

ion

Constructors

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ChannelPopulation() [1/2]

◆ ChannelPopulation() [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]

◆ number() [1/4]

◆ number() [2/4]

◆ number() [3/4]

◆ number() [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]