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

#include <NeuroML_v2.3.hxx>

Inheritance diagram for neuroml2::BlockMechanism:

Collaboration diagram for neuroml2::BlockMechanism:

type
Accessor and modifier functions for the type required attribute.
typedef ::neuroml2::BlockTypes	type_type
	Attribute type.

typedef ::xsd::cxx::tree::traits< type_type, char >	type_traits
	Attribute traits type.

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

type_type &	type ()
	Return a read-write reference to the attribute. More...

void	type (const type_type &x)
	Set the attribute value. More...

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

species
Accessor and modifier functions for the species required attribute.
typedef ::neuroml2::NmlId	species_type
	Attribute type.

typedef ::xsd::cxx::tree::traits< species_type, char >	species_traits
	Attribute traits type.

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

species_type &	species ()
	Return a read-write reference to the attribute. More...

void	species (const species_type &x)
	Set the attribute value. More...

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

blockConcentration
Accessor and modifier functions for the blockConcentration required attribute.
typedef ::neuroml2::Nml2Quantity_concentration	blockConcentration_type
	Attribute type.

typedef ::xsd::cxx::tree::traits< blockConcentration_type, char >	blockConcentration_traits
	Attribute traits type.

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

blockConcentration_type &	blockConcentration ()
	Return a read-write reference to the attribute. More...

void	blockConcentration (const blockConcentration_type &x)
	Set the attribute value. More...

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

scalingConc
Accessor and modifier functions for the scalingConc required attribute.
typedef ::neuroml2::Nml2Quantity_concentration	scalingConc_type
	Attribute type.

typedef ::xsd::cxx::tree::traits< scalingConc_type, char >	scalingConc_traits
	Attribute traits type.

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

scalingConc_type &	scalingConc ()
	Return a read-write reference to the attribute. More...

void	scalingConc (const scalingConc_type &x)
	Set the attribute value. More...

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

scalingVolt
Accessor and modifier functions for the scalingVolt required attribute.
typedef ::neuroml2::Nml2Quantity_voltage	scalingVolt_type
	Attribute type.

typedef ::xsd::cxx::tree::traits< scalingVolt_type, char >	scalingVolt_traits
	Attribute traits type.

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

scalingVolt_type &	scalingVolt ()
	Return a read-write reference to the attribute. More...

void	scalingVolt (const scalingVolt_type &x)
	Set the attribute value. More...

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

Constructors
	BlockMechanism (const type_type &, const species_type &, const blockConcentration_type &, const scalingConc_type &, const scalingVolt_type &)
	Create an instance from the ultimate base and initializers for required elements and attributes.

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

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

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

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

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

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

Constructor & Destructor Documentation

◆ BlockMechanism() [1/2]

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

◆ BlockMechanism() [2/2]

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

Member Function Documentation

◆ _clone()

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

◆ blockConcentration() [1/4]

BlockMechanism::blockConcentration_type & neuroml2::BlockMechanism::blockConcentration ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ blockConcentration() [2/4]

const BlockMechanism::blockConcentration_type & neuroml2::BlockMechanism::blockConcentration ( ) const

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

Returns: A constant reference to the attribute.

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

◆ blockConcentration() [3/4]

void neuroml2::BlockMechanism::blockConcentration ( ::std::unique_ptr< blockConcentration_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 7080 of file NeuroML_v2.3.cxx.

◆ blockConcentration() [4/4]

void neuroml2::BlockMechanism::blockConcentration ( const blockConcentration_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 7074 of file NeuroML_v2.3.cxx.

◆ operator=()

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

◆ scalingConc() [1/4]

BlockMechanism::scalingConc_type & neuroml2::BlockMechanism::scalingConc ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ scalingConc() [2/4]

const BlockMechanism::scalingConc_type & neuroml2::BlockMechanism::scalingConc ( ) const

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

Returns: A constant reference to the attribute.

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

◆ scalingConc() [3/4]

void neuroml2::BlockMechanism::scalingConc ( ::std::unique_ptr< scalingConc_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 7104 of file NeuroML_v2.3.cxx.

◆ scalingConc() [4/4]

void neuroml2::BlockMechanism::scalingConc ( const scalingConc_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 7098 of file NeuroML_v2.3.cxx.

◆ scalingVolt() [1/4]

BlockMechanism::scalingVolt_type & neuroml2::BlockMechanism::scalingVolt ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ scalingVolt() [2/4]

const BlockMechanism::scalingVolt_type & neuroml2::BlockMechanism::scalingVolt ( ) const

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

Returns: A constant reference to the attribute.

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

◆ scalingVolt() [3/4]

void neuroml2::BlockMechanism::scalingVolt ( ::std::unique_ptr< scalingVolt_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 7128 of file NeuroML_v2.3.cxx.

◆ scalingVolt() [4/4]

void neuroml2::BlockMechanism::scalingVolt ( const scalingVolt_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 7122 of file NeuroML_v2.3.cxx.

◆ species() [1/4]

BlockMechanism::species_type & neuroml2::BlockMechanism::species ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ species() [2/4]

const BlockMechanism::species_type & neuroml2::BlockMechanism::species ( ) const

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

Returns: A constant reference to the attribute.

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

◆ species() [3/4]

void neuroml2::BlockMechanism::species ( ::std::unique_ptr< species_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 7056 of file NeuroML_v2.3.cxx.

◆ species() [4/4]

void neuroml2::BlockMechanism::species ( const species_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 7050 of file NeuroML_v2.3.cxx.

◆ type() [1/4]

BlockMechanism::type_type & neuroml2::BlockMechanism::type ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ type() [2/4]

const BlockMechanism::type_type & neuroml2::BlockMechanism::type ( ) const

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

Returns: A constant reference to the attribute.

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

◆ type() [3/4]

void neuroml2::BlockMechanism::type ( ::std::unique_ptr< type_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 7032 of file NeuroML_v2.3.cxx.

◆ type() [4/4]

void neuroml2::BlockMechanism::type ( const type_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 7026 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

type

species

blockConcentration

scalingConc

scalingVolt

Constructors

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BlockMechanism() [1/2]

◆ BlockMechanism() [2/2]

Member Function Documentation

◆ _clone()

◆ blockConcentration() [1/4]

◆ blockConcentration() [2/4]

◆ blockConcentration() [3/4]

◆ blockConcentration() [4/4]

◆ operator=()

◆ scalingConc() [1/4]

◆ scalingConc() [2/4]

◆ scalingConc() [3/4]

◆ scalingConc() [4/4]

◆ scalingVolt() [1/4]

◆ scalingVolt() [2/4]

◆ scalingVolt() [3/4]

◆ scalingVolt() [4/4]

◆ species() [1/4]

◆ species() [2/4]

◆ species() [3/4]

◆ species() [4/4]

◆ type() [1/4]

◆ type() [2/4]

◆ type() [3/4]

◆ type() [4/4]