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

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

#include <NeuroML_v2.3.hxx>

+ Inheritance diagram for neuroml2::Morphology_base:
+ Collaboration diagram for neuroml2::Morphology_base:

segment

Accessor and modifier functions for the segment sequence element.

typedef ::neuroml2::Segment segment_type
 Element type.
 
typedef ::xsd::cxx::tree::sequence< segment_typesegment_sequence
 Element sequence container type.
 
typedef segment_sequence::iterator segment_iterator
 Element iterator type.
 
typedef segment_sequence::const_iterator segment_const_iterator
 Element constant iterator type.
 
typedef ::xsd::cxx::tree::traits< segment_type, char > segment_traits
 Element traits type.
 
const segment_sequencesegment () const
 Return a read-only (constant) reference to the element sequence. More...
 
segment_sequencesegment ()
 Return a read-write reference to the element sequence. More...
 
void segment (const segment_sequence &s)
 Copy elements from a given sequence. More...
 

segmentGroup

Accessor and modifier functions for the segmentGroup sequence element.

typedef ::neuroml2::SegmentGroup segmentGroup_type
 Element type.
 
typedef ::xsd::cxx::tree::sequence< segmentGroup_typesegmentGroup_sequence
 Element sequence container type.
 
typedef segmentGroup_sequence::iterator segmentGroup_iterator
 Element iterator type.
 
typedef segmentGroup_sequence::const_iterator segmentGroup_const_iterator
 Element constant iterator type.
 
typedef ::xsd::cxx::tree::traits< segmentGroup_type, char > segmentGroup_traits
 Element traits type.
 
const segmentGroup_sequencesegmentGroup () const
 Return a read-only (constant) reference to the element sequence. More...
 
segmentGroup_sequencesegmentGroup ()
 Return a read-write reference to the element sequence. More...
 
void segmentGroup (const segmentGroup_sequence &s)
 Copy elements from a given sequence. More...
 

Constructors

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

Additional Inherited Members

- Public Types inherited from neuroml2::Standalone
typedef ::neuroml2::Notes notes_type
 Element type.
 
typedef ::xsd::cxx::tree::optional< notes_typenotes_optional
 Element optional container type.
 
typedef ::xsd::cxx::tree::traits< notes_type, char > notes_traits
 Element traits type.
 
typedef ::neuroml2::Property property_type
 Element type.
 
typedef ::xsd::cxx::tree::sequence< property_typeproperty_sequence
 Element sequence container type.
 
typedef property_sequence::iterator property_iterator
 Element iterator type.
 
typedef property_sequence::const_iterator property_const_iterator
 Element constant iterator type.
 
typedef ::xsd::cxx::tree::traits< property_type, char > property_traits
 Element traits type.
 
typedef ::neuroml2::Annotation annotation_type
 Element type.
 
typedef ::xsd::cxx::tree::optional< annotation_typeannotation_optional
 Element optional container type.
 
typedef ::xsd::cxx::tree::traits< annotation_type, char > annotation_traits
 Element traits type.
 
typedef ::neuroml2::MetaId metaid_type
 Attribute type.
 
typedef ::xsd::cxx::tree::optional< metaid_typemetaid_optional
 Attribute optional container type.
 
typedef ::xsd::cxx::tree::traits< metaid_type, char > metaid_traits
 Attribute traits type.
 
- 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::Standalone
const notes_optionalnotes () const
 Return a read-only (constant) reference to the element container. More...
 
notes_optionalnotes ()
 Return a read-write reference to the element container. More...
 
void notes (const notes_type &x)
 Set the element value. More...
 
void notes (const notes_optional &x)
 Set the element value. More...
 
void notes (::std::unique_ptr< notes_type > p)
 Set the element value without copying. More...
 
const property_sequenceproperty () const
 Return a read-only (constant) reference to the element sequence. More...
 
property_sequenceproperty ()
 Return a read-write reference to the element sequence. More...
 
void property (const property_sequence &s)
 Copy elements from a given sequence. More...
 
const annotation_optionalannotation () const
 Return a read-only (constant) reference to the element container. More...
 
annotation_optionalannotation ()
 Return a read-write reference to the element container. More...
 
void annotation (const annotation_type &x)
 Set the element value. More...
 
void annotation (const annotation_optional &x)
 Set the element value. More...
 
void annotation (::std::unique_ptr< annotation_type > p)
 Set the element value without copying. More...
 
const metaid_optionalmetaid () const
 Return a read-only (constant) reference to the attribute container. More...
 
metaid_optionalmetaid ()
 Return a read-write reference to the attribute container. More...
 
void metaid (const metaid_type &x)
 Set the attribute value. More...
 
void metaid (const metaid_optional &x)
 Set the attribute value. More...
 
void metaid (::std::unique_ptr< metaid_type > p)
 Set the attribute value without copying. More...
 
 Standalone (const id_type &)
 Create an instance from the ultimate base and initializers for required elements and attributes.
 
 Standalone (const ::xercesc::DOMElement &e, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Create an instance from a DOM element. More...
 
 Standalone (const Standalone &x, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Copy constructor. More...
 
Standaloneoperator= (const Standalone &x)
 Copy assignment operator. More...
 
virtual ~Standalone ()
 Destructor.
 
- 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 Morphology schema type.

The collection of segment s which specify the 3D structure of the cell, along with a number of segmentGroup s

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

Constructor & Destructor Documentation

◆ Morphology_base() [1/2]

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

◆ Morphology_base() [2/2]

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

Member Function Documentation

◆ _clone()

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

Reimplemented in neuroml2::Morphology.

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

◆ operator=()

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

◆ segment() [1/3]

Morphology_base::segment_sequence & neuroml2::Morphology_base::segment ( )

Return a read-write reference to the element sequence.

Returns
A reference to the sequence container.

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

◆ segment() [2/3]

const Morphology_base::segment_sequence & neuroml2::Morphology_base::segment ( ) const

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

Returns
A constant reference to the sequence container.

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

◆ segment() [3/3]

void neuroml2::Morphology_base::segment ( const segment_sequence s)

Copy elements from a given sequence.

Parameters
sA sequence to copy elements from.

For each element in s this function makes a copy and adds it to the sequence. Note that this operation completely changes the sequence and all old elements will be lost.

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

◆ segmentGroup() [1/3]

Morphology_base::segmentGroup_sequence & neuroml2::Morphology_base::segmentGroup ( )

Return a read-write reference to the element sequence.

Returns
A reference to the sequence container.

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

◆ segmentGroup() [2/3]

const Morphology_base::segmentGroup_sequence & neuroml2::Morphology_base::segmentGroup ( ) const

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

Returns
A constant reference to the sequence container.

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

◆ segmentGroup() [3/3]

void neuroml2::Morphology_base::segmentGroup ( const segmentGroup_sequence s)

Copy elements from a given sequence.

Parameters
sA sequence to copy elements from.

For each element in s this function makes a copy and adds it to the sequence. Note that this operation completely changes the sequence and all old elements will be lost.

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


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