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

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

#include <NeuroML_v2.3.hxx>

+ Inheritance diagram for neuroml2::InstanceRequirement:
+ Collaboration diagram for neuroml2::InstanceRequirement:

name

Accessor and modifier functions for the name required attribute.

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

type

Accessor and modifier functions for the type required attribute.

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

Constructors

 InstanceRequirement (const name_type &, const type_type &)
 Create an instance from the ultimate base and initializers for required elements and attributes.
 
 InstanceRequirement (const ::xercesc::DOMElement &e, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Create an instance from a DOM element. More...
 
 InstanceRequirement (const InstanceRequirement &x, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Copy constructor. More...
 
virtual InstanceRequirement_clone (::xml_schema::flags f=0, ::xml_schema::container *c=0) const
 Copy the instance polymorphically. More...
 
InstanceRequirementoperator= (const InstanceRequirement &x)
 Copy assignment operator. More...
 
virtual ~InstanceRequirement ()
 Destructor.
 

Detailed Description

Class corresponding to the InstanceRequirement schema type.

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

Constructor & Destructor Documentation

◆ InstanceRequirement() [1/2]

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

◆ InstanceRequirement() [2/2]

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

Member Function Documentation

◆ _clone()

InstanceRequirement * neuroml2::InstanceRequirement::_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.

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

◆ name() [1/4]

InstanceRequirement::name_type & neuroml2::InstanceRequirement::name ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.

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

◆ name() [2/4]

const InstanceRequirement::name_type & neuroml2::InstanceRequirement::name ( ) const

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

Returns
A constant reference to the attribute.

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

◆ name() [3/4]

void neuroml2::InstanceRequirement::name ( ::std::unique_ptr< name_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 930 of file NeuroML_v2.3.cxx.

◆ name() [4/4]

void neuroml2::InstanceRequirement::name ( const name_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 924 of file NeuroML_v2.3.cxx.

◆ operator=()

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

◆ type() [1/4]

InstanceRequirement::type_type & neuroml2::InstanceRequirement::type ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.

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

◆ type() [2/4]

const InstanceRequirement::type_type & neuroml2::InstanceRequirement::type ( ) const

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

Returns
A constant reference to the attribute.

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

◆ type() [3/4]

void neuroml2::InstanceRequirement::type ( ::std::unique_ptr< type_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 954 of file NeuroML_v2.3.cxx.

◆ type() [4/4]

void neuroml2::InstanceRequirement::type ( const type_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 948 of file NeuroML_v2.3.cxx.


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