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

#include <NeuroML_v2.3.hxx>

Inheritance diagram for neuroml2::Instance:

Collaboration diagram for neuroml2::Instance:

location
Accessor and modifier functions for the location required element.
typedef ::neuroml2::Location	location_type
	Element type.

typedef ::xsd::cxx::tree::traits< location_type, char >	location_traits
	Element traits type.

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

location_type &	location ()
	Return a read-write reference to the element. More...

void	location (const location_type &x)
	Set the element value. More...

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

id
Accessor and modifier functions for the id optional attribute.
typedef ::xml_schema::non_negative_integer	id_type
	Attribute type.

typedef ::xsd::cxx::tree::optional< id_type >	id_optional
	Attribute optional container type.

typedef ::xsd::cxx::tree::traits< id_type, char >	id_traits
	Attribute traits type.

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

id_optional &	id ()
	Return a read-write reference to the attribute container. More...

void	id (const id_type &x)
	Set the attribute value. More...

void	id (const id_optional &x)
	Set the attribute value. More...

i
Accessor and modifier functions for the i optional attribute.
typedef ::xml_schema::non_negative_integer	i_type
	Attribute type.

typedef ::xsd::cxx::tree::optional< i_type >	i_optional
	Attribute optional container type.

typedef ::xsd::cxx::tree::traits< i_type, char >	i_traits
	Attribute traits type.

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

i_optional &	i ()
	Return a read-write reference to the attribute container. More...

void	i (const i_type &x)
	Set the attribute value. More...

void	i (const i_optional &x)
	Set the attribute value. More...

j
Accessor and modifier functions for the j optional attribute.
typedef ::xml_schema::non_negative_integer	j_type
	Attribute type.

typedef ::xsd::cxx::tree::optional< j_type >	j_optional
	Attribute optional container type.

typedef ::xsd::cxx::tree::traits< j_type, char >	j_traits
	Attribute traits type.

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

j_optional &	j ()
	Return a read-write reference to the attribute container. More...

void	j (const j_type &x)
	Set the attribute value. More...

void	j (const j_optional &x)
	Set the attribute value. More...

k
Accessor and modifier functions for the k optional attribute.
typedef ::xml_schema::non_negative_integer	k_type
	Attribute type.

typedef ::xsd::cxx::tree::optional< k_type >	k_optional
	Attribute optional container type.

typedef ::xsd::cxx::tree::traits< k_type, char >	k_traits
	Attribute traits type.

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

k_optional &	k ()
	Return a read-write reference to the attribute container. More...

void	k (const k_type &x)
	Set the attribute value. More...

void	k (const k_optional &x)
	Set the attribute value. More...

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

	Instance (::std::unique_ptr< location_type >)
	Create an instance from the ultimate base and initializers for required elements and attributes (::std::unique_ptr version). More...

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

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

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

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

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

Specifies a single instance of a component in a population ( placed at location ).

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

Constructor & Destructor Documentation

◆ Instance() [1/3]

neuroml2::Instance::Instance ( ::std::unique_ptr< location_type > location )

Create an instance from the ultimate base and initializers for required elements and attributes (::std::unique_ptr version).

This constructor will try to use the passed values directly instead of making copies.

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

◆ Instance() [2/3]

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

◆ Instance() [3/3]

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

Member Function Documentation

◆ _clone()

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

◆ i() [1/4]

Instance::i_optional & neuroml2::Instance::i ( )

Return a read-write reference to the attribute container.

Returns: A reference to the optional container.

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

◆ i() [2/4]

const Instance::i_optional & neuroml2::Instance::i ( ) const

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

Returns: A constant reference to the optional container.

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

◆ i() [3/4]

void neuroml2::Instance::i ( const i_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 15179 of file NeuroML_v2.3.cxx.

◆ i() [4/4]

void neuroml2::Instance::i ( const i_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 15173 of file NeuroML_v2.3.cxx.

◆ id() [1/4]

Instance::id_optional & neuroml2::Instance::id ( )

Return a read-write reference to the attribute container.

Returns: A reference to the optional container.

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

◆ id() [2/4]

const Instance::id_optional & neuroml2::Instance::id ( ) const

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

Returns: A constant reference to the optional container.

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

◆ id() [3/4]

void neuroml2::Instance::id ( const id_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 15155 of file NeuroML_v2.3.cxx.

◆ id() [4/4]

void neuroml2::Instance::id ( const id_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 15149 of file NeuroML_v2.3.cxx.

◆ j() [1/4]

Instance::j_optional & neuroml2::Instance::j ( )

Return a read-write reference to the attribute container.

Returns: A reference to the optional container.

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

◆ j() [2/4]

const Instance::j_optional & neuroml2::Instance::j ( ) const

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

Returns: A constant reference to the optional container.

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

◆ j() [3/4]

void neuroml2::Instance::j ( const j_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 15203 of file NeuroML_v2.3.cxx.

◆ j() [4/4]

void neuroml2::Instance::j ( const j_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 15197 of file NeuroML_v2.3.cxx.

◆ k() [1/4]

Instance::k_optional & neuroml2::Instance::k ( )

Return a read-write reference to the attribute container.

Returns: A reference to the optional container.

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

◆ k() [2/4]

const Instance::k_optional & neuroml2::Instance::k ( ) const

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

Returns: A constant reference to the optional container.

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

◆ k() [3/4]

void neuroml2::Instance::k ( const k_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 15227 of file NeuroML_v2.3.cxx.

◆ k() [4/4]

void neuroml2::Instance::k ( const k_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 15221 of file NeuroML_v2.3.cxx.

◆ location() [1/4]

Instance::location_type & neuroml2::Instance::location ( )

Return a read-write reference to the element.

Returns: A reference to the element.

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

◆ location() [2/4]

const Instance::location_type & neuroml2::Instance::location ( ) const

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

Returns: A constant reference to the element.

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

◆ location() [3/4]

void neuroml2::Instance::location ( ::std::unique_ptr< location_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 15131 of file NeuroML_v2.3.cxx.

◆ location() [4/4]

void neuroml2::Instance::location ( const location_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 15125 of file NeuroML_v2.3.cxx.

◆ operator=()

Instance & neuroml2::Instance::operator= ( const Instance & 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 44671 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

location

id

i

j

k

Constructors

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Instance() [1/3]

◆ Instance() [2/3]

◆ Instance() [3/3]

Member Function Documentation

◆ _clone()

◆ i() [1/4]

◆ i() [2/4]

◆ i() [3/4]

◆ i() [4/4]

◆ id() [1/4]

◆ id() [2/4]

◆ id() [3/4]

◆ id() [4/4]

◆ j() [1/4]

◆ j() [2/4]

◆ j() [3/4]

◆ j() [4/4]

◆ k() [1/4]

◆ k() [2/4]

◆ k() [3/4]

◆ k() [4/4]

◆ location() [1/4]

◆ location() [2/4]

◆ location() [3/4]

◆ location() [4/4]

◆ operator=()