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

#include <NeuroML_v2.3.hxx>

Inheritance diagram for neuroml2::Projection:

Collaboration diagram for neuroml2::Projection:

connection
Accessor and modifier functions for the connection sequence element.
typedef ::neuroml2::Connection	connection_type
	Element type.

typedef ::xsd::cxx::tree::sequence< connection_type >	connection_sequence
	Element sequence container type.

typedef connection_sequence::iterator	connection_iterator
	Element iterator type.

typedef connection_sequence::const_iterator	connection_const_iterator
	Element constant iterator type.

typedef ::xsd::cxx::tree::traits< connection_type, char >	connection_traits
	Element traits type.

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

connection_sequence &	connection ()
	Return a read-write reference to the element sequence. More...

void	connection (const connection_sequence &s)
	Copy elements from a given sequence. More...

connectionWD
Accessor and modifier functions for the connectionWD sequence element.
typedef ::neuroml2::ConnectionWD	connectionWD_type
	Element type.

typedef ::xsd::cxx::tree::sequence< connectionWD_type >	connectionWD_sequence
	Element sequence container type.

typedef connectionWD_sequence::iterator	connectionWD_iterator
	Element iterator type.

typedef connectionWD_sequence::const_iterator	connectionWD_const_iterator
	Element constant iterator type.

typedef ::xsd::cxx::tree::traits< connectionWD_type, char >	connectionWD_traits
	Element traits type.

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

connectionWD_sequence &	connectionWD ()
	Return a read-write reference to the element sequence. More...

void	connectionWD (const connectionWD_sequence &s)
	Copy elements from a given sequence. 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...

Constructors
	Projection (const id_type &, const presynapticPopulation_type &, const postsynapticPopulation_type &, const synapse_type &)
	Create an instance from the ultimate base and initializers for required elements and attributes.

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

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

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

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

virtual	~Projection ()
	Destructor.

Additional Inherited Members
Public Types inherited from neuroml2::BaseProjection
typedef ::neuroml2::NmlId	presynapticPopulation_type
	Attribute type.

typedef ::xsd::cxx::tree::traits< presynapticPopulation_type, char >	presynapticPopulation_traits
	Attribute traits type.

typedef ::neuroml2::NmlId	postsynapticPopulation_type
	Attribute type.

typedef ::xsd::cxx::tree::traits< postsynapticPopulation_type, char >	postsynapticPopulation_traits
	Attribute traits type.

Public Types inherited from neuroml2::Base
typedef ::neuroml2::NmlId	id_type
	Attribute type.

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

Public Member Functions inherited from neuroml2::BaseProjection
const presynapticPopulation_type &	presynapticPopulation () const
	Return a read-only (constant) reference to the attribute. More...

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

void	presynapticPopulation (const presynapticPopulation_type &x)
	Set the attribute value. More...

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

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

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

void	postsynapticPopulation (const postsynapticPopulation_type &x)
	Set the attribute value. More...

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

	BaseProjection (const id_type &, const presynapticPopulation_type &, const postsynapticPopulation_type &)
	Create an instance from the ultimate base and initializers for required elements and attributes.

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

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

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

virtual	~BaseProjection ()
	Destructor.

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

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

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

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

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

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

Projection from one population, presynapticPopulation to another, postsynapticPopulation, through synapse. Contains lists of connection or connectionWD elements.

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

Constructor & Destructor Documentation

◆ Projection() [1/2]

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

◆ Projection() [2/2]

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

Member Function Documentation

◆ _clone()

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

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

◆ connection() [1/3]

Projection::connection_sequence & neuroml2::Projection::connection ( )

Return a read-write reference to the element sequence.

Returns: A reference to the sequence container.

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

◆ connection() [2/3]

const Projection::connection_sequence & neuroml2::Projection::connection ( ) const

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

Returns: A constant reference to the sequence container.

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

◆ connection() [3/3]

void neuroml2::Projection::connection ( const connection_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 15523 of file NeuroML_v2.3.cxx.

◆ connectionWD() [1/3]

Projection::connectionWD_sequence & neuroml2::Projection::connectionWD ( )

Return a read-write reference to the element sequence.

Returns: A reference to the sequence container.

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

◆ connectionWD() [2/3]

const Projection::connectionWD_sequence & neuroml2::Projection::connectionWD ( ) const

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

Returns: A constant reference to the sequence container.

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

◆ connectionWD() [3/3]

void neuroml2::Projection::connectionWD ( const connectionWD_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 15541 of file NeuroML_v2.3.cxx.

◆ operator=()

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

◆ synapse() [1/4]

Projection::synapse_type & neuroml2::Projection::synapse ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ synapse() [2/4]

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

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

Returns: A constant reference to the attribute.

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

◆ synapse() [3/4]

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

◆ synapse() [4/4]

void neuroml2::Projection::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 15559 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

connection

connectionWD

synapse

Constructors

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Projection() [1/2]

◆ Projection() [2/2]

Member Function Documentation

◆ _clone()

◆ connection() [1/3]

◆ connection() [2/3]

◆ connection() [3/3]

◆ connectionWD() [1/3]

◆ connectionWD() [2/3]

◆ connectionWD() [3/3]

◆ operator=()

◆ synapse() [1/4]

◆ synapse() [2/4]

◆ synapse() [3/4]

◆ synapse() [4/4]