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

#include <NeuroML_v2.3.hxx>

Inheritance diagram for neuroml2::SegmentGroup:

Collaboration diagram for neuroml2::SegmentGroup:

notes
Accessor and modifier functions for the notes optional element.
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.

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

property
Accessor and modifier functions for the property sequence element.
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.

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

annotation
Accessor and modifier functions for the annotation optional element.
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.

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

member
Accessor and modifier functions for the member sequence element.
typedef ::neuroml2::Member	member_type
	Element type.

typedef ::xsd::cxx::tree::sequence< member_type >	member_sequence
	Element sequence container type.

typedef member_sequence::iterator	member_iterator
	Element iterator type.

typedef member_sequence::const_iterator	member_const_iterator
	Element constant iterator type.

typedef ::xsd::cxx::tree::traits< member_type, char >	member_traits
	Element traits type.

const member_sequence &	member () const
	Return a read-only (constant) reference to the element sequence. More...

member_sequence &	member ()
	Return a read-write reference to the element sequence. More...

void	member (const member_sequence &s)
	Copy elements from a given sequence. More...

include
Accessor and modifier functions for the include sequence element.
typedef ::neuroml2::Include	include_type
	Element type.

typedef ::xsd::cxx::tree::sequence< include_type >	include_sequence
	Element sequence container type.

typedef include_sequence::iterator	include_iterator
	Element iterator type.

typedef include_sequence::const_iterator	include_const_iterator
	Element constant iterator type.

typedef ::xsd::cxx::tree::traits< include_type, char >	include_traits
	Element traits type.

const include_sequence &	include () const
	Return a read-only (constant) reference to the element sequence. More...

include_sequence &	include ()
	Return a read-write reference to the element sequence. More...

void	include (const include_sequence &s)
	Copy elements from a given sequence. More...

path
Accessor and modifier functions for the path sequence element.
typedef ::neuroml2::Path	path_type
	Element type.

typedef ::xsd::cxx::tree::sequence< path_type >	path_sequence
	Element sequence container type.

typedef path_sequence::iterator	path_iterator
	Element iterator type.

typedef path_sequence::const_iterator	path_const_iterator
	Element constant iterator type.

typedef ::xsd::cxx::tree::traits< path_type, char >	path_traits
	Element traits type.

const path_sequence &	path () const
	Return a read-only (constant) reference to the element sequence. More...

path_sequence &	path ()
	Return a read-write reference to the element sequence. More...

void	path (const path_sequence &s)
	Copy elements from a given sequence. More...

subTree
Accessor and modifier functions for the subTree sequence element.
typedef ::neuroml2::SubTree	subTree_type
	Element type.

typedef ::xsd::cxx::tree::sequence< subTree_type >	subTree_sequence
	Element sequence container type.

typedef subTree_sequence::iterator	subTree_iterator
	Element iterator type.

typedef subTree_sequence::const_iterator	subTree_const_iterator
	Element constant iterator type.

typedef ::xsd::cxx::tree::traits< subTree_type, char >	subTree_traits
	Element traits type.

const subTree_sequence &	subTree () const
	Return a read-only (constant) reference to the element sequence. More...

subTree_sequence &	subTree ()
	Return a read-write reference to the element sequence. More...

void	subTree (const subTree_sequence &s)
	Copy elements from a given sequence. More...

inhomogeneousParameter
Accessor and modifier functions for the inhomogeneousParameter sequence element.
typedef ::neuroml2::InhomogeneousParameter	inhomogeneousParameter_type
	Element type.

typedef ::xsd::cxx::tree::sequence< inhomogeneousParameter_type >	inhomogeneousParameter_sequence
	Element sequence container type.

typedef inhomogeneousParameter_sequence::iterator	inhomogeneousParameter_iterator
	Element iterator type.

typedef inhomogeneousParameter_sequence::const_iterator	inhomogeneousParameter_const_iterator
	Element constant iterator type.

