neuroml2::Morphology Class Reference

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

#include <NeuroML_custom.hxx>

Inheritance diagram for neuroml2::Morphology:

Collaboration diagram for neuroml2::Morphology:

Public Member Functions
unsigned	num_segments () const
Public Member Functions inherited from neuroml2::Morphology_base
const segment_sequence &	segment () const
	Return a read-only (constant) reference to the element sequence. More...
segment_sequence &	segment ()
	Return a read-write reference to the element sequence. More...
void	segment (const segment_sequence &s)
	Copy elements from a given sequence. More...
const segmentGroup_sequence &	segmentGroup () const
	Return a read-only (constant) reference to the element sequence. More...
segmentGroup_sequence &	segmentGroup ()
	Return a read-write reference to the element sequence. More...
void	segmentGroup (const segmentGroup_sequence &s)
	Copy elements from a given sequence. More...
	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...
Morphology_base &	operator= (const Morphology_base &x)
	Copy assignment operator. More...
virtual	~Morphology_base ()
	Destructor.
Public Member Functions inherited from neuroml2::Standalone
const notes_optional &	notes () const
	Return a read-only (constant) reference to the element container. More...
notes_optional &	notes ()
	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_sequence &	property () const
	Return a read-only (constant) reference to the element sequence. More...
property_sequence &	property ()
	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_optional &	annotation () const
	Return a read-only (constant) reference to the element container. More...
annotation_optional &	annotation ()
	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_optional &	metaid () const
	Return a read-only (constant) reference to the attribute container. More...
metaid_optional &	metaid ()
	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...
Standalone &	operator= (const Standalone &x)
	Copy assignment operator. More...
virtual	~Standalone ()
	Destructor.
Public Member Functions inherited from neuroml2::Base
const id_type &	id () const
	Return a read-only (constant) reference to the attribute. More...
id_type &	id ()
	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...
Base &	operator= (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.

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

Additional Inherited Members
Public Types inherited from neuroml2::Morphology_base
typedef ::neuroml2::Segment	segment_type
	Element type.
typedef ::xsd::cxx::tree::sequence< segment_type >	segment_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.
typedef ::neuroml2::SegmentGroup	segmentGroup_type
	Element type.
typedef ::xsd::cxx::tree::sequence< segmentGroup_type >	segmentGroup_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.
Public Types inherited from neuroml2::Standalone
typedef ::neuroml2::Notes	notes_type
	Element type.
typedef ::xsd::cxx::tree::optional< notes_type >	notes_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_type >	property_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_type >	annotation_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_type >	metaid_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.

Detailed Description

Class corresponding to the Morphology schema type.

Standalone element which is usually inside a single cell, but could be outside and referenced by id.

This class extends the automatically-generated definition by adding a num_segments() method.

Definition at line 131 of file NeuroML_custom.hxx.

Constructor & Destructor Documentation

Morphology() [1/2]

neuroml2::Morphology::Morphology	(	const ::xercesc::DOMElement &	e,
		::xml_schema::flags	f = 0,
		::xml_schema::container *	c = 0
	)

Create an instance from a DOM element.

Parameters

e	A DOM element to extract the data from.
f	Flags to create the new instance with.
c	A pointer to the object that will contain the new instance.

Definition at line 108 of file NeuroML_custom.cxx.

Morphology() [2/2]

neuroml2::Morphology::Morphology	(	const Morphology &	x,
		::xml_schema::flags	f = 0,
		::xml_schema::container *	c = 0
	)

Copy constructor.

Parameters

x	An instance to make a copy of.
f	Flags to create the copy with.
c	A pointer to the object that will contain the copy.

For polymorphic object models use the _clone function instead.

Definition at line 115 of file NeuroML_custom.cxx.

Member Function Documentation

_clone()

Morphology * neuroml2::Morphology::_clone ( ::xml_schema::flags  f = 0, ::xml_schema::container *  c = 0  ) const

virtual

Copy the instance polymorphically.

Parameters

f	Flags to create the copy with.
c	A 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::Morphology_base.

Definition at line 122 of file NeuroML_custom.cxx.

num_segments()

unsigned neuroml2::Morphology::num_segments

(

)

const

Returns

The number of segments present.

Definition at line 98 of file NeuroML_custom.cxx.

operator=()

Morphology & neuroml2::Morphology::operator=

(

const Morphology &

x

)

Copy assignment operator.

Parameters

x	An instance to make a copy of.

Returns

A reference to itself.

For polymorphic object models use the _clone function instead.

Definition at line 128 of file NeuroML_custom.cxx.

---

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

• /home/runner/work/NeuroML_API/NeuroML_API/src/NeuroML_custom.hxx
• /home/runner/work/NeuroML_API/NeuroML_API/src/NeuroML_custom.cxx