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

#include <NeuroML_v2.3.hxx>

Inheritance diagram for neuroml2::SynapticConnection:

Collaboration diagram for neuroml2::SynapticConnection:

neuroLexId
Accessor and modifier functions for the neuroLexId optional attribute.
typedef ::neuroml2::NeuroLexId	neuroLexId_type
	Attribute type.

typedef ::xsd::cxx::tree::optional< neuroLexId_type >	neuroLexId_optional
	Attribute optional container type.

typedef ::xsd::cxx::tree::traits< neuroLexId_type, char >	neuroLexId_traits
	Attribute traits type.

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

neuroLexId_optional &	neuroLexId ()
	Return a read-write reference to the attribute container. More...

void	neuroLexId (const neuroLexId_type &x)
	Set the attribute value. More...

void	neuroLexId (const neuroLexId_optional &x)
	Set the attribute value. More...

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

from
Accessor and modifier functions for the from required attribute.
typedef ::neuroml2::Nml2PopulationReferencePath	from_type
	Attribute type.

typedef ::xsd::cxx::tree::traits< from_type, char >	from_traits
	Attribute traits type.

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

from_type &	from ()
	Return a read-write reference to the attribute. More...

void	from (const from_type &x)
	Set the attribute value. More...

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

to
Accessor and modifier functions for the to required attribute.
typedef ::neuroml2::Nml2PopulationReferencePath	to_type
	Attribute type.

typedef ::xsd::cxx::tree::traits< to_type, char >	to_traits
	Attribute traits type.

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

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

void	to (const to_type &x)
	Set the attribute value. More...

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

synapse
Accessor and modifier functions for the synapse required attribute.
typedef ::neuroml2::NmlId	synapse_type
	Attribute type.

typedef ::xsd::cxx::tree::traits< synapse_type, char >	synapse_traits
	Attribute traits type.

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

synapse_type &	synapse ()
	Return a read-write reference to the attribute. More...

void	synapse (const synapse_type &x)
	Set the attribute value. More...

void	synapse (::std::unique_ptr< synapse_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
	SynapticConnection (const from_type &, const to_type &, const synapse_type &)
	Create an instance from the ultimate base and initializers for required elements and attributes.

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

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

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

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

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

Explicit event connection between named components, which gets processed via a new instance of a synapse component which is created on the target component

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

Constructor & Destructor Documentation

◆ SynapticConnection() [1/2]

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

◆ SynapticConnection() [2/2]

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

Member Function Documentation

◆ _clone()

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

◆ destination() [1/5]

SynapticConnection::destination_optional & neuroml2::SynapticConnection::destination ( )

Return a read-write reference to the attribute container.

Returns: A reference to the optional container.

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

◆ destination() [2/5]

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

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

Returns: A constant reference to the optional container.

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

◆ destination() [3/5]

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

◆ destination() [4/5]

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

◆ destination() [5/5]

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

◆ from() [1/4]

SynapticConnection::from_type & neuroml2::SynapticConnection::from ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ from() [2/4]

const SynapticConnection::from_type & neuroml2::SynapticConnection::from ( ) const

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

Returns: A constant reference to the attribute.

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

◆ from() [3/4]

void neuroml2::SynapticConnection::from ( ::std::unique_ptr< from_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 15371 of file NeuroML_v2.3.cxx.

◆ from() [4/4]

void neuroml2::SynapticConnection::from ( const from_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 15365 of file NeuroML_v2.3.cxx.

◆ neuroLexId() [1/5]

SynapticConnection::neuroLexId_optional & neuroml2::SynapticConnection::neuroLexId ( )

Return a read-write reference to the attribute container.

Returns: A reference to the optional container.

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

◆ neuroLexId() [2/5]

const SynapticConnection::neuroLexId_optional & neuroml2::SynapticConnection::neuroLexId ( ) const

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

Returns: A constant reference to the optional container.

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

◆ neuroLexId() [3/5]

void neuroml2::SynapticConnection::neuroLexId ( ::std::unique_ptr< neuroLexId_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 15347 of file NeuroML_v2.3.cxx.

◆ neuroLexId() [4/5]

void neuroml2::SynapticConnection::neuroLexId ( const neuroLexId_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 15341 of file NeuroML_v2.3.cxx.

◆ neuroLexId() [5/5]

void neuroml2::SynapticConnection::neuroLexId ( const neuroLexId_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 15335 of file NeuroML_v2.3.cxx.

◆ operator=()

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

◆ synapse() [1/4]

SynapticConnection::synapse_type & neuroml2::SynapticConnection::synapse ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ synapse() [2/4]

const SynapticConnection::synapse_type & neuroml2::SynapticConnection::synapse ( ) const

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

Returns: A constant reference to the attribute.

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

◆ synapse() [3/4]

void neuroml2::SynapticConnection::synapse ( ::std::unique_ptr< synapse_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 15419 of file NeuroML_v2.3.cxx.

◆ synapse() [4/4]

void neuroml2::SynapticConnection::synapse ( const synapse_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 15413 of file NeuroML_v2.3.cxx.

◆ to() [1/4]

SynapticConnection::to_type & neuroml2::SynapticConnection::to ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ to() [2/4]

const SynapticConnection::to_type & neuroml2::SynapticConnection::to ( ) const

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

Returns: A constant reference to the attribute.

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

◆ to() [3/4]

void neuroml2::SynapticConnection::to ( ::std::unique_ptr< to_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 15395 of file NeuroML_v2.3.cxx.

◆ to() [4/4]

void neuroml2::SynapticConnection::to ( const to_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 15389 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

neuroLexId

from

to

synapse

destination

Constructors

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SynapticConnection() [1/2]

◆ SynapticConnection() [2/2]

Member Function Documentation

◆ _clone()

◆ destination() [1/5]

◆ destination() [2/5]

◆ destination() [3/5]

◆ destination() [4/5]

◆ destination() [5/5]

◆ from() [1/4]

◆ from() [2/4]

◆ from() [3/4]

◆ from() [4/4]

◆ neuroLexId() [1/5]

◆ neuroLexId() [2/5]

◆ neuroLexId() [3/5]

◆ neuroLexId() [4/5]

◆ neuroLexId() [5/5]

◆ operator=()

◆ synapse() [1/4]

◆ synapse() [2/4]

◆ synapse() [3/4]

◆ synapse() [4/4]

◆ to() [1/4]

◆ to() [2/4]

◆ to() [3/4]

◆ to() [4/4]