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

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

#include <NeuroML_v2.3.hxx>

+ Inheritance diagram for neuroml2::Layout:
+ Collaboration diagram for neuroml2::Layout:

random

Accessor and modifier functions for the random optional element.

typedef ::neuroml2::RandomLayout random_type
 Element type.
 
typedef ::xsd::cxx::tree::optional< random_typerandom_optional
 Element optional container type.
 
typedef ::xsd::cxx::tree::traits< random_type, char > random_traits
 Element traits type.
 
const random_optionalrandom () const
 Return a read-only (constant) reference to the element container. More...
 
random_optionalrandom ()
 Return a read-write reference to the element container. More...
 
void random (const random_type &x)
 Set the element value. More...
 
void random (const random_optional &x)
 Set the element value. More...
 
void random (::std::unique_ptr< random_type > p)
 Set the element value without copying. More...
 

grid

Accessor and modifier functions for the grid optional element.

typedef ::neuroml2::GridLayout grid_type
 Element type.
 
typedef ::xsd::cxx::tree::optional< grid_typegrid_optional
 Element optional container type.
 
typedef ::xsd::cxx::tree::traits< grid_type, char > grid_traits
 Element traits type.
 
const grid_optionalgrid () const
 Return a read-only (constant) reference to the element container. More...
 
grid_optionalgrid ()
 Return a read-write reference to the element container. More...
 
void grid (const grid_type &x)
 Set the element value. More...
 
void grid (const grid_optional &x)
 Set the element value. More...
 
void grid (::std::unique_ptr< grid_type > p)
 Set the element value without copying. More...
 

unstructured

Accessor and modifier functions for the unstructured optional element.

typedef ::neuroml2::UnstructuredLayout unstructured_type
 Element type.
 
typedef ::xsd::cxx::tree::optional< unstructured_typeunstructured_optional
 Element optional container type.
 
typedef ::xsd::cxx::tree::traits< unstructured_type, char > unstructured_traits
 Element traits type.
 
const unstructured_optionalunstructured () const
 Return a read-only (constant) reference to the element container. More...
 
unstructured_optionalunstructured ()
 Return a read-write reference to the element container. More...
 
void unstructured (const unstructured_type &x)
 Set the element value. More...
 
void unstructured (const unstructured_optional &x)
 Set the element value. More...
 
void unstructured (::std::unique_ptr< unstructured_type > p)
 Set the element value without copying. More...
 

space

Accessor and modifier functions for the space optional attribute.

typedef ::neuroml2::NmlId space_type
 Attribute type.
 
typedef ::xsd::cxx::tree::optional< space_typespace_optional
 Attribute optional container type.
 
typedef ::xsd::cxx::tree::traits< space_type, char > space_traits
 Attribute traits type.
 
const space_optionalspace () const
 Return a read-only (constant) reference to the attribute container. More...
 
space_optionalspace ()
 Return a read-write reference to the attribute container. More...
 
void space (const space_type &x)
 Set the attribute value. More...
 
void space (const space_optional &x)
 Set the attribute value. More...
 
void space (::std::unique_ptr< space_type > p)
 Set the attribute value without copying. More...
 

Constructors

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

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

Constructor & Destructor Documentation

◆ Layout() [1/2]

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

◆ Layout() [2/2]

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

Member Function Documentation

◆ _clone()

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

◆ grid() [1/5]

Layout::grid_optional & neuroml2::Layout::grid ( )

Return a read-write reference to the element container.

Returns
A reference to the optional container.

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

◆ grid() [2/5]

const Layout::grid_optional & neuroml2::Layout::grid ( ) const

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

Returns
A constant reference to the optional container.

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

◆ grid() [3/5]

void neuroml2::Layout::grid ( ::std::unique_ptr< grid_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 14881 of file NeuroML_v2.3.cxx.

◆ grid() [4/5]

void neuroml2::Layout::grid ( const grid_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 14875 of file NeuroML_v2.3.cxx.

◆ grid() [5/5]

void neuroml2::Layout::grid ( const grid_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 14869 of file NeuroML_v2.3.cxx.

◆ operator=()

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

◆ random() [1/5]

Layout::random_optional & neuroml2::Layout::random ( )

Return a read-write reference to the element container.

Returns
A reference to the optional container.

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

◆ random() [2/5]

const Layout::random_optional & neuroml2::Layout::random ( ) const

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

Returns
A constant reference to the optional container.

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

◆ random() [3/5]

void neuroml2::Layout::random ( ::std::unique_ptr< random_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 14851 of file NeuroML_v2.3.cxx.

◆ random() [4/5]

void neuroml2::Layout::random ( const random_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 14845 of file NeuroML_v2.3.cxx.

◆ random() [5/5]

void neuroml2::Layout::random ( const random_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 14839 of file NeuroML_v2.3.cxx.

◆ space() [1/5]

Layout::space_optional & neuroml2::Layout::space ( )

Return a read-write reference to the attribute container.

Returns
A reference to the optional container.

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

◆ space() [2/5]

const Layout::space_optional & neuroml2::Layout::space ( ) const

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

Returns
A constant reference to the optional container.

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

◆ space() [3/5]

void neuroml2::Layout::space ( ::std::unique_ptr< space_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 14941 of file NeuroML_v2.3.cxx.

◆ space() [4/5]

void neuroml2::Layout::space ( const space_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 14935 of file NeuroML_v2.3.cxx.

◆ space() [5/5]

void neuroml2::Layout::space ( const space_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 14929 of file NeuroML_v2.3.cxx.

◆ unstructured() [1/5]

Layout::unstructured_optional & neuroml2::Layout::unstructured ( )

Return a read-write reference to the element container.

Returns
A reference to the optional container.

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

◆ unstructured() [2/5]

const Layout::unstructured_optional & neuroml2::Layout::unstructured ( ) const

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

Returns
A constant reference to the optional container.

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

◆ unstructured() [3/5]

void neuroml2::Layout::unstructured ( ::std::unique_ptr< unstructured_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 14911 of file NeuroML_v2.3.cxx.

◆ unstructured() [4/5]

void neuroml2::Layout::unstructured ( const unstructured_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 14905 of file NeuroML_v2.3.cxx.

◆ unstructured() [5/5]

void neuroml2::Layout::unstructured ( const unstructured_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 14899 of file NeuroML_v2.3.cxx.


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