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

#include <NeuroML_v2.3.hxx>

Inheritance diagram for neuroml2::Input:

Collaboration diagram for neuroml2::Input:

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...

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

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

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

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

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

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

segmentId
Accessor and modifier functions for the segmentId optional attribute.
typedef ::neuroml2::NonNegativeInteger	segmentId_type
	Attribute type.

typedef ::xsd::cxx::tree::optional< segmentId_type >	segmentId_optional
	Attribute optional container type.

typedef ::xsd::cxx::tree::traits< segmentId_type, char >	segmentId_traits
	Attribute traits type.

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

segmentId_optional &	segmentId ()
	Return a read-write reference to the attribute container. More...

void	segmentId (const segmentId_type &x)
	Set the attribute value. More...

void	segmentId (const segmentId_optional &x)
	Set the attribute value. More...

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

fractionAlong
Accessor and modifier functions for the fractionAlong optional attribute.
typedef ::neuroml2::ZeroToOne	fractionAlong_type
	Attribute type.

typedef ::xsd::cxx::tree::optional< fractionAlong_type >	fractionAlong_optional
	Attribute optional container type.

typedef ::xsd::cxx::tree::traits< fractionAlong_type, char >	fractionAlong_traits
	Attribute traits type.

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

fractionAlong_optional &	fractionAlong ()
	Return a read-write reference to the attribute container. More...

void	fractionAlong (const fractionAlong_type &x)
	Set the attribute value. More...

void	fractionAlong (const fractionAlong_optional &x)
	Set the attribute value. More...

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

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

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

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

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

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

virtual	~Input ()
	Destructor.

Additional Inherited Members
Public Types inherited from neuroml2::BaseNonNegativeIntegerId
typedef ::neuroml2::NonNegativeInteger	id_type
	Attribute type.

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

Public Member Functions inherited from neuroml2::BaseNonNegativeIntegerId
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...

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

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

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

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

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

Specifies a single input to a target, optionally giving the segmentId ( default 0 ) and fractionAlong the segment ( default 0. 5 ).

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

Constructor & Destructor Documentation

◆ Input() [1/2]

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

◆ Input() [2/2]

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

Member Function Documentation

◆ _clone()

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

Reimplemented in neuroml2::InputW.

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

◆ destination() [1/4]

Input::destination_type & neuroml2::Input::destination ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ destination() [2/4]

const Input::destination_type & neuroml2::Input::destination ( ) const

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

Returns: A constant reference to the attribute.

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

◆ destination() [3/4]

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

◆ destination() [4/4]

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

◆ fractionAlong() [1/5]

Input::fractionAlong_optional & neuroml2::Input::fractionAlong ( )

Return a read-write reference to the attribute container.

Returns: A reference to the optional container.

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

◆ fractionAlong() [2/5]

const Input::fractionAlong_optional & neuroml2::Input::fractionAlong ( ) const

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

Returns: A constant reference to the optional container.

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

◆ fractionAlong() [3/5]

void neuroml2::Input::fractionAlong ( ::std::unique_ptr< fractionAlong_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 16523 of file NeuroML_v2.3.cxx.

◆ fractionAlong() [4/5]

void neuroml2::Input::fractionAlong ( const fractionAlong_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 16517 of file NeuroML_v2.3.cxx.

◆ fractionAlong() [5/5]

void neuroml2::Input::fractionAlong ( const fractionAlong_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 16511 of file NeuroML_v2.3.cxx.

◆ operator=()

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

◆ segmentId() [1/5]

Input::segmentId_optional & neuroml2::Input::segmentId ( )

Return a read-write reference to the attribute container.

Returns: A reference to the optional container.

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

◆ segmentId() [2/5]

const Input::segmentId_optional & neuroml2::Input::segmentId ( ) const

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

Returns: A constant reference to the optional container.

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

◆ segmentId() [3/5]

void neuroml2::Input::segmentId ( ::std::unique_ptr< segmentId_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 16493 of file NeuroML_v2.3.cxx.

◆ segmentId() [4/5]

void neuroml2::Input::segmentId ( const segmentId_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 16487 of file NeuroML_v2.3.cxx.

◆ segmentId() [5/5]

void neuroml2::Input::segmentId ( const segmentId_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 16481 of file NeuroML_v2.3.cxx.

◆ target() [1/4]

Input::target_type & neuroml2::Input::target ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ target() [2/4]

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

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

Returns: A constant reference to the attribute.

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

◆ target() [3/4]

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

◆ target() [4/4]

void neuroml2::Input::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 16433 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

destination

segmentId

fractionAlong

Constructors

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Input() [1/2]

◆ Input() [2/2]

Member Function Documentation

◆ _clone()

◆ destination() [1/4]

◆ destination() [2/4]

◆ destination() [3/4]

◆ destination() [4/4]

◆ fractionAlong() [1/5]

◆ fractionAlong() [2/5]

◆ fractionAlong() [3/5]

◆ fractionAlong() [4/5]

◆ fractionAlong() [5/5]

◆ operator=()

◆ segmentId() [1/5]

◆ segmentId() [2/5]

◆ segmentId() [3/5]

◆ segmentId() [4/5]

◆ segmentId() [5/5]

◆ target() [1/4]

◆ target() [2/4]

◆ target() [3/4]

◆ target() [4/4]