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

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

#include <NeuroML_v2.3.hxx>

+ Inheritance diagram for neuroml2::InhomogeneousValue:
+ Collaboration diagram for neuroml2::InhomogeneousValue:

inhomogeneousParameter

Accessor and modifier functions for the inhomogeneousParameter required attribute.

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

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

 InhomogeneousValue (const inhomogeneousParameter_type &, const value_type &)
 Create an instance from the ultimate base and initializers for required elements and attributes.
 
 InhomogeneousValue (const ::xercesc::DOMElement &e, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Create an instance from a DOM element. More...
 
 InhomogeneousValue (const InhomogeneousValue &x, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Copy constructor. More...
 
virtual InhomogeneousValue_clone (::xml_schema::flags f=0, ::xml_schema::container *c=0) const
 Copy the instance polymorphically. More...
 
InhomogeneousValueoperator= (const InhomogeneousValue &x)
 Copy assignment operator. More...
 
virtual ~InhomogeneousValue ()
 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 InhomogeneousValue schema type.

Specifies the value of an inhomogeneousParameter. For usage see variableParameter

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

Constructor & Destructor Documentation

◆ InhomogeneousValue() [1/2]

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

◆ InhomogeneousValue() [2/2]

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

Member Function Documentation

◆ _clone()

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

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

◆ inhomogeneousParameter() [1/4]

InhomogeneousValue::inhomogeneousParameter_type & neuroml2::InhomogeneousValue::inhomogeneousParameter ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.

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

◆ inhomogeneousParameter() [2/4]

const InhomogeneousValue::inhomogeneousParameter_type & neuroml2::InhomogeneousValue::inhomogeneousParameter ( ) const

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

Returns
A constant reference to the attribute.

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

◆ inhomogeneousParameter() [3/4]

void neuroml2::InhomogeneousValue::inhomogeneousParameter ( ::std::unique_ptr< inhomogeneousParameter_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 12140 of file NeuroML_v2.3.cxx.

◆ inhomogeneousParameter() [4/4]

void neuroml2::InhomogeneousValue::inhomogeneousParameter ( const inhomogeneousParameter_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 12134 of file NeuroML_v2.3.cxx.

◆ operator=()

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

◆ value() [1/4]

InhomogeneousValue::value_type & neuroml2::InhomogeneousValue::value ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.

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

◆ value() [2/4]

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

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

Returns
A constant reference to the attribute.

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

◆ value() [3/4]

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

◆ value() [4/4]

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


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