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

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

#include <NeuroML_v2.3.hxx>

+ Inheritance diagram for neuroml2::DerivedParameter:
+ Collaboration diagram for neuroml2::DerivedParameter:

value

Accessor and modifier functions for the value required attribute.

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

Constructors

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

Additional Inherited Members

- Public Types inherited from neuroml2::NamedDimensionalType
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.
 
- Public Member Functions inherited from neuroml2::NamedDimensionalType
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...
 
 NamedDimensionalType (const name_type &, const dimension_type &)
 Create an instance from the ultimate base and initializers for required elements and attributes.
 
 NamedDimensionalType (const ::xercesc::DOMElement &e, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Create an instance from a DOM element. More...
 
 NamedDimensionalType (const NamedDimensionalType &x, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Copy constructor. More...
 
NamedDimensionalTypeoperator= (const NamedDimensionalType &x)
 Copy assignment operator. More...
 
virtual ~NamedDimensionalType ()
 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 DerivedParameter schema type.

LEMS DerivedParamter element

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

Constructor & Destructor Documentation

◆ DerivedParameter() [1/2]

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

◆ DerivedParameter() [2/2]

neuroml2::DerivedParameter::DerivedParameter ( const DerivedParameter 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 20265 of file NeuroML_v2.3.cxx.

Member Function Documentation

◆ _clone()

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

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

◆ operator=()

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

◆ value() [1/4]

DerivedParameter::value_type & neuroml2::DerivedParameter::value ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.

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

◆ value() [2/4]

const DerivedParameter::value_type & neuroml2::DerivedParameter::value ( ) const

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

Returns
A constant reference to the attribute.

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

◆ value() [3/4]

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

◆ value() [4/4]

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


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