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

#include <NeuroML_v2.3.hxx>

Inheritance diagram for neuroml2::InhomogeneousParameter:

Collaboration diagram for neuroml2::InhomogeneousParameter:

proximal
Accessor and modifier functions for the proximal optional element.
typedef ::neuroml2::ProximalDetails	proximal_type
	Element type.

typedef ::xsd::cxx::tree::optional< proximal_type >	proximal_optional
	Element optional container type.

typedef ::xsd::cxx::tree::traits< proximal_type, char >	proximal_traits
	Element traits type.

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

proximal_optional &	proximal ()
	Return a read-write reference to the element container. More...

void	proximal (const proximal_type &x)
	Set the element value. More...

void	proximal (const proximal_optional &x)
	Set the element value. More...

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

distal
Accessor and modifier functions for the distal optional element.
typedef ::neuroml2::DistalDetails	distal_type
	Element type.

typedef ::xsd::cxx::tree::optional< distal_type >	distal_optional
	Element optional container type.

typedef ::xsd::cxx::tree::traits< distal_type, char >	distal_traits
	Element traits type.

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

distal_optional &	distal ()
	Return a read-write reference to the element container. More...

void	distal (const distal_type &x)
	Set the element value. More...

void	distal (const distal_optional &x)
	Set the element value. More...

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

variable
Accessor and modifier functions for the variable required attribute.
typedef ::xml_schema::string	variable_type
	Attribute type.

typedef ::xsd::cxx::tree::traits< variable_type, char >	variable_traits
	Attribute traits type.

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

variable_type &	variable ()
	Return a read-write reference to the attribute. More...

void	variable (const variable_type &x)
	Set the attribute value. More...

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

metric
Accessor and modifier functions for the metric required attribute.
typedef ::neuroml2::Metric	metric_type
	Attribute type.

typedef ::xsd::cxx::tree::traits< metric_type, char >	metric_traits
	Attribute traits type.

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

metric_type &	metric ()
	Return a read-write reference to the attribute. More...

void	metric (const metric_type &x)
	Set the attribute value. More...

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

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

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

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

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

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

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

An inhomogeneous parameter specified across the segmentGroup ( see variableParameter for usage ).

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

Constructor & Destructor Documentation

◆ InhomogeneousParameter() [1/2]

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

◆ InhomogeneousParameter() [2/2]

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

Member Function Documentation

◆ _clone()

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

◆ distal() [1/5]

InhomogeneousParameter::distal_optional & neuroml2::InhomogeneousParameter::distal ( )

Return a read-write reference to the element container.

Returns: A reference to the optional container.

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

◆ distal() [2/5]

const InhomogeneousParameter::distal_optional & neuroml2::InhomogeneousParameter::distal ( ) const

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

Returns: A constant reference to the optional container.

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

◆ distal() [3/5]

void neuroml2::InhomogeneousParameter::distal ( ::std::unique_ptr< distal_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 9965 of file NeuroML_v2.3.cxx.

◆ distal() [4/5]

void neuroml2::InhomogeneousParameter::distal ( const distal_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 9959 of file NeuroML_v2.3.cxx.

◆ distal() [5/5]

void neuroml2::InhomogeneousParameter::distal ( const distal_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 9953 of file NeuroML_v2.3.cxx.

◆ metric() [1/4]

InhomogeneousParameter::metric_type & neuroml2::InhomogeneousParameter::metric ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ metric() [2/4]

const InhomogeneousParameter::metric_type & neuroml2::InhomogeneousParameter::metric ( ) const

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

Returns: A constant reference to the attribute.

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

◆ metric() [3/4]

void neuroml2::InhomogeneousParameter::metric ( ::std::unique_ptr< metric_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 10013 of file NeuroML_v2.3.cxx.

◆ metric() [4/4]

void neuroml2::InhomogeneousParameter::metric ( const metric_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 10007 of file NeuroML_v2.3.cxx.

◆ operator=()

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

◆ proximal() [1/5]

InhomogeneousParameter::proximal_optional & neuroml2::InhomogeneousParameter::proximal ( )

Return a read-write reference to the element container.

Returns: A reference to the optional container.

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

◆ proximal() [2/5]

const InhomogeneousParameter::proximal_optional & neuroml2::InhomogeneousParameter::proximal ( ) const

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

Returns: A constant reference to the optional container.

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

◆ proximal() [3/5]

void neuroml2::InhomogeneousParameter::proximal ( ::std::unique_ptr< proximal_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 9935 of file NeuroML_v2.3.cxx.

◆ proximal() [4/5]

void neuroml2::InhomogeneousParameter::proximal ( const proximal_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 9929 of file NeuroML_v2.3.cxx.

◆ proximal() [5/5]

void neuroml2::InhomogeneousParameter::proximal ( const proximal_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 9923 of file NeuroML_v2.3.cxx.

◆ variable() [1/4]

InhomogeneousParameter::variable_type & neuroml2::InhomogeneousParameter::variable ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ variable() [2/4]

const InhomogeneousParameter::variable_type & neuroml2::InhomogeneousParameter::variable ( ) const

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

Returns: A constant reference to the attribute.

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

◆ variable() [3/4]

void neuroml2::InhomogeneousParameter::variable ( ::std::unique_ptr< variable_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 9989 of file NeuroML_v2.3.cxx.

◆ variable() [4/4]

void neuroml2::InhomogeneousParameter::variable ( const variable_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 9983 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

proximal

distal

variable

metric

Constructors

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ InhomogeneousParameter() [1/2]

◆ InhomogeneousParameter() [2/2]

Member Function Documentation

◆ _clone()

◆ distal() [1/5]

◆ distal() [2/5]

◆ distal() [3/5]

◆ distal() [4/5]

◆ distal() [5/5]

◆ metric() [1/4]

◆ metric() [2/4]

◆ metric() [3/4]

◆ metric() [4/4]

◆ operator=()

◆ proximal() [1/5]

◆ proximal() [2/5]

◆ proximal() [3/5]

◆ proximal() [4/5]

◆ proximal() [5/5]

◆ variable() [1/4]

◆ variable() [2/4]

◆ variable() [3/4]

◆ variable() [4/4]