typedef ::xsd::cxx::tree::traits< inhomogeneousParameter_type, char >	inhomogeneousParameter_traits
	Element traits type.

const inhomogeneousParameter_sequence &	inhomogeneousParameter () const
	Return a read-only (constant) reference to the element sequence. More...

inhomogeneousParameter_sequence &	inhomogeneousParameter ()
	Return a read-write reference to the element sequence. More...

void	inhomogeneousParameter (const inhomogeneousParameter_sequence &s)
	Copy elements from a given sequence. More...

neuroLexId
Accessor and modifier functions for the neuroLexId optional attribute.
typedef ::neuroml2::NeuroLexId	neuroLexId_type
	Attribute type.

typedef ::xsd::cxx::tree::optional< neuroLexId_type >	neuroLexId_optional
	Attribute optional container type.

typedef ::xsd::cxx::tree::traits< neuroLexId_type, char >	neuroLexId_traits
	Attribute traits type.

const neuroLexId_optional &	neuroLexId () const
	Return a read-only (constant) reference to the attribute container. More...

neuroLexId_optional &	neuroLexId ()
	Return a read-write reference to the attribute container. More...

void	neuroLexId (const neuroLexId_type &x)
	Set the attribute value. More...

void	neuroLexId (const neuroLexId_optional &x)
	Set the attribute value. More...

void	neuroLexId (::std::unique_ptr< neuroLexId_type > p)
	Set the attribute value without copying. More...

