NeuroML C++ API  2.3.0
C++ API for NeuroML 2
List of all members
neuroml2::DerivedVariable Class Reference

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

#include <NeuroML_v2.3.hxx>

+ Inheritance diagram for neuroml2::DerivedVariable:
+ Collaboration diagram for neuroml2::DerivedVariable:

value

Accessor and modifier functions for the value optional attribute.

typedef ::xml_schema::string value_type
 Attribute type.
 
typedef ::xsd::cxx::tree::optional< value_typevalue_optional
 Attribute optional container type.
 
typedef ::xsd::cxx::tree::traits< value_type, char > value_traits
 Attribute traits type.
 
const value_optionalvalue () const
 Return a read-only (constant) reference to the attribute container. More...
 
value_optionalvalue ()
 Return a read-write reference to the attribute container. More...
 
void value (const value_type &x)
 Set the attribute value. More...
 
void value (const value_optional &x)
 Set the attribute value. More...
 
void value (::std::unique_ptr< value_type > p)
 Set the attribute value without copying. More...
 

select

Accessor and modifier functions for the select optional attribute.

typedef ::xml_schema::string select_type
 Attribute type.
 
typedef ::xsd::cxx::tree::optional< select_typeselect_optional
 Attribute optional container type.
 
typedef ::xsd::cxx::tree::traits< select_type, char > select_traits
 Attribute traits type.
 
const select_optionalselect () const
 Return a read-only (constant) reference to the attribute container. More...
 
select_optionalselect ()
 Return a read-write reference to the attribute container. More...
 
void select (const select_type &x)
 Set the attribute value. More...
 
void select (const select_optional &x)
 Set the attribute value. More...
 
void select (::std::unique_ptr< select_type > p)
 Set the attribute value without copying. More...
 

