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

#include <NeuroML_v2.3.hxx>

Inheritance diagram for neuroml2::ComponentType:

Collaboration diagram for neuroml2::ComponentType:

Property
Accessor and modifier functions for the Property sequence element.
typedef ::neuroml2::LEMS_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...

Parameter
Accessor and modifier functions for the Parameter sequence element.
typedef ::neuroml2::Parameter	Parameter_type
	Element type.

typedef ::xsd::cxx::tree::sequence< Parameter_type >	Parameter_sequence
	Element sequence container type.

typedef Parameter_sequence::iterator	Parameter_iterator
	Element iterator type.

typedef Parameter_sequence::const_iterator	Parameter_const_iterator
	Element constant iterator type.

typedef ::xsd::cxx::tree::traits< Parameter_type, char >	Parameter_traits
	Element traits type.

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

Parameter_sequence &	Parameter ()
	Return a read-write reference to the element sequence. More...

void	Parameter (const Parameter_sequence &s)
	Copy elements from a given sequence. More...

DerivedParameter
Accessor and modifier functions for the DerivedParameter sequence element.
typedef ::neuroml2::DerivedParameter	DerivedParameter_type
	Element type.

typedef ::xsd::cxx::tree::sequence< DerivedParameter_type >	DerivedParameter_sequence
	Element sequence container type.

typedef DerivedParameter_sequence::iterator	DerivedParameter_iterator
	Element iterator type.

typedef DerivedParameter_sequence::const_iterator	DerivedParameter_const_iterator
	Element constant iterator type.

typedef ::xsd::cxx::tree::traits< DerivedParameter_type, char >	DerivedParameter_traits
	Element traits type.

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

DerivedParameter_sequence &	DerivedParameter ()
	Return a read-write reference to the element sequence. More...

void	DerivedParameter (const DerivedParameter_sequence &s)
	Copy elements from a given sequence. More...

Constant
Accessor and modifier functions for the Constant sequence element.
typedef ::neuroml2::Constant	Constant_type
	Element type.

typedef ::xsd::cxx::tree::sequence< Constant_type >	Constant_sequence
	Element sequence container type.

typedef Constant_sequence::iterator	Constant_iterator
	Element iterator type.

typedef Constant_sequence::const_iterator	Constant_const_iterator
	Element constant iterator type.

typedef ::xsd::cxx::tree::traits< Constant_type, char >	Constant_traits
	Element traits type.

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

Constant_sequence &	Constant ()
	Return a read-write reference to the element sequence. More...

void	Constant (const Constant_sequence &s)
	Copy elements from a given sequence. More...

Exposure
Accessor and modifier functions for the Exposure sequence element.
typedef ::neuroml2::Exposure	Exposure_type
	Element type.

typedef ::xsd::cxx::tree::sequence< Exposure_type >	Exposure_sequence
	Element sequence container type.

typedef Exposure_sequence::iterator	Exposure_iterator
	Element iterator type.

typedef Exposure_sequence::const_iterator	Exposure_const_iterator
	Element constant iterator type.

typedef ::xsd::cxx::tree::traits< Exposure_type, char >	Exposure_traits
	Element traits type.

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

Exposure_sequence &	Exposure ()
	Return a read-write reference to the element sequence. More...

void	Exposure (const Exposure_sequence &s)
	Copy elements from a given sequence. More...

Requirement
Accessor and modifier functions for the Requirement sequence element.
typedef ::neuroml2::Requirement	Requirement_type
	Element type.

typedef ::xsd::cxx::tree::sequence< Requirement_type >	Requirement_sequence
	Element sequence container type.

typedef Requirement_sequence::iterator	Requirement_iterator
	Element iterator type.

typedef Requirement_sequence::const_iterator	Requirement_const_iterator
	Element constant iterator type.

typedef ::xsd::cxx::tree::traits< Requirement_type, char >	Requirement_traits
	Element traits type.

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

Requirement_sequence &	Requirement ()
	Return a read-write reference to the element sequence. More...

