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

#include <NeuroML_v2.3.hxx>

Inheritance diagram for neuroml2::ChannelDensityGHK:

Collaboration diagram for neuroml2::ChannelDensityGHK:

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

permeability
Accessor and modifier functions for the permeability required attribute.
typedef ::neuroml2::Nml2Quantity_permeability	permeability_type
	Attribute type.

typedef ::xsd::cxx::tree::traits< permeability_type, char >	permeability_traits
	Attribute traits type.

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

permeability_type &	permeability ()
	Return a read-write reference to the attribute. More...

void	permeability (const permeability_type &x)
	Set the attribute value. More...

void	permeability (::std::unique_ptr< permeability_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::NmlId	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
	ChannelDensityGHK (const id_type &, const ionChannel_type &, const permeability_type &, const ion_type &)
	Create an instance from the ultimate base and initializers for required elements and attributes.

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

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

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

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

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

Specifies a time varying conductance density, gDensity, which is distributed on an area of the cell, producing a current density iDensity and whose reversal potential is calculated from the Goldman Hodgkin Katz equation. Hard coded for Ca only! See https://github.com/OpenSourceBrain/ghk-nernst.
:param permeability: :type permeability: permeability

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

Constructor & Destructor Documentation

◆ ChannelDensityGHK() [1/2]

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

◆ ChannelDensityGHK() [2/2]

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

Member Function Documentation

◆ _clone()

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

◆ ion() [1/4]

ChannelDensityGHK::ion_type & neuroml2::ChannelDensityGHK::ion ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ ion() [2/4]

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

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

Returns: A constant reference to the attribute.

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

◆ ion() [3/4]

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

◆ ion() [4/4]

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

◆ ionChannel() [1/4]

ChannelDensityGHK::ionChannel_type & neuroml2::ChannelDensityGHK::ionChannel ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ ionChannel() [2/4]

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

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

Returns: A constant reference to the attribute.

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

◆ ionChannel() [3/4]

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

◆ ionChannel() [4/4]

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

◆ operator=()

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

◆ permeability() [1/4]

ChannelDensityGHK::permeability_type & neuroml2::ChannelDensityGHK::permeability ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ permeability() [2/4]

const ChannelDensityGHK::permeability_type & neuroml2::ChannelDensityGHK::permeability ( ) const

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

Returns: A constant reference to the attribute.

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

◆ permeability() [3/4]

void neuroml2::ChannelDensityGHK::permeability ( ::std::unique_ptr< permeability_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 11804 of file NeuroML_v2.3.cxx.

◆ permeability() [4/4]

void neuroml2::ChannelDensityGHK::permeability ( const permeability_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 11798 of file NeuroML_v2.3.cxx.

◆ segment() [1/5]

ChannelDensityGHK::segment_optional & neuroml2::ChannelDensityGHK::segment ( )

Return a read-write reference to the attribute container.

Returns: A reference to the optional container.

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

◆ segment() [2/5]

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

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

Returns: A constant reference to the optional container.

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

◆ segment() [3/5]

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

◆ segment() [4/5]

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

◆ segment() [5/5]

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

◆ segmentGroup() [1/4]

ChannelDensityGHK::segmentGroup_type & neuroml2::ChannelDensityGHK::segmentGroup ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ segmentGroup() [2/4]

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

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

Returns: A constant reference to the attribute.

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

◆ segmentGroup() [3/4]

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

◆ segmentGroup() [4/4]

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

◆ segmentGroup_default_value()

const ChannelDensityGHK::segmentGroup_type & neuroml2::ChannelDensityGHK::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 11834 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

ionChannel

permeability

segmentGroup

segment

ion

Constructors

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ChannelDensityGHK() [1/2]

◆ ChannelDensityGHK() [2/2]

Member Function Documentation

◆ _clone()

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

◆ permeability() [1/4]

◆ permeability() [2/4]

◆ permeability() [3/4]

◆ permeability() [4/4]

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