NeuroML C++ API  2.3.0
C++ API for NeuroML 2
Public Types | Public Member Functions | List of all members
neuroml2::Metric Class Reference

Enumeration class corresponding to the Metric schema type. More...

#include <NeuroML_v2.3.hxx>

+ Inheritance diagram for neuroml2::Metric:
+ Collaboration diagram for neuroml2::Metric:

Public Types

enum  value { Path_Length_from_root }
 Underlying enum type.
 

Public Member Functions

 Metric (value v)
 Create an instance from the underlying enum value. More...
 
 Metric (const char *v)
 Create an instance from a C string. More...
 
 Metric (const ::std::string &v)
 Create an instance from a string. More...
 
 Metric (const ::xml_schema::string &v)
 Create an instance from the base value. More...
 
 Metric (const ::xercesc::DOMElement &e, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Create an instance from a DOM element. More...
 
 Metric (const ::xercesc::DOMAttr &a, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Create an instance from a DOM attribute. More...
 
 Metric (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...
 
 Metric (const Metric &x, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Copy constructor. More...
 
virtual Metric_clone (::xml_schema::flags f=0, ::xml_schema::container *c=0) const
 Copy the instance polymorphically. More...
 
Metricoperator= (value v)
 Assign the underlying enum value. More...
 
virtual operator value () const
 Implicit conversion operator to the underlying enum value. More...
 

Detailed Description

Enumeration class corresponding to the Metric schema type.

Allowed metrics for InhomogeneousParam

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

Constructor & Destructor Documentation

◆ Metric() [1/8]

neuroml2::Metric::Metric ( value  v)

Create an instance from the underlying enum value.

Parameters
vA enum value.

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

◆ Metric() [2/8]

neuroml2::Metric::Metric ( const char *  v)

Create an instance from a C string.

Parameters
vA string value.

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

◆ Metric() [3/8]

neuroml2::Metric::Metric ( const ::std::string &  v)

Create an instance from a string.

Parameters
vA string value.

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

◆ Metric() [4/8]

neuroml2::Metric::Metric ( const ::xml_schema::string v)

Create an instance from the base value.

Parameters
vA base value.

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

◆ Metric() [5/8]

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

◆ Metric() [6/8]

neuroml2::Metric::Metric ( const ::xercesc::DOMAttr &  a,
::xml_schema::flags  f = 0,
::xml_schema::container c = 0 
)

Create an instance from a DOM attribute.

Parameters
aA DOM attribute 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 35342 of file NeuroML_v2.3.cxx.

◆ Metric() [7/8]

neuroml2::Metric::Metric ( 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.

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

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

◆ Metric() [8/8]

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

Member Function Documentation

◆ _clone()

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

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

◆ operator value()

virtual neuroml2::Metric::operator value ( ) const
inlinevirtual

Implicit conversion operator to the underlying enum value.

Returns
A enum value.

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

◆ operator=()

Metric & neuroml2::Metric::operator= ( value  v)

Assign the underlying enum value.

Parameters
vA enum value.
Returns
A reference to the instance.

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


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