void	Requirement (const Requirement_sequence &s)
	Copy elements from a given sequence. More...

InstanceRequirement
Accessor and modifier functions for the InstanceRequirement sequence element.
typedef ::neuroml2::InstanceRequirement	InstanceRequirement_type
	Element type.

typedef ::xsd::cxx::tree::sequence< InstanceRequirement_type >	InstanceRequirement_sequence
	Element sequence container type.

typedef InstanceRequirement_sequence::iterator	InstanceRequirement_iterator
	Element iterator type.

typedef InstanceRequirement_sequence::const_iterator	InstanceRequirement_const_iterator
	Element constant iterator type.

typedef ::xsd::cxx::tree::traits< InstanceRequirement_type, char >	InstanceRequirement_traits
	Element traits type.

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

InstanceRequirement_sequence &	InstanceRequirement ()
	Return a read-write reference to the element sequence. More...

void	InstanceRequirement (const InstanceRequirement_sequence &s)
	Copy elements from a given sequence. More...

Dynamics
Accessor and modifier functions for the Dynamics sequence element.
typedef ::neuroml2::Dynamics	Dynamics_type
	Element type.

typedef ::xsd::cxx::tree::sequence< Dynamics_type >	Dynamics_sequence
	Element sequence container type.

typedef Dynamics_sequence::iterator	Dynamics_iterator
	Element iterator type.

typedef Dynamics_sequence::const_iterator	Dynamics_const_iterator
	Element constant iterator type.

typedef ::xsd::cxx::tree::traits< Dynamics_type, char >	Dynamics_traits
	Element traits type.

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

Dynamics_sequence &	Dynamics ()
	Return a read-write reference to the element sequence. More...

void	Dynamics (const Dynamics_sequence &s)
	Copy elements from a given sequence. More...

name
Accessor and modifier functions for the name required attribute.
typedef ::xml_schema::string	name_type
	Attribute type.

typedef ::xsd::cxx::tree::traits< name_type, char >	name_traits
	Attribute traits type.

const name_type &	name () const
	Return a read-only (constant) reference to the attribute. More...

name_type &	name ()
	Return a read-write reference to the attribute. More...

void	name (const name_type &x)
	Set the attribute value. More...

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

extends
Accessor and modifier functions for the extends optional attribute.
typedef ::xml_schema::string	extends_type
	Attribute type.

typedef ::xsd::cxx::tree::optional< extends_type >	extends_optional
	Attribute optional container type.

typedef ::xsd::cxx::tree::traits< extends_type, char >	extends_traits
	Attribute traits type.

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

extends_optional &	extends ()
	Return a read-write reference to the attribute container. More...

void	extends (const extends_type &x)
	Set the attribute value. More...

void	extends (const extends_optional &x)
	Set the attribute value. More...

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

description
Accessor and modifier functions for the description optional attribute.
typedef ::xml_schema::string	description_type
	Attribute type.

typedef ::xsd::cxx::tree::optional< description_type >	description_optional
	Attribute optional container type.

typedef ::xsd::cxx::tree::traits< description_type, char >	description_traits
	Attribute traits type.

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

description_optional &	description ()
	Return a read-write reference to the attribute container. More...

void	description (const description_type &x)
	Set the attribute value. More...

void	description (const description_optional &x)
	Set the attribute value. More...

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

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

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

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

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

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

virtual	~ComponentType ()
	Destructor.

Detailed Description

Class corresponding to the ComponentType schema type.

Contains an extension to NeuroML by creating custom LEMS ComponentType. *

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

Constructor & Destructor Documentation

◆ ComponentType() [1/2]

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

◆ ComponentType() [2/2]

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

Member Function Documentation

◆ _clone()

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

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

◆ Constant() [1/3]

ComponentType::Constant_sequence & neuroml2::ComponentType::Constant ( )

Return a read-write reference to the element sequence.

Returns: A reference to the sequence container.

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

◆ Constant() [2/3]

