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

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

#include <NeuroML_v2.3.hxx>

+ Inheritance diagram for neuroml2::NamedDimensionalType:
+ Collaboration diagram for neuroml2::NamedDimensionalType:

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_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...
 

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_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...
 

description

Accessor and modifier functions for the description optional attribute.

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.
 
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...
 

Constructors

 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...
 
virtual NamedDimensionalType_clone (::xml_schema::flags f=0, ::xml_schema::container *c=0) const
 Copy the instance polymorphically. More...
 
NamedDimensionalTypeoperator= (const NamedDimensionalType &x)
 Copy assignment operator. More...
 
virtual ~NamedDimensionalType ()
 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 NamedDimensionalType schema type.

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

Constructor & Destructor Documentation

◆ NamedDimensionalType() [1/2]

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

◆ NamedDimensionalType() [2/2]

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

Member Function Documentation

◆ _clone()

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

Reimplemented in neuroml2::Requirement, neuroml2::LEMS_Property, neuroml2::DerivedParameter, and neuroml2::Parameter.

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

◆ description() [1/5]

NamedDimensionalType::description_optional & neuroml2::NamedDimensionalType::description ( )

Return a read-write reference to the attribute container.

Returns
A reference to the optional container.

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

◆ description() [2/5]

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

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

Returns
A constant reference to the optional container.

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

◆ description() [3/5]

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

◆ description() [4/5]

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

◆ description() [5/5]

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

◆ dimension() [1/4]

NamedDimensionalType::dimension_type & neuroml2::NamedDimensionalType::dimension ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.

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

◆ dimension() [2/4]

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

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

Returns
A constant reference to the attribute.

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

◆ dimension() [3/4]

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

◆ dimension() [4/4]

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

◆ name() [1/4]

NamedDimensionalType::name_type & neuroml2::NamedDimensionalType::name ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.

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

◆ name() [2/4]

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

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

Returns
A constant reference to the attribute.

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

◆ name() [3/4]

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

◆ name() [4/4]

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

◆ operator=()

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


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