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

#include <NeuroML_v2.3.hxx>

Inheritance diagram for neuroml2::ExplicitInput:

Collaboration diagram for neuroml2::ExplicitInput:

target
Accessor and modifier functions for the target required attribute.
typedef ::neuroml2::Nml2PopulationReferencePath	target_type
	Attribute type.

typedef ::xsd::cxx::tree::traits< target_type, char >	target_traits
	Attribute traits type.

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

target_type &	target ()
	Return a read-write reference to the attribute. More...

void	target (const target_type &x)
	Set the attribute value. More...

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

input
Accessor and modifier functions for the input required attribute.
typedef ::neuroml2::NmlId	input_type
	Attribute type.

typedef ::xsd::cxx::tree::traits< input_type, char >	input_traits
	Attribute traits type.

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

input_type &	input ()
	Return a read-write reference to the attribute. More...

void	input (const input_type &x)
	Set the attribute value. More...

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

destination
Accessor and modifier functions for the destination optional attribute.
typedef ::neuroml2::NmlId	destination_type
	Attribute type.

typedef ::xsd::cxx::tree::optional< destination_type >	destination_optional
	Attribute optional container type.

typedef ::xsd::cxx::tree::traits< destination_type, char >	destination_traits
	Attribute traits type.

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

destination_optional &	destination ()
	Return a read-write reference to the attribute container. More...

void	destination (const destination_type &x)
	Set the attribute value. More...

void	destination (const destination_optional &x)
	Set the attribute value. More...

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

Constructors
	ExplicitInput (const target_type &, const input_type &)
	Create an instance from the ultimate base and initializers for required elements and attributes.

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

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

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

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

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

An explicit input ( anything which extends basePointCurrent ) to a target cell in a population

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

Constructor & Destructor Documentation

◆ ExplicitInput() [1/2]

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

◆ ExplicitInput() [2/2]

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

Member Function Documentation

◆ _clone()

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

◆ destination() [1/5]

ExplicitInput::destination_optional & neuroml2::ExplicitInput::destination ( )

Return a read-write reference to the attribute container.

Returns: A reference to the optional container.

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

◆ destination() [2/5]

const ExplicitInput::destination_optional & neuroml2::ExplicitInput::destination ( ) const

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

Returns: A constant reference to the optional container.

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

◆ destination() [3/5]

void neuroml2::ExplicitInput::destination ( ::std::unique_ptr< destination_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 16323 of file NeuroML_v2.3.cxx.

◆ destination() [4/5]

void neuroml2::ExplicitInput::destination ( const destination_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 16317 of file NeuroML_v2.3.cxx.

◆ destination() [5/5]

void neuroml2::ExplicitInput::destination ( const destination_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 16311 of file NeuroML_v2.3.cxx.

◆ input() [1/4]

ExplicitInput::input_type & neuroml2::ExplicitInput::input ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ input() [2/4]

const ExplicitInput::input_type & neuroml2::ExplicitInput::input ( ) const

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

Returns: A constant reference to the attribute.

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

◆ input() [3/4]

void neuroml2::ExplicitInput::input ( ::std::unique_ptr< input_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 16293 of file NeuroML_v2.3.cxx.

◆ input() [4/4]

void neuroml2::ExplicitInput::input ( const input_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 16287 of file NeuroML_v2.3.cxx.

◆ operator=()

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

◆ target() [1/4]

ExplicitInput::target_type & neuroml2::ExplicitInput::target ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ target() [2/4]

const ExplicitInput::target_type & neuroml2::ExplicitInput::target ( ) const

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

Returns: A constant reference to the attribute.

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

◆ target() [3/4]

void neuroml2::ExplicitInput::target ( ::std::unique_ptr< target_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 16269 of file NeuroML_v2.3.cxx.

◆ target() [4/4]

void neuroml2::ExplicitInput::target ( const target_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 16263 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

target

input

destination

Constructors

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ExplicitInput() [1/2]

◆ ExplicitInput() [2/2]

Member Function Documentation

◆ _clone()

◆ destination() [1/5]

◆ destination() [2/5]

◆ destination() [3/5]

◆ destination() [4/5]

◆ destination() [5/5]

◆ input() [1/4]

◆ input() [2/4]

◆ input() [3/4]

◆ input() [4/4]

◆ operator=()

◆ target() [1/4]

◆ target() [2/4]

◆ target() [3/4]

◆ target() [4/4]