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

#include <NeuroML_v2.3.hxx>

Inheritance diagram for neuroml2::NamedDimensionalVariable:

Collaboration diagram for neuroml2::NamedDimensionalVariable:

name
Accessor and modifier functions for the name required attribute.
typedef ::xml_schema::string	name_type
	Attribute type.

typedef ::xsd::cxx::tree::traits< name_type, char >	name_traits
	Attribute traits type.

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

name_type &	name ()
	Return a read-write reference to the attribute. More...

void	name (const name_type &x)
	Set the attribute value. More...

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

dimension
Accessor and modifier functions for the dimension required attribute.
typedef ::xml_schema::string	dimension_type
	Attribute type.

typedef ::xsd::cxx::tree::traits< dimension_type, char >	dimension_traits
	Attribute traits type.

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

dimension_type &	dimension ()
	Return a read-write reference to the attribute. More...

void	dimension (const dimension_type &x)
	Set the attribute value. More...

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

description
Accessor and modifier functions for the description optional attribute.
typedef ::xml_schema::string	description_type
	Attribute type.

typedef ::xsd::cxx::tree::optional< description_type >	description_optional
	Attribute optional container type.

typedef ::xsd::cxx::tree::traits< description_type, char >	description_traits
	Attribute traits type.

const description_optional &	description () const
	Return a read-only (constant) reference to the attribute container. More...

description_optional &	description ()
	Return a read-write reference to the attribute container. More...

void	description (const description_type &x)
	Set the attribute value. More...

void	description (const description_optional &x)
	Set the attribute value. More...

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

exposure
Accessor and modifier functions for the exposure optional attribute.
typedef ::xml_schema::string	exposure_type
	Attribute type.

typedef ::xsd::cxx::tree::optional< exposure_type >	exposure_optional
	Attribute optional container type.

typedef ::xsd::cxx::tree::traits< exposure_type, char >	exposure_traits
	Attribute traits type.

const exposure_optional &	exposure () const
	Return a read-only (constant) reference to the attribute container. More...

exposure_optional &	exposure ()
	Return a read-write reference to the attribute container. More...

void	exposure (const exposure_type &x)
	Set the attribute value. More...

void	exposure (const exposure_optional &x)
	Set the attribute value. More...

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

Constructors
	NamedDimensionalVariable (const name_type &, const dimension_type &)
	Create an instance from the ultimate base and initializers for required elements and attributes.

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

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

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

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

virtual	~NamedDimensionalVariable ()
	Destructor.

Additional Inherited Members
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 NamedDimensionalVariable schema type.

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

Constructor & Destructor Documentation

◆ NamedDimensionalVariable() [1/2]

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

◆ NamedDimensionalVariable() [2/2]

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

Member Function Documentation

◆ _clone()

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

Reimplemented in neuroml2::ConditionalDerivedVariable, neuroml2::StateVariable, and neuroml2::DerivedVariable.

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

◆ description() [1/5]

NamedDimensionalVariable::description_optional & neuroml2::NamedDimensionalVariable::description ( )

Return a read-write reference to the attribute container.

Returns: A reference to the optional container.

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

◆ description() [2/5]

const NamedDimensionalVariable::description_optional & neuroml2::NamedDimensionalVariable::description ( ) const

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

Returns: A constant reference to the optional container.

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

◆ description() [3/5]

void neuroml2::NamedDimensionalVariable::description ( ::std::unique_ptr< description_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 808 of file NeuroML_v2.3.cxx.

◆ description() [4/5]

void neuroml2::NamedDimensionalVariable::description ( const description_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 802 of file NeuroML_v2.3.cxx.

◆ description() [5/5]

void neuroml2::NamedDimensionalVariable::description ( const description_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 796 of file NeuroML_v2.3.cxx.

◆ dimension() [1/4]

NamedDimensionalVariable::dimension_type & neuroml2::NamedDimensionalVariable::dimension ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ dimension() [2/4]

const NamedDimensionalVariable::dimension_type & neuroml2::NamedDimensionalVariable::dimension ( ) const

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

Returns: A constant reference to the attribute.

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

◆ dimension() [3/4]

void neuroml2::NamedDimensionalVariable::dimension ( ::std::unique_ptr< dimension_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 778 of file NeuroML_v2.3.cxx.

◆ dimension() [4/4]

void neuroml2::NamedDimensionalVariable::dimension ( const dimension_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 772 of file NeuroML_v2.3.cxx.

◆ exposure() [1/5]

NamedDimensionalVariable::exposure_optional & neuroml2::NamedDimensionalVariable::exposure ( )

Return a read-write reference to the attribute container.

Returns: A reference to the optional container.

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

◆ exposure() [2/5]

const NamedDimensionalVariable::exposure_optional & neuroml2::NamedDimensionalVariable::exposure ( ) const

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

Returns: A constant reference to the optional container.

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

◆ exposure() [3/5]

void neuroml2::NamedDimensionalVariable::exposure ( ::std::unique_ptr< exposure_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 838 of file NeuroML_v2.3.cxx.

◆ exposure() [4/5]

void neuroml2::NamedDimensionalVariable::exposure ( const exposure_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 832 of file NeuroML_v2.3.cxx.

◆ exposure() [5/5]

void neuroml2::NamedDimensionalVariable::exposure ( const exposure_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 826 of file NeuroML_v2.3.cxx.

◆ name() [1/4]

NamedDimensionalVariable::name_type & neuroml2::NamedDimensionalVariable::name ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ name() [2/4]

const NamedDimensionalVariable::name_type & neuroml2::NamedDimensionalVariable::name ( ) const

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

Returns: A constant reference to the attribute.

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

◆ name() [3/4]

void neuroml2::NamedDimensionalVariable::name ( ::std::unique_ptr< name_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 754 of file NeuroML_v2.3.cxx.

◆ name() [4/4]

void neuroml2::NamedDimensionalVariable::name ( const name_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 748 of file NeuroML_v2.3.cxx.

◆ operator=()

NamedDimensionalVariable & neuroml2::NamedDimensionalVariable::operator= ( const NamedDimensionalVariable & 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 20169 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

name

dimension

description

exposure

Constructors

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ NamedDimensionalVariable() [1/2]

◆ NamedDimensionalVariable() [2/2]

Member Function Documentation

◆ _clone()

◆ description() [1/5]

◆ description() [2/5]

◆ description() [3/5]

◆ description() [4/5]

◆ description() [5/5]

◆ dimension() [1/4]

◆ dimension() [2/4]

◆ dimension() [3/4]

◆ dimension() [4/4]

◆ exposure() [1/5]

◆ exposure() [2/5]

◆ exposure() [3/5]

◆ exposure() [4/5]

◆ exposure() [5/5]

◆ name() [1/4]

◆ name() [2/4]

◆ name() [3/4]

◆ name() [4/4]

◆ operator=()