const ComponentType::Constant_sequence & neuroml2::ComponentType::Constant ( ) const

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

Returns: A constant reference to the sequence container.

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

◆ Constant() [3/3]

void neuroml2::ComponentType::Constant ( const Constant_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 300 of file NeuroML_v2.3.cxx.

◆ DerivedParameter() [1/3]

ComponentType::DerivedParameter_sequence & neuroml2::ComponentType::DerivedParameter ( )

Return a read-write reference to the element sequence.

Returns: A reference to the sequence container.

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

◆ DerivedParameter() [2/3]

const ComponentType::DerivedParameter_sequence & neuroml2::ComponentType::DerivedParameter ( ) const

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

Returns: A constant reference to the sequence container.

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

◆ DerivedParameter() [3/3]

void neuroml2::ComponentType::DerivedParameter ( const DerivedParameter_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 282 of file NeuroML_v2.3.cxx.

◆ description() [1/5]

ComponentType::description_optional & neuroml2::ComponentType::description ( )

Return a read-write reference to the attribute container.

Returns: A reference to the optional container.

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

◆ description() [2/5]

const ComponentType::description_optional & neuroml2::ComponentType::description ( ) const

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

Returns: A constant reference to the optional container.

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

◆ description() [3/5]

void neuroml2::ComponentType::description ( ::std::unique_ptr< description_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 456 of file NeuroML_v2.3.cxx.

◆ description() [4/5]

void neuroml2::ComponentType::description ( const description_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 450 of file NeuroML_v2.3.cxx.

◆ description() [5/5]

void neuroml2::ComponentType::description ( const description_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 444 of file NeuroML_v2.3.cxx.

◆ Dynamics() [1/3]

ComponentType::Dynamics_sequence & neuroml2::ComponentType::Dynamics ( )

Return a read-write reference to the element sequence.

Returns: A reference to the sequence container.

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

◆ Dynamics() [2/3]

const ComponentType::Dynamics_sequence & neuroml2::ComponentType::Dynamics ( ) const

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

Returns: A constant reference to the sequence container.

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

◆ Dynamics() [3/3]

void neuroml2::ComponentType::Dynamics ( const Dynamics_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 372 of file NeuroML_v2.3.cxx.

◆ Exposure() [1/3]

ComponentType::Exposure_sequence & neuroml2::ComponentType::Exposure ( )

Return a read-write reference to the element sequence.

Returns: A reference to the sequence container.

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

◆ Exposure() [2/3]

const ComponentType::Exposure_sequence & neuroml2::ComponentType::Exposure ( ) const

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

Returns: A constant reference to the sequence container.

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

◆ Exposure() [3/3]

void neuroml2::ComponentType::Exposure ( const Exposure_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 318 of file NeuroML_v2.3.cxx.

◆ extends() [1/5]

ComponentType::extends_optional & neuroml2::ComponentType::extends ( )

Return a read-write reference to the attribute container.

Returns: A reference to the optional container.

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

◆ extends() [2/5]

const ComponentType::extends_optional & neuroml2::ComponentType::extends ( ) const

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

Returns: A constant reference to the optional container.

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

◆ extends() [3/5]

void neuroml2::ComponentType::extends ( ::std::unique_ptr< extends_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 426 of file NeuroML_v2.3.cxx.

◆ extends() [4/5]

void neuroml2::ComponentType::extends ( const extends_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 420 of file NeuroML_v2.3.cxx.

◆ extends() [5/5]

void neuroml2::ComponentType::extends ( const extends_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 414 of file NeuroML_v2.3.cxx.

◆ InstanceRequirement() [1/3]

ComponentType::InstanceRequirement_sequence & neuroml2::ComponentType::InstanceRequirement ( )

Return a read-write reference to the element sequence.

Returns: A reference to the sequence container.

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

◆ InstanceRequirement() [2/3]

const ComponentType::InstanceRequirement_sequence & neuroml2::ComponentType::InstanceRequirement ( ) const

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

Returns: A constant reference to the sequence container.

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

◆ InstanceRequirement() [3/3]

void neuroml2::ComponentType::InstanceRequirement ( const InstanceRequirement_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 354 of file NeuroML_v2.3.cxx.

◆ name() [1/4]

ComponentType::name_type & neuroml2::ComponentType::name ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ name() [2/4]

const ComponentType::name_type & neuroml2::ComponentType::name ( ) const

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

Returns: A constant reference to the attribute.

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

◆ name() [3/4]

void neuroml2::ComponentType::name ( ::std::unique_ptr< name_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 396 of file NeuroML_v2.3.cxx.

◆ name() [4/4]

void neuroml2::ComponentType::name ( const name_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 390 of file NeuroML_v2.3.cxx.

◆ operator=()

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

◆ Parameter() [1/3]

ComponentType::Parameter_sequence & neuroml2::ComponentType::Parameter ( )

Return a read-write reference to the element sequence.

Returns: A reference to the sequence container.

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

◆ Parameter() [2/3]

const ComponentType::Parameter_sequence & neuroml2::ComponentType::Parameter ( ) const

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

Returns: A constant reference to the sequence container.

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

◆ Parameter() [3/3]

void neuroml2::ComponentType::Parameter ( const Parameter_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 264 of file NeuroML_v2.3.cxx.

◆ Property() [1/3]

ComponentType::Property_sequence & neuroml2::ComponentType::Property ( )

Return a read-write reference to the element sequence.

Returns: A reference to the sequence container.

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

◆ Property() [2/3]

const ComponentType::Property_sequence & neuroml2::ComponentType::Property ( ) const

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

Returns: A constant reference to the sequence container.

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

◆ Property() [3/3]

void neuroml2::ComponentType::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 246 of file NeuroML_v2.3.cxx.

◆ Requirement() [1/3]

ComponentType::Requirement_sequence & neuroml2::ComponentType::Requirement ( )

Return a read-write reference to the element sequence.

Returns: A reference to the sequence container.

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

◆ Requirement() [2/3]

const ComponentType::Requirement_sequence & neuroml2::ComponentType::Requirement ( ) const

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

Returns: A constant reference to the sequence container.

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

◆ Requirement() [3/3]

void neuroml2::ComponentType::Requirement ( const Requirement_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 336 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

Property

Parameter

DerivedParameter

Constant

Exposure

Requirement

InstanceRequirement

Dynamics

name

extends

description

Constructors

Detailed Description

Constructor & Destructor Documentation

◆ ComponentType() [1/2]

◆ ComponentType() [2/2]

Member Function Documentation

◆ _clone()

◆ Constant() [1/3]

◆ Constant() [2/3]

◆ Constant() [3/3]

◆ DerivedParameter() [1/3]

◆ DerivedParameter() [2/3]

◆ DerivedParameter() [3/3]

◆ description() [1/5]

◆ description() [2/5]

◆ description() [3/5]

◆ description() [4/5]

◆ description() [5/5]

◆ Dynamics() [1/3]

◆ Dynamics() [2/3]

◆ Dynamics() [3/3]

◆ Exposure() [1/3]

◆ Exposure() [2/3]

◆ Exposure() [3/3]

◆ extends() [1/5]

◆ extends() [2/5]

◆ extends() [3/5]

◆ extends() [4/5]

◆ extends() [5/5]

◆ InstanceRequirement() [1/3]

◆ InstanceRequirement() [2/3]

◆ InstanceRequirement() [3/3]

◆ name() [1/4]

◆ name() [2/4]

◆ name() [3/4]

◆ name() [4/4]

◆ operator=()

◆ Parameter() [1/3]

◆ Parameter() [2/3]

◆ Parameter() [3/3]

◆ Property() [1/3]

◆ Property() [2/3]

◆ Property() [3/3]

◆ Requirement() [1/3]

◆ Requirement() [2/3]

◆ Requirement() [3/3]