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

#include <NeuroML_v2.3.hxx>

Inheritance diagram for neuroml2::Region:

Collaboration diagram for neuroml2::Region:

space
Accessor and modifier functions for the space optional attribute.
typedef ::neuroml2::NmlId	space_type
	Attribute type.

typedef ::xsd::cxx::tree::optional< space_type >	space_optional
	Attribute optional container type.

typedef ::xsd::cxx::tree::traits< space_type, char >	space_traits
	Attribute traits type.

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

space_optional &	space ()
	Return a read-write reference to the attribute container. More...

void	space (const space_type &x)
	Set the attribute value. More...

void	space (const space_optional &x)
	Set the attribute value. More...

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

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

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

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

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

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

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

Initial attempt to specify 3D region for placing cells. Work in progress. . .

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

Constructor & Destructor Documentation

◆ Region() [1/2]

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

◆ Region() [2/2]

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

Member Function Documentation

◆ _clone()

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

◆ operator=()

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

◆ space() [1/5]

Region::space_optional & neuroml2::Region::space ( )

Return a read-write reference to the attribute container.

Returns: A reference to the optional container.

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

◆ space() [2/5]

const Region::space_optional & neuroml2::Region::space ( ) const

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

Returns: A constant reference to the optional container.

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

◆ space() [3/5]

void neuroml2::Region::space ( ::std::unique_ptr< space_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 14576 of file NeuroML_v2.3.cxx.

◆ space() [4/5]

void neuroml2::Region::space ( const space_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 14570 of file NeuroML_v2.3.cxx.

◆ space() [5/5]

void neuroml2::Region::space ( const space_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 14564 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

space

Constructors

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Region() [1/2]

◆ Region() [2/2]

Member Function Documentation

◆ _clone()

◆ operator=()

◆ space() [1/5]

◆ space() [2/5]

◆ space() [3/5]

◆ space() [4/5]

◆ space() [5/5]