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

#include <NeuroML_v2.3.hxx>

Inheritance diagram for neuroml2::HHVariable:

Collaboration diagram for neuroml2::HHVariable:

type
Accessor and modifier functions for the type required attribute.
typedef ::neuroml2::NmlId	type_type
	Attribute type.

typedef ::xsd::cxx::tree::traits< type_type, char >	type_traits
	Attribute traits type.

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

type_type &	type ()
	Return a read-write reference to the attribute. More...

void	type (const type_type &x)
	Set the attribute value. More...

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

rate
Accessor and modifier functions for the rate optional attribute.
typedef ::xml_schema::float_	rate_type
	Attribute type.

typedef ::xsd::cxx::tree::optional< rate_type >	rate_optional
	Attribute optional container type.

typedef ::xsd::cxx::tree::traits< rate_type, char >	rate_traits
	Attribute traits type.

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

rate_optional &	rate ()
	Return a read-write reference to the attribute container. More...

void	rate (const rate_type &x)
	Set the attribute value. More...

void	rate (const rate_optional &x)
	Set the attribute value. More...

midpoint
Accessor and modifier functions for the midpoint optional attribute.
typedef ::neuroml2::Nml2Quantity_voltage	midpoint_type
	Attribute type.

typedef ::xsd::cxx::tree::optional< midpoint_type >	midpoint_optional
	Attribute optional container type.

typedef ::xsd::cxx::tree::traits< midpoint_type, char >	midpoint_traits
	Attribute traits type.

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

midpoint_optional &	midpoint ()
	Return a read-write reference to the attribute container. More...

void	midpoint (const midpoint_type &x)
	Set the attribute value. More...

void	midpoint (const midpoint_optional &x)
	Set the attribute value. More...

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

scale
Accessor and modifier functions for the scale optional attribute.
typedef ::neuroml2::Nml2Quantity_voltage	scale_type
	Attribute type.

typedef ::xsd::cxx::tree::optional< scale_type >	scale_optional
	Attribute optional container type.

typedef ::xsd::cxx::tree::traits< scale_type, char >	scale_traits
	Attribute traits type.

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

scale_optional &	scale ()
	Return a read-write reference to the attribute container. More...

void	scale (const scale_type &x)
	Set the attribute value. More...

void	scale (const scale_optional &x)
	Set the attribute value. More...

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

Constructors
	HHVariable (const type_type &)
	Create an instance from the ultimate base and initializers for required elements and attributes.

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

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

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

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

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

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

Constructor & Destructor Documentation

◆ HHVariable() [1/2]

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

◆ HHVariable() [2/2]

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

Member Function Documentation

◆ _clone()

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

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

◆ midpoint() [1/5]

HHVariable::midpoint_optional & neuroml2::HHVariable::midpoint ( )

Return a read-write reference to the attribute container.

Returns: A reference to the optional container.

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

◆ midpoint() [2/5]

const HHVariable::midpoint_optional & neuroml2::HHVariable::midpoint ( ) const

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

Returns: A constant reference to the optional container.

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

◆ midpoint() [3/5]

void neuroml2::HHVariable::midpoint ( ::std::unique_ptr< midpoint_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 5827 of file NeuroML_v2.3.cxx.

◆ midpoint() [4/5]

void neuroml2::HHVariable::midpoint ( const midpoint_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 5821 of file NeuroML_v2.3.cxx.

◆ midpoint() [5/5]

void neuroml2::HHVariable::midpoint ( const midpoint_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 5815 of file NeuroML_v2.3.cxx.

◆ operator=()

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

◆ rate() [1/4]

HHVariable::rate_optional & neuroml2::HHVariable::rate ( )

Return a read-write reference to the attribute container.

Returns: A reference to the optional container.

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

◆ rate() [2/4]

const HHVariable::rate_optional & neuroml2::HHVariable::rate ( ) const

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

Returns: A constant reference to the optional container.

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

◆ rate() [3/4]

void neuroml2::HHVariable::rate ( const rate_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 5797 of file NeuroML_v2.3.cxx.

◆ rate() [4/4]

void neuroml2::HHVariable::rate ( const rate_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 5791 of file NeuroML_v2.3.cxx.

◆ scale() [1/5]

HHVariable::scale_optional & neuroml2::HHVariable::scale ( )

Return a read-write reference to the attribute container.

Returns: A reference to the optional container.

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

◆ scale() [2/5]

const HHVariable::scale_optional & neuroml2::HHVariable::scale ( ) const

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

Returns: A constant reference to the optional container.

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

◆ scale() [3/5]

void neuroml2::HHVariable::scale ( ::std::unique_ptr< scale_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 5857 of file NeuroML_v2.3.cxx.

◆ scale() [4/5]

void neuroml2::HHVariable::scale ( const scale_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 5851 of file NeuroML_v2.3.cxx.

◆ scale() [5/5]

void neuroml2::HHVariable::scale ( const scale_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 5845 of file NeuroML_v2.3.cxx.

◆ type() [1/4]

HHVariable::type_type & neuroml2::HHVariable::type ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ type() [2/4]

const HHVariable::type_type & neuroml2::HHVariable::type ( ) const

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

Returns: A constant reference to the attribute.

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

◆ type() [3/4]

void neuroml2::HHVariable::type ( ::std::unique_ptr< type_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 5773 of file NeuroML_v2.3.cxx.

◆ type() [4/4]

void neuroml2::HHVariable::type ( const type_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 5767 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

type

rate

midpoint

scale

Constructors

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ HHVariable() [1/2]

◆ HHVariable() [2/2]

Member Function Documentation

◆ _clone()

◆ midpoint() [1/5]

◆ midpoint() [2/5]

◆ midpoint() [3/5]

◆ midpoint() [4/5]

◆ midpoint() [5/5]

◆ operator=()

◆ rate() [1/4]

◆ rate() [2/4]

◆ rate() [3/4]

◆ rate() [4/4]

◆ scale() [1/5]

◆ scale() [2/5]

◆ scale() [3/5]

◆ scale() [4/5]

◆ scale() [5/5]

◆ type() [1/4]

◆ type() [2/4]

◆ type() [3/4]

◆ type() [4/4]