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

#include <NeuroML_v2.3.hxx>

Inheritance diagram for neuroml2::SubTree:

Collaboration diagram for neuroml2::SubTree:

from
Accessor and modifier functions for the from optional element.
typedef ::neuroml2::SegmentEndPoint	from_type
	Element type.

typedef ::xsd::cxx::tree::optional< from_type >	from_optional
	Element optional container type.

typedef ::xsd::cxx::tree::traits< from_type, char >	from_traits
	Element traits type.

const from_optional &	from () const
	Return a read-only (constant) reference to the element container. More...

from_optional &	from ()
	Return a read-write reference to the element container. More...

void	from (const from_type &x)
	Set the element value. More...

void	from (const from_optional &x)
	Set the element value. More...

void	from (::std::unique_ptr< from_type > p)
	Set the element value without copying. More...

to
Accessor and modifier functions for the to optional element.
typedef ::neuroml2::SegmentEndPoint	to_type
	Element type.

typedef ::xsd::cxx::tree::optional< to_type >	to_optional
	Element optional container type.

typedef ::xsd::cxx::tree::traits< to_type, char >	to_traits
	Element traits type.

const to_optional &	to () const
	Return a read-only (constant) reference to the element container. More...

to_optional &	to ()
	Return a read-write reference to the element container. More...

void	to (const to_type &x)
	Set the element value. More...

void	to (const to_optional &x)
	Set the element value. More...

void	to (::std::unique_ptr< to_type > p)
	Set the element value without copying. More...

Constructors
	SubTree ()
	Create an instance from the ultimate base and initializers for required elements and attributes.

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

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

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

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

virtual	~SubTree ()
	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 SubTree schema type.

Include all the segment s distal to that specified by from in the segmentGroup

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

Constructor & Destructor Documentation

◆ SubTree() [1/2]

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

◆ SubTree() [2/2]

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

Member Function Documentation

◆ _clone()

SubTree * neuroml2::SubTree::_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::BaseWithoutId.

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

◆ from() [1/5]

SubTree::from_optional & neuroml2::SubTree::from ( )

Return a read-write reference to the element container.

Returns: A reference to the optional container.

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

◆ from() [2/5]

const SubTree::from_optional & neuroml2::SubTree::from ( ) const

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

Returns: A constant reference to the optional container.

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

◆ from() [3/5]

void neuroml2::SubTree::from ( ::std::unique_ptr< from_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 10256 of file NeuroML_v2.3.cxx.

◆ from() [4/5]

void neuroml2::SubTree::from ( const from_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 10250 of file NeuroML_v2.3.cxx.

◆ from() [5/5]

void neuroml2::SubTree::from ( const from_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 10244 of file NeuroML_v2.3.cxx.

◆ operator=()

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

◆ to() [1/5]

SubTree::to_optional & neuroml2::SubTree::to ( )

Return a read-write reference to the element container.

Returns: A reference to the optional container.

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

◆ to() [2/5]

const SubTree::to_optional & neuroml2::SubTree::to ( ) const

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

Returns: A constant reference to the optional container.

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

◆ to() [3/5]

void neuroml2::SubTree::to ( ::std::unique_ptr< to_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 10286 of file NeuroML_v2.3.cxx.

◆ to() [4/5]

void neuroml2::SubTree::to ( const to_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 10280 of file NeuroML_v2.3.cxx.

◆ to() [5/5]

void neuroml2::SubTree::to ( const to_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 10274 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

from

to

Constructors

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SubTree() [1/2]

◆ SubTree() [2/2]

Member Function Documentation

◆ _clone()

◆ from() [1/5]

◆ from() [2/5]

◆ from() [3/5]

◆ from() [4/5]

◆ from() [5/5]

◆ operator=()

◆ to() [1/5]

◆ to() [2/5]

◆ to() [3/5]

◆ to() [4/5]

◆ to() [5/5]