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

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

#include <NeuroML_v2.3.hxx>

+ Inheritance diagram for neuroml2::Include:
+ Collaboration diagram for neuroml2::Include:

segmentGroup

Accessor and modifier functions for the segmentGroup required attribute.

typedef ::neuroml2::NmlId segmentGroup_type
 Attribute type.
 
typedef ::xsd::cxx::tree::traits< segmentGroup_type, char > segmentGroup_traits
 Attribute traits type.
 
const segmentGroup_typesegmentGroup () const
 Return a read-only (constant) reference to the attribute. More...
 
segmentGroup_typesegmentGroup ()
 Return a read-write reference to the attribute. More...
 
void segmentGroup (const segmentGroup_type &x)
 Set the attribute value. More...
 
void segmentGroup (::std::unique_ptr< segmentGroup_type > p)
 Set the attribute value without copying. More...
 

Constructors

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

Include all members of another segmentGroup in this group

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

Constructor & Destructor Documentation

◆ Include() [1/2]

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

◆ Include() [2/2]

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

Member Function Documentation

◆ _clone()

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

◆ operator=()

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

◆ segmentGroup() [1/4]

Include::segmentGroup_type & neuroml2::Include::segmentGroup ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.

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

◆ segmentGroup() [2/4]

const Include::segmentGroup_type & neuroml2::Include::segmentGroup ( ) const

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

Returns
A constant reference to the attribute.

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

◆ segmentGroup() [3/4]

void neuroml2::Include::segmentGroup ( ::std::unique_ptr< segmentGroup_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 10158 of file NeuroML_v2.3.cxx.

◆ segmentGroup() [4/4]

void neuroml2::Include::segmentGroup ( const segmentGroup_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 10152 of file NeuroML_v2.3.cxx.


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