neuroml2::SpikeArray Class Reference

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

#include <NeuroML_v2.3.hxx>

Inheritance diagram for neuroml2::SpikeArray:

Collaboration diagram for neuroml2::SpikeArray:

spike
Accessor and modifier functions for the spike sequence element.
typedef ::neuroml2::Spike	spike_type
	Element type.
typedef ::xsd::cxx::tree::sequence< spike_type >	spike_sequence
	Element sequence container type.
typedef spike_sequence::iterator	spike_iterator
	Element iterator type.
typedef spike_sequence::const_iterator	spike_const_iterator
	Element constant iterator type.
typedef ::xsd::cxx::tree::traits< spike_type, char >	spike_traits
	Element traits type.
const spike_sequence &	spike () const
	Return a read-only (constant) reference to the element sequence. More...
spike_sequence &	spike ()
	Return a read-write reference to the element sequence. More...
void	spike (const spike_sequence &s)
	Copy elements from a given sequence. More...

Constructors
	SpikeArray (const id_type &)
	Create an instance from the ultimate base and initializers for required elements and attributes.
	SpikeArray (const ::xercesc::DOMElement &e, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
	Create an instance from a DOM element. More...
	SpikeArray (const SpikeArray &x, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
	Copy constructor. More...
virtual SpikeArray *	_clone (::xml_schema::flags f=0, ::xml_schema::container *c=0) const
	Copy the instance polymorphically. More...
SpikeArray &	operator= (const SpikeArray &x)
	Copy assignment operator. More...
virtual	~SpikeArray ()
	Destructor.

Additional Inherited Members
Public Types inherited from neuroml2::Standalone
typedef ::neuroml2::Notes	notes_type
	Element type.
typedef ::xsd::cxx::tree::optional< notes_type >	notes_optional
	Element optional container type.
typedef ::xsd::cxx::tree::traits< notes_type, char >	notes_traits
	Element traits type.
typedef ::neuroml2::Property	property_type
	Element type.
typedef ::xsd::cxx::tree::sequence< property_type >	property_sequence
	Element sequence container type.
typedef property_sequence::iterator	property_iterator
	Element iterator type.
typedef property_sequence::const_iterator	property_const_iterator
	Element constant iterator type.
typedef ::xsd::cxx::tree::traits< property_type, char >	property_traits
	Element traits type.
typedef ::neuroml2::Annotation	annotation_type
	Element type.
typedef ::xsd::cxx::tree::optional< annotation_type >	annotation_optional
	Element optional container type.
typedef ::xsd::cxx::tree::traits< annotation_type, char >	annotation_traits
	Element traits type.
typedef ::neuroml2::MetaId	metaid_type
	Attribute type.
typedef ::xsd::cxx::tree::optional< metaid_type >	metaid_optional
	Attribute optional container type.
typedef ::xsd::cxx::tree::traits< metaid_type, char >	metaid_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::Standalone
const notes_optional &	notes () const
	Return a read-only (constant) reference to the element container. More...
notes_optional &	notes ()
	Return a read-write reference to the element container. More...
void	notes (const notes_type &x)
	Set the element value. More...
void	notes (const notes_optional &x)
	Set the element value. More...
void	notes (::std::unique_ptr< notes_type > p)
	Set the element value without copying. More...
const property_sequence &	property () const
	Return a read-only (constant) reference to the element sequence. More...
property_sequence &	property ()
	Return a read-write reference to the element sequence. More...
void	property (const property_sequence &s)
	Copy elements from a given sequence. More...
const annotation_optional &	annotation () const
	Return a read-only (constant) reference to the element container. More...
annotation_optional &	annotation ()
	Return a read-write reference to the element container. More...
void	annotation (const annotation_type &x)
	Set the element value. More...
void	annotation (const annotation_optional &x)
	Set the element value. More...
void	annotation (::std::unique_ptr< annotation_type > p)
	Set the element value without copying. More...
const metaid_optional &	metaid () const
	Return a read-only (constant) reference to the attribute container. More...
metaid_optional &	metaid ()
	Return a read-write reference to the attribute container. More...
void	metaid (const metaid_type &x)
	Set the attribute value. More...
void	metaid (const metaid_optional &x)
	Set the attribute value. More...
void	metaid (::std::unique_ptr< metaid_type > p)
	Set the attribute value without copying. More...
	Standalone (const id_type &)
	Create an instance from the ultimate base and initializers for required elements and attributes.
	Standalone (const ::xercesc::DOMElement &e, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
	Create an instance from a DOM element. More...
	Standalone (const Standalone &x, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
	Copy constructor. More...
Standalone &	operator= (const Standalone &x)
	Copy assignment operator. More...
virtual	~Standalone ()
	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 SpikeArray schema type.

Set of spike ComponentTypes, each emitting one spike at a certain time. Can be used to feed a predetermined spike train into a cell

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

Constructor & Destructor Documentation

SpikeArray() [1/2]

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

SpikeArray() [2/2]

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

Member Function Documentation

_clone()

SpikeArray * neuroml2::SpikeArray::_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::Standalone.

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

operator=()

SpikeArray & neuroml2::SpikeArray::operator=

(

const SpikeArray &

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 41936 of file NeuroML_v2.3.cxx.

spike() [1/3]

SpikeArray::spike_sequence & neuroml2::SpikeArray::spike

(

)

Return a read-write reference to the element sequence.

Returns

A reference to the sequence container.

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

spike() [2/3]

const SpikeArray::spike_sequence & neuroml2::SpikeArray::spike

(

)

const

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

Returns

A constant reference to the sequence container.

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

spike() [3/3]

void neuroml2::SpikeArray::spike

(

const spike_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 13542 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