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

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

#include <NeuroML_v2.3.hxx>

+ Inheritance diagram for neuroml2::CellSet:
+ Collaboration diagram for neuroml2::CellSet:

select

Accessor and modifier functions for the select required attribute.

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

Constructors

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

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

Constructor & Destructor Documentation

◆ CellSet() [1/2]

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

◆ CellSet() [2/2]

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

Member Function Documentation

◆ _clone()

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

◆ operator=()

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

◆ select() [1/4]

CellSet::select_type & neuroml2::CellSet::select ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.

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

◆ select() [2/4]

const CellSet::select_type & neuroml2::CellSet::select ( ) const

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

Returns
A constant reference to the attribute.

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

◆ select() [3/4]

void neuroml2::CellSet::select ( ::std::unique_ptr< select_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 15313 of file NeuroML_v2.3.cxx.

◆ select() [4/4]

void neuroml2::CellSet::select ( const select_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 15307 of file NeuroML_v2.3.cxx.


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