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

#include <NeuroML_v2.3.hxx>

Inheritance diagram for neuroml2::VariableParameter:

Collaboration diagram for neuroml2::VariableParameter:

inhomogeneousValue
Accessor and modifier functions for the inhomogeneousValue optional element.
typedef ::neuroml2::InhomogeneousValue	inhomogeneousValue_type
	Element type.

typedef ::xsd::cxx::tree::optional< inhomogeneousValue_type >	inhomogeneousValue_optional
	Element optional container type.

typedef ::xsd::cxx::tree::traits< inhomogeneousValue_type, char >	inhomogeneousValue_traits
	Element traits type.

const inhomogeneousValue_optional &	inhomogeneousValue () const
	Return a read-only (constant) reference to the element container. More...

inhomogeneousValue_optional &	inhomogeneousValue ()
	Return a read-write reference to the element container. More...

void	inhomogeneousValue (const inhomogeneousValue_type &x)
	Set the element value. More...

void	inhomogeneousValue (const inhomogeneousValue_optional &x)
	Set the element value. More...

void	inhomogeneousValue (::std::unique_ptr< inhomogeneousValue_type > p)
	Set the element value without copying. More...

parameter
Accessor and modifier functions for the parameter required attribute.
typedef ::xml_schema::string	parameter_type
	Attribute type.

typedef ::xsd::cxx::tree::traits< parameter_type, char >	parameter_traits
	Attribute traits type.

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

parameter_type &	parameter ()
	Return a read-write reference to the attribute. More...

void	parameter (const parameter_type &x)
	Set the attribute value. More...

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

segmentGroup
Accessor and modifier functions for the segmentGroup required attribute.
typedef ::xml_schema::string	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...

Constructors
	VariableParameter (const parameter_type &, const segmentGroup_type &)
	Create an instance from the ultimate base and initializers for required elements and attributes.

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

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

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

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

virtual	~VariableParameter ()
	Destructor.

Detailed Description

Class corresponding to the VariableParameter schema type.

Specifies a parameter ( e. g. condDensity ) which can vary its value across a segmentGroup. The value is calculated from value attribute of the inhomogeneousValue subelement. This element is normally a child of channelDensityNonUniform , channelDensityNonUniformNernst or channelDensityNonUniformGHK and is used to calculate the value of the conductance, etc. which will vary on different parts of the cell. The segmentGroup specified here needs to define an inhomogeneousParameter ( referenced from inhomogeneousParameter in the inhomogeneousValue ), which calculates a variable ( e. g. p ) varying across the cell ( e. g. based on the path length from soma ), which is then used in the value attribute of the inhomogeneousValue ( so for example condDensity = f( p ) )

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

Constructor & Destructor Documentation

◆ VariableParameter() [1/2]

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

◆ VariableParameter() [2/2]

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

Member Function Documentation

◆ _clone()

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

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

◆ inhomogeneousValue() [1/5]

VariableParameter::inhomogeneousValue_optional & neuroml2::VariableParameter::inhomogeneousValue ( )

Return a read-write reference to the element container.

Returns: A reference to the optional container.

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

◆ inhomogeneousValue() [2/5]

const VariableParameter::inhomogeneousValue_optional & neuroml2::VariableParameter::inhomogeneousValue ( ) const

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

Returns: A constant reference to the optional container.

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

◆ inhomogeneousValue() [3/5]

void neuroml2::VariableParameter::inhomogeneousValue ( ::std::unique_ptr< inhomogeneousValue_type > p )

Set the element 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 12064 of file NeuroML_v2.3.cxx.

◆ inhomogeneousValue() [4/5]

void neuroml2::VariableParameter::inhomogeneousValue ( const inhomogeneousValue_optional & x )

Set the element 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 element. Otherwise the element container is set the 'not present' state.

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

◆ inhomogeneousValue() [5/5]

void neuroml2::VariableParameter::inhomogeneousValue ( const inhomogeneousValue_type & x )

Set the element 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 element.

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

◆ operator=()

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

◆ parameter() [1/4]

VariableParameter::parameter_type & neuroml2::VariableParameter::parameter ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ parameter() [2/4]

const VariableParameter::parameter_type & neuroml2::VariableParameter::parameter ( ) const

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

Returns: A constant reference to the attribute.

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

◆ parameter() [3/4]

void neuroml2::VariableParameter::parameter ( ::std::unique_ptr< parameter_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 12088 of file NeuroML_v2.3.cxx.

◆ parameter() [4/4]

void neuroml2::VariableParameter::parameter ( const parameter_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 12082 of file NeuroML_v2.3.cxx.

◆ segmentGroup() [1/4]

VariableParameter::segmentGroup_type & neuroml2::VariableParameter::segmentGroup ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ segmentGroup() [2/4]

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

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

Returns: A constant reference to the attribute.

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

◆ segmentGroup() [3/4]

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

◆ segmentGroup() [4/4]

void neuroml2::VariableParameter::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 12106 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

inhomogeneousValue

parameter

segmentGroup

Constructors

Detailed Description

Constructor & Destructor Documentation

◆ VariableParameter() [1/2]

◆ VariableParameter() [2/2]

Member Function Documentation

◆ _clone()

◆ inhomogeneousValue() [1/5]

◆ inhomogeneousValue() [2/5]

◆ inhomogeneousValue() [3/5]

◆ inhomogeneousValue() [4/5]

◆ inhomogeneousValue() [5/5]

◆ operator=()

◆ parameter() [1/4]

◆ parameter() [2/4]

◆ parameter() [3/4]

◆ parameter() [4/4]

◆ segmentGroup() [1/4]

◆ segmentGroup() [2/4]

◆ segmentGroup() [3/4]

◆ segmentGroup() [4/4]