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

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

#include <NeuroML_v2.3.hxx>

+ Inheritance diagram for neuroml2::UnstructuredLayout:
+ Collaboration diagram for neuroml2::UnstructuredLayout:

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...
 

Constructors

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

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

Constructor & Destructor Documentation

◆ UnstructuredLayout() [1/2]

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

◆ UnstructuredLayout() [2/2]

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

Member Function Documentation

◆ _clone()

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

◆ number() [1/4]

UnstructuredLayout::number_optional & neuroml2::UnstructuredLayout::number ( )

Return a read-write reference to the attribute container.

Returns
A reference to the optional container.

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

◆ number() [2/4]

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

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

Returns
A constant reference to the optional container.

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

◆ number() [3/4]

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

◆ number() [4/4]

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

◆ operator=()

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


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