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

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

#include <NeuroML_v2.3.hxx>

+ Inheritance diagram for neuroml2::Member:
+ Collaboration diagram for neuroml2::Member:

segment

Accessor and modifier functions for the segment required attribute.

typedef ::neuroml2::NonNegativeInteger segment_type
 Attribute type.
 
typedef ::xsd::cxx::tree::traits< segment_type, char > segment_traits
 Attribute traits type.
 
const segment_typesegment () const
 Return a read-only (constant) reference to the attribute. More...
 
segment_typesegment ()
 Return a read-write reference to the attribute. More...
 
void segment (const segment_type &x)
 Set the attribute value. More...
 
void segment (::std::unique_ptr< segment_type > p)
 Set the attribute value without copying. More...
 

Constructors

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

A single identified segment which is part of the segmentGroup** *

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

Constructor & Destructor Documentation

◆ Member() [1/2]

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

◆ Member() [2/2]

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

Member Function Documentation

◆ _clone()

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

◆ operator=()

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

◆ segment() [1/4]

Member::segment_type & neuroml2::Member::segment ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.

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

◆ segment() [2/4]

const Member::segment_type & neuroml2::Member::segment ( ) const

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

Returns
A constant reference to the attribute.

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

◆ segment() [3/4]

void neuroml2::Member::segment ( ::std::unique_ptr< segment_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 10130 of file NeuroML_v2.3.cxx.

◆ segment() [4/4]

void neuroml2::Member::segment ( const segment_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 10124 of file NeuroML_v2.3.cxx.


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