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

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

#include <NeuroML_v2.3.hxx>

+ Inheritance diagram for neuroml2::RandomLayout:
+ Collaboration diagram for neuroml2::RandomLayout:

number

Accessor and modifier functions for the number optional attribute.

typedef ::xml_schema::non_negative_integer number_type
 Attribute type.
 
typedef ::xsd::cxx::tree::optional< number_typenumber_optional
 Attribute optional container type.
 
typedef ::xsd::cxx::tree::traits< number_type, char > number_traits
 Attribute traits type.
 
const number_optionalnumber () const
 Return a read-only (constant) reference to the attribute container. More...
 
number_optionalnumber ()
 Return a read-write reference to the attribute container. More...
 
void number (const number_type &x)
 Set the attribute value. More...
 
void number (const number_optional &x)
 Set the attribute value. More...
 

region

Accessor and modifier functions for the region optional attribute.

typedef ::neuroml2::NmlId region_type
 Attribute type.
 
typedef ::xsd::cxx::tree::optional< region_typeregion_optional
 Attribute optional container type.
 
typedef ::xsd::cxx::tree::traits< region_type, char > region_traits
 Attribute traits type.
 
const region_optionalregion () const
 Return a read-only (constant) reference to the attribute container. More...
 
region_optionalregion ()
 Return a read-write reference to the attribute container. More...
 
void region (const region_type &x)
 Set the attribute value. More...
 
void region (const region_optional &x)
 Set the attribute value. More...
 
void region (::std::unique_ptr< region_type > p)
 Set the attribute value without copying. More...
 

Constructors

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

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

Constructor & Destructor Documentation

◆ RandomLayout() [1/2]

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

◆ RandomLayout() [2/2]

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

Member Function Documentation

◆ _clone()

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

◆ number() [1/4]

RandomLayout::number_optional & neuroml2::RandomLayout::number ( )

Return a read-write reference to the attribute container.

Returns
A reference to the optional container.

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

◆ number() [2/4]

const RandomLayout::number_optional & neuroml2::RandomLayout::number ( ) const

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

Returns
A constant reference to the optional container.

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

◆ number() [3/4]

void neuroml2::RandomLayout::number ( const number_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 14997 of file NeuroML_v2.3.cxx.

◆ number() [4/4]

void neuroml2::RandomLayout::number ( const number_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 14991 of file NeuroML_v2.3.cxx.

◆ operator=()

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

◆ region() [1/5]

RandomLayout::region_optional & neuroml2::RandomLayout::region ( )

Return a read-write reference to the attribute container.

Returns
A reference to the optional container.

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

◆ region() [2/5]

const RandomLayout::region_optional & neuroml2::RandomLayout::region ( ) const

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

Returns
A constant reference to the optional container.

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

◆ region() [3/5]

void neuroml2::RandomLayout::region ( ::std::unique_ptr< region_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 15027 of file NeuroML_v2.3.cxx.

◆ region() [4/5]

void neuroml2::RandomLayout::region ( const region_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 15021 of file NeuroML_v2.3.cxx.

◆ region() [5/5]

void neuroml2::RandomLayout::region ( const region_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 15015 of file NeuroML_v2.3.cxx.


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