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

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

#include <NeuroML_v2.3.hxx>

+ Inheritance diagram for neuroml2::SegmentParent:
+ Collaboration diagram for neuroml2::SegmentParent:

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

fractionAlong

Accessor and modifier functions for the fractionAlong optional attribute with a default value.

typedef ::neuroml2::ZeroToOne fractionAlong_type
 Attribute type.
 
typedef ::xsd::cxx::tree::traits< fractionAlong_type, char > fractionAlong_traits
 Attribute traits type.
 
const fractionAlong_typefractionAlong () const
 Return a read-only (constant) reference to the attribute. More...
 
fractionAlong_typefractionAlong ()
 Return a read-write reference to the attribute. More...
 
void fractionAlong (const fractionAlong_type &x)
 Set the attribute value. More...
 
void fractionAlong (::std::unique_ptr< fractionAlong_type > p)
 Set the attribute value without copying. More...
 
static fractionAlong_type fractionAlong_default_value ()
 Return the default value for the attribute. More...
 

Constructors

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

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

Constructor & Destructor Documentation

◆ SegmentParent() [1/2]

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

◆ SegmentParent() [2/2]

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

Member Function Documentation

◆ _clone()

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

◆ fractionAlong() [1/4]

SegmentParent::fractionAlong_type & neuroml2::SegmentParent::fractionAlong ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.

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

◆ fractionAlong() [2/4]

const SegmentParent::fractionAlong_type & neuroml2::SegmentParent::fractionAlong ( ) const

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

Returns
A constant reference to the attribute.

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

◆ fractionAlong() [3/4]

void neuroml2::SegmentParent::fractionAlong ( ::std::unique_ptr< fractionAlong_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 9611 of file NeuroML_v2.3.cxx.

◆ fractionAlong() [4/4]

void neuroml2::SegmentParent::fractionAlong ( const fractionAlong_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 9605 of file NeuroML_v2.3.cxx.

◆ fractionAlong_default_value()

SegmentParent::fractionAlong_type neuroml2::SegmentParent::fractionAlong_default_value ( )
static

Return the default value for the attribute.

Returns
The attribute's default value.

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

◆ operator=()

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

◆ segment() [1/4]

SegmentParent::segment_type & neuroml2::SegmentParent::segment ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.

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

◆ segment() [2/4]

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

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

Returns
A constant reference to the attribute.

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

◆ segment() [3/4]

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

◆ segment() [4/4]

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


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