Constructors

 DerivedVariable (const name_type &, const dimension_type &)
 Create an instance from the ultimate base and initializers for required elements and attributes.
 
 DerivedVariable (const ::xercesc::DOMElement &e, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Create an instance from a DOM element. More...
 
 DerivedVariable (const DerivedVariable &x, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Copy constructor. More...
 
virtual DerivedVariable_clone (::xml_schema::flags f=0, ::xml_schema::container *c=0) const
 Copy the instance polymorphically. More...
 
DerivedVariableoperator= (const DerivedVariable &x)
 Copy assignment operator. More...
 
virtual ~DerivedVariable ()
 Destructor.
 

Additional Inherited Members

- Public Types inherited from neuroml2::NamedDimensionalVariable
typedef ::xml_schema::string name_type
 Attribute type.
 
typedef ::xsd::cxx::tree::traits< name_type, char > name_traits
 Attribute traits type.
 
typedef ::xml_schema::string dimension_type
 Attribute type.
 
typedef ::xsd::cxx::tree::traits< dimension_type, char > dimension_traits
 Attribute traits type.
 
typedef ::xml_schema::string description_type
 Attribute type.
 
typedef ::xsd::cxx::tree::optional< description_typedescription_optional
 Attribute optional container type.
 
typedef ::xsd::cxx::tree::traits< description_type, char > description_traits
 Attribute traits type.
 
typedef ::xml_schema::string exposure_type
 Attribute type.
 
typedef ::xsd::cxx::tree::optional< exposure_typeexposure_optional
 Attribute optional container type.
 
typedef ::xsd::cxx::tree::traits< exposure_type, char > exposure_traits
 Attribute traits type.
 
- Public Member Functions inherited from neuroml2::NamedDimensionalVariable
const name_typename () const
 Return a read-only (constant) reference to the attribute. More...
 
name_typename ()
 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...
 
const dimension_typedimension () const
 Return a read-only (constant) reference to the attribute. More...
 
dimension_typedimension ()
 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...
 
const description_optionaldescription () const
 Return a read-only (constant) reference to the attribute container. More...
 
description_optionaldescription ()
 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...
 
const exposure_optionalexposure () const
 Return a read-only (constant) reference to the attribute container. More...
 
exposure_optionalexposure ()
 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...
 
 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...
 
NamedDimensionalVariableoperator= (const NamedDimensionalVariable &x)
 Copy assignment operator. More...
 
virtual ~NamedDimensionalVariable ()
 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 DerivedVariable schema type.

LEMS ComponentType for DerivedVariable

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

Constructor & Destructor Documentation

◆ DerivedVariable() [1/2]

neuroml2::DerivedVariable::DerivedVariable ( const ::xercesc::DOMElement &  e,
::xml_schema::flags  f = 0,
::xml_schema::container c = 0 
)

Create an instance from a DOM element.

Parameters
eA DOM element to extract the data from.
fFlags to create the new instance with.
cA pointer to the object that will contain the new instance.

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

◆ DerivedVariable() [2/2]

neuroml2::DerivedVariable::DerivedVariable ( const DerivedVariable x,
::xml_schema::flags  f = 0,
::xml_schema::container c = 0 
)

Copy constructor.

Parameters
xAn instance to make a copy of.
fFlags to create the copy with.
cA pointer to the object that will contain the copy.

For polymorphic object models use the _clone function instead.

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

Member Function Documentation

◆ _clone()

DerivedVariable * neuroml2::DerivedVariable::_clone ( ::xml_schema::flags  f = 0,
::xml_schema::container c = 0 
) const
virtual

Copy the instance polymorphically.

Parameters
fFlags to create the copy with.
cA 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::NamedDimensionalVariable.

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

◆ operator=()

DerivedVariable & neuroml2::DerivedVariable::operator= ( const DerivedVariable x)

Copy assignment operator.

Parameters
xAn instance to make a copy of.
Returns
A reference to itself.

For polymorphic object models use the _clone function instead.

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

◆ select() [1/5]

DerivedVariable::select_optional & neuroml2::DerivedVariable::select ( )

Return a read-write reference to the attribute container.

Returns
A reference to the optional container.

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

◆ select() [2/5]

const DerivedVariable::select_optional & neuroml2::DerivedVariable::select ( ) const

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

Returns
A constant reference to the optional container.

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

◆ select() [3/5]

void neuroml2::DerivedVariable::select ( ::std::unique_ptr< select_type p)

Set the attribute value without copying.

Parameters
pA new value to use.

This function will try to use the passed value directly instead of making a copy.

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

◆ select() [4/5]

void neuroml2::DerivedVariable::select ( const select_optional x)

Set the attribute value.

Parameters
xAn 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 1172 of file NeuroML_v2.3.cxx.

◆ select() [5/5]

void neuroml2::DerivedVariable::select ( const select_type x)

Set the attribute value.

Parameters
xA 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 1166 of file NeuroML_v2.3.cxx.

◆ value() [1/5]

DerivedVariable::value_optional & neuroml2::DerivedVariable::value ( )

Return a read-write reference to the attribute container.

Returns
A reference to the optional container.

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

◆ value() [2/5]

const DerivedVariable::value_optional & neuroml2::DerivedVariable::value ( ) const

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

Returns
A constant reference to the optional container.

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

◆ value() [3/5]

void neuroml2::DerivedVariable::value ( ::std::unique_ptr< value_type p)

Set the attribute value without copying.

Parameters
pA new value to use.

This function will try to use the passed value directly instead of making a copy.

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

◆ value() [4/5]

void neuroml2::DerivedVariable::value ( const value_optional x)

Set the attribute value.

Parameters
xAn 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 1142 of file NeuroML_v2.3.cxx.

◆ value() [5/5]

void neuroml2::DerivedVariable::value ( const value_type x)

Set the attribute value.

Parameters
xA 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 1136 of file NeuroML_v2.3.cxx.


The documentation for this class was generated from the following files: