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

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

#include <NeuroML_v2.3.hxx>

+ Inheritance diagram for neuroml2::Space:
+ Collaboration diagram for neuroml2::Space:

structure

Accessor and modifier functions for the structure optional element.

typedef ::neuroml2::SpaceStructure structure_type
 Element type.
 
typedef ::xsd::cxx::tree::optional< structure_typestructure_optional
 Element optional container type.
 
typedef ::xsd::cxx::tree::traits< structure_type, char > structure_traits
 Element traits type.
 
const structure_optionalstructure () const
 Return a read-only (constant) reference to the element container. More...
 
structure_optionalstructure ()
 Return a read-write reference to the element container. More...
 
void structure (const structure_type &x)
 Set the element value. More...
 
void structure (const structure_optional &x)
 Set the element value. More...
 
void structure (::std::unique_ptr< structure_type > p)
 Set the element value without copying. More...
 

basedOn

Accessor and modifier functions for the basedOn optional attribute.

typedef ::neuroml2::allowedSpaces basedOn_type
 Attribute type.
 
typedef ::xsd::cxx::tree::optional< basedOn_typebasedOn_optional
 Attribute optional container type.
 
typedef ::xsd::cxx::tree::traits< basedOn_type, char > basedOn_traits
 Attribute traits type.
 
const basedOn_optionalbasedOn () const
 Return a read-only (constant) reference to the attribute container. More...
 
basedOn_optionalbasedOn ()
 Return a read-write reference to the attribute container. More...
 
void basedOn (const basedOn_type &x)
 Set the attribute value. More...
 
void basedOn (const basedOn_optional &x)
 Set the attribute value. More...
 
void basedOn (::std::unique_ptr< basedOn_type > p)
 Set the attribute value without copying. More...
 

Constructors

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

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

Constructor & Destructor Documentation

◆ Space() [1/2]

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

◆ Space() [2/2]

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

Member Function Documentation

◆ _clone()

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

◆ basedOn() [1/5]

Space::basedOn_optional & neuroml2::Space::basedOn ( )

Return a read-write reference to the attribute container.

Returns
A reference to the optional container.

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

◆ basedOn() [2/5]

const Space::basedOn_optional & neuroml2::Space::basedOn ( ) const

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

Returns
A constant reference to the optional container.

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

◆ basedOn() [3/5]

void neuroml2::Space::basedOn ( ::std::unique_ptr< basedOn_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 14349 of file NeuroML_v2.3.cxx.

◆ basedOn() [4/5]

void neuroml2::Space::basedOn ( const basedOn_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 14343 of file NeuroML_v2.3.cxx.

◆ basedOn() [5/5]

void neuroml2::Space::basedOn ( const basedOn_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 14337 of file NeuroML_v2.3.cxx.

◆ operator=()

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

◆ structure() [1/5]

Space::structure_optional & neuroml2::Space::structure ( )

Return a read-write reference to the element container.

Returns
A reference to the optional container.

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

◆ structure() [2/5]

const Space::structure_optional & neuroml2::Space::structure ( ) const

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

Returns
A constant reference to the optional container.

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

◆ structure() [3/5]

void neuroml2::Space::structure ( ::std::unique_ptr< structure_type p)

Set the element 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 14319 of file NeuroML_v2.3.cxx.

◆ structure() [4/5]

void neuroml2::Space::structure ( const structure_optional x)

Set the element 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 element. Otherwise the element container is set the 'not present' state.

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

◆ structure() [5/5]

void neuroml2::Space::structure ( const structure_type x)

Set the element value.

Parameters
xA new value to set.

This function makes a copy of its argument and sets it as the new value of the element.

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


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