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

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

#include <NeuroML_v2.3.hxx>

+ Inheritance diagram for neuroml2::ReactionScheme:
+ Collaboration diagram for neuroml2::ReactionScheme:

source

Accessor and modifier functions for the source required attribute.

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

type

Accessor and modifier functions for the type required attribute.

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

Constructors

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

Additional Inherited Members

- Public Types inherited from neuroml2::Base
typedef ::neuroml2::NmlId id_type
 Attribute type.
 
typedef ::xsd::cxx::tree::traits< id_type, char > id_traits
 Attribute traits type.
 
- Public Member Functions inherited from neuroml2::Base
const id_typeid () const
 Return a read-only (constant) reference to the attribute. More...
 
id_typeid ()
 Return a read-write reference to the attribute. More...
 
void id (const id_type &x)
 Set the attribute value. More...
 
void id (::std::unique_ptr< id_type > p)
 Set the attribute value without copying. More...
 
 Base (const id_type &)
 Create an instance from the ultimate base and initializers for required elements and attributes.
 
 Base (const ::xercesc::DOMElement &e, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Create an instance from a DOM element. More...
 
 Base (const Base &x, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Copy constructor. More...
 
Baseoperator= (const Base &x)
 Copy assignment operator. More...
 
virtual ~Base ()
 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 ReactionScheme schema type.

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

Constructor & Destructor Documentation

◆ ReactionScheme() [1/2]

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

◆ ReactionScheme() [2/2]

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

Member Function Documentation

◆ _clone()

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

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

◆ operator=()

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

◆ source() [1/4]

ReactionScheme::source_type & neuroml2::ReactionScheme::source ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.

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

◆ source() [2/4]

const ReactionScheme::source_type & neuroml2::ReactionScheme::source ( ) const

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

Returns
A constant reference to the attribute.

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

◆ source() [3/4]

void neuroml2::ReactionScheme::source ( ::std::unique_ptr< source_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 12432 of file NeuroML_v2.3.cxx.

◆ source() [4/4]

void neuroml2::ReactionScheme::source ( const source_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 12426 of file NeuroML_v2.3.cxx.

◆ type() [1/4]

ReactionScheme::type_type & neuroml2::ReactionScheme::type ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.

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

◆ type() [2/4]

const ReactionScheme::type_type & neuroml2::ReactionScheme::type ( ) const

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

Returns
A constant reference to the attribute.

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

◆ type() [3/4]

void neuroml2::ReactionScheme::type ( ::std::unique_ptr< type_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 12456 of file NeuroML_v2.3.cxx.

◆ type() [4/4]

void neuroml2::ReactionScheme::type ( const type_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 12450 of file NeuroML_v2.3.cxx.


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