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

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

#include <NeuroML_v2.3.hxx>

+ Inheritance diagram for neuroml2::Case:
+ Collaboration diagram for neuroml2::Case:

condition

Accessor and modifier functions for the condition optional attribute.

typedef ::xml_schema::string condition_type
 Attribute type.
 
typedef ::xsd::cxx::tree::optional< condition_typecondition_optional
 Attribute optional container type.
 
typedef ::xsd::cxx::tree::traits< condition_type, char > condition_traits
 Attribute traits type.
 
const condition_optionalcondition () const
 Return a read-only (constant) reference to the attribute container. More...
 
condition_optionalcondition ()
 Return a read-write reference to the attribute container. More...
 
void condition (const condition_type &x)
 Set the attribute value. More...
 
void condition (const condition_optional &x)
 Set the attribute value. More...
 
void condition (::std::unique_ptr< condition_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

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

Detailed Description

Class corresponding to the Case schema type.

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

Constructor & Destructor Documentation

◆ Case() [1/2]

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

◆ Case() [2/2]

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

Member Function Documentation

◆ _clone()

Case * neuroml2::Case::_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 21167 of file NeuroML_v2.3.cxx.

◆ condition() [1/5]

Case::condition_optional & neuroml2::Case::condition ( )

Return a read-write reference to the attribute container.

Returns
A reference to the optional container.

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

◆ condition() [2/5]

const Case::condition_optional & neuroml2::Case::condition ( ) const

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

Returns
A constant reference to the optional container.

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

◆ condition() [3/5]

void neuroml2::Case::condition ( ::std::unique_ptr< condition_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 1238 of file NeuroML_v2.3.cxx.

◆ condition() [4/5]

void neuroml2::Case::condition ( const condition_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 1232 of file NeuroML_v2.3.cxx.

◆ condition() [5/5]

void neuroml2::Case::condition ( const condition_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 1226 of file NeuroML_v2.3.cxx.

◆ operator=()

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

◆ value() [1/4]

Case::value_type & neuroml2::Case::value ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.

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

◆ value() [2/4]

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

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

Returns
A constant reference to the attribute.

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

◆ value() [3/4]

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

◆ value() [4/4]

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


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