Constructors
	SegmentGroup (const id_type &)
	Create an instance from the ultimate base and initializers for required elements and attributes.

	SegmentGroup (const ::xercesc::DOMElement &e, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
	Create an instance from a DOM element. More...

	SegmentGroup (const SegmentGroup &x, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
	Copy constructor. More...

virtual SegmentGroup *	_clone (::xml_schema::flags f=0, ::xml_schema::container *c=0) const
	Copy the instance polymorphically. More...

SegmentGroup &	operator= (const SegmentGroup &x)
	Copy assignment operator. More...

virtual	~SegmentGroup ()
	Destructor.

Additional Inherited Members
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::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.

Detailed Description

Class corresponding to the SegmentGroup schema type.

A method to describe a group of segment s in a morphology , e. g. soma_group, dendrite_group, axon_group. While a name is useful to describe the group, the neuroLexId attribute can be used to explicitly specify the meaning of the group, e. g. sao1044911821 for 'Neuronal Cell Body', sao1211023249 for 'Dendrite'. The segment s in this group can be specified as: a list of individual member segments; a path , all of the segments along which should be included; a subTree of the cell to include; other segmentGroups to include ( so all segments from those get included here ). An inhomogeneousParameter can be defined on the region of the cell specified by this group ( see variableParameter for usage ).

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

Constructor & Destructor Documentation

◆ SegmentGroup() [1/2]

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

◆ SegmentGroup() [2/2]

neuroml2::SegmentGroup::SegmentGroup	(	const SegmentGroup &	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 34913 of file NeuroML_v2.3.cxx.

Member Function Documentation

◆ _clone()

SegmentGroup * neuroml2::SegmentGroup::_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::Base.

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

◆ annotation() [1/5]

SegmentGroup::annotation_optional & neuroml2::SegmentGroup::annotation ( )

Return a read-write reference to the element container.

Returns: A reference to the optional container.

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

◆ annotation() [2/5]

const SegmentGroup::annotation_optional & neuroml2::SegmentGroup::annotation ( ) const

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

Returns: A constant reference to the optional container.

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

◆ annotation() [3/5]

void neuroml2::SegmentGroup::annotation ( ::std::unique_ptr< annotation_type > p )

Set the element value without copying.

Parameters

p	A new value to use.

This function will try to use the passed value directly instead of making a copy.

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

◆ annotation() [4/5]

void neuroml2::SegmentGroup::annotation ( const annotation_optional & x )

Set the element value.

Parameters

x	An optional container with the new value to set.

If the value is present in x then this function makes a copy of this value and sets it as the new value of the element. Otherwise the element container is set the 'not present' state.

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

◆ annotation() [5/5]

void neuroml2::SegmentGroup::annotation ( const annotation_type & x )

Set the element value.

Parameters

x	A new value to set.

This function makes a copy of its argument and sets it as the new value of the element.

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

◆ include() [1/3]

SegmentGroup::include_sequence & neuroml2::SegmentGroup::include ( )

Return a read-write reference to the element sequence.

Returns: A reference to the sequence container.

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

◆ include() [2/3]

const SegmentGroup::include_sequence & neuroml2::SegmentGroup::include ( ) const

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

Returns: A constant reference to the sequence container.

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

◆ include() [3/3]

void neuroml2::SegmentGroup::include ( const include_sequence & s )

Copy elements from a given sequence.

Parameters

s	A 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 9817 of file NeuroML_v2.3.cxx.

◆ inhomogeneousParameter() [1/3]

SegmentGroup::inhomogeneousParameter_sequence & neuroml2::SegmentGroup::inhomogeneousParameter ( )

Return a read-write reference to the element sequence.

Returns: A reference to the sequence container.

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

◆ inhomogeneousParameter() [2/3]

const SegmentGroup::inhomogeneousParameter_sequence & neuroml2::SegmentGroup::inhomogeneousParameter ( ) const

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

Returns: A constant reference to the sequence container.

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

◆ inhomogeneousParameter() [3/3]

void neuroml2::SegmentGroup::inhomogeneousParameter ( const inhomogeneousParameter_sequence & s )

Copy elements from a given sequence.

Parameters

s	A 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 9871 of file NeuroML_v2.3.cxx.

◆ member() [1/3]

SegmentGroup::member_sequence & neuroml2::SegmentGroup::member ( )

Return a read-write reference to the element sequence.

Returns: A reference to the sequence container.

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

◆ member() [2/3]

const SegmentGroup::member_sequence & neuroml2::SegmentGroup::member ( ) const

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

Returns: A constant reference to the sequence container.

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

◆ member() [3/3]

void neuroml2::SegmentGroup::member ( const member_sequence & s )

Copy elements from a given sequence.

Parameters

s	A 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 9799 of file NeuroML_v2.3.cxx.

◆ neuroLexId() [1/5]

SegmentGroup::neuroLexId_optional & neuroml2::SegmentGroup::neuroLexId ( )

Return a read-write reference to the attribute container.

Returns: A reference to the optional container.

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

◆ neuroLexId() [2/5]

const SegmentGroup::neuroLexId_optional & neuroml2::SegmentGroup::neuroLexId ( ) const

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

Returns: A constant reference to the optional container.

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

◆ neuroLexId() [3/5]

void neuroml2::SegmentGroup::neuroLexId ( ::std::unique_ptr< neuroLexId_type > p )

Set the attribute value without copying.

Parameters

p	A new value to use.

This function will try to use the passed value directly instead of making a copy.

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

◆ neuroLexId() [4/5]

void neuroml2::SegmentGroup::neuroLexId ( const neuroLexId_optional & x )

Set the attribute value.

Parameters

x	An optional container with the new value to set.

If the value is present in x then this function makes a copy of this value and sets it as the new value of the attribute. Otherwise the attribute container is set the 'not present' state.

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

◆ neuroLexId() [5/5]

void neuroml2::SegmentGroup::neuroLexId ( const neuroLexId_type & x )

Set the attribute value.

Parameters

x	A 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 9889 of file NeuroML_v2.3.cxx.

◆ notes() [1/5]

SegmentGroup::notes_optional & neuroml2::SegmentGroup::notes ( )

Return a read-write reference to the element container.

Returns: A reference to the optional container.

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

◆ notes() [2/5]

const SegmentGroup::notes_optional & neuroml2::SegmentGroup::notes ( ) const

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

Returns: A constant reference to the optional container.

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

◆ notes() [3/5]

void neuroml2::SegmentGroup::notes ( ::std::unique_ptr< notes_type > p )

Set the element value without copying.

Parameters

p	A new value to use.

This function will try to use the passed value directly instead of making a copy.

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

◆ notes() [4/5]

void neuroml2::SegmentGroup::notes ( const notes_optional & x )

Set the element value.

Parameters

x	An optional container with the new value to set.

If the value is present in x then this function makes a copy of this value and sets it as the new value of the element. Otherwise the element container is set the 'not present' state.

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

◆ notes() [5/5]

void neuroml2::SegmentGroup::notes ( const notes_type & x )

Set the element value.

Parameters

x	A new value to set.

This function makes a copy of its argument and sets it as the new value of the element.

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

◆ operator=()

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

◆ path() [1/3]

SegmentGroup::path_sequence & neuroml2::SegmentGroup::path ( )

Return a read-write reference to the element sequence.

Returns: A reference to the sequence container.

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

◆ path() [2/3]

const SegmentGroup::path_sequence & neuroml2::SegmentGroup::path ( ) const

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

Returns: A constant reference to the sequence container.

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

◆ path() [3/3]

void neuroml2::SegmentGroup::path ( const path_sequence & s )

Copy elements from a given sequence.

Parameters

s	A 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 9835 of file NeuroML_v2.3.cxx.

◆ property() [1/3]

SegmentGroup::property_sequence & neuroml2::SegmentGroup::property ( )

Return a read-write reference to the element sequence.

Returns: A reference to the sequence container.

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

◆ property() [2/3]

const SegmentGroup::property_sequence & neuroml2::SegmentGroup::property ( ) const

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

Returns: A constant reference to the sequence container.

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

◆ property() [3/3]

void neuroml2::SegmentGroup::property ( const property_sequence & s )

Copy elements from a given sequence.

Parameters

s	A 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 9751 of file NeuroML_v2.3.cxx.

◆ subTree() [1/3]

SegmentGroup::subTree_sequence & neuroml2::SegmentGroup::subTree ( )

Return a read-write reference to the element sequence.

Returns: A reference to the sequence container.

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

◆ subTree() [2/3]

const SegmentGroup::subTree_sequence & neuroml2::SegmentGroup::subTree ( ) const

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

Returns: A constant reference to the sequence container.

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

◆ subTree() [3/3]

void neuroml2::SegmentGroup::subTree ( const subTree_sequence & s )

Copy elements from a given sequence.

Parameters

s	A 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 9853 of file NeuroML_v2.3.cxx.

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

src/NeuroML_v2.3.hxx
src/NeuroML_v2.3.cxx

notes

property

annotation

member

include

path

subTree

inhomogeneousParameter

neuroLexId

Constructors

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SegmentGroup() [1/2]

◆ SegmentGroup() [2/2]

Member Function Documentation

◆ _clone()

◆ annotation() [1/5]

◆ annotation() [2/5]

◆ annotation() [3/5]

◆ annotation() [4/5]

◆ annotation() [5/5]

◆ include() [1/3]

◆ include() [2/3]

◆ include() [3/3]

◆ inhomogeneousParameter() [1/3]

◆ inhomogeneousParameter() [2/3]

◆ inhomogeneousParameter() [3/3]

◆ member() [1/3]

◆ member() [2/3]

◆ member() [3/3]

◆ neuroLexId() [1/5]

◆ neuroLexId() [2/5]

◆ neuroLexId() [3/5]

◆ neuroLexId() [4/5]

◆ neuroLexId() [5/5]

◆ notes() [1/5]

◆ notes() [2/5]

◆ notes() [3/5]

◆ notes() [4/5]

◆ notes() [5/5]

◆ operator=()

◆ path() [1/3]

◆ path() [2/3]

◆ path() [3/3]

◆ property() [1/3]

◆ property() [2/3]

◆ property() [3/3]

◆ subTree() [1/3]

◆ subTree() [2/3]

◆ subTree() [3/3]