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

#include <NeuroML_v2.3.hxx>

Inheritance diagram for neuroml2::Spike:

Collaboration diagram for neuroml2::Spike:

time
Accessor and modifier functions for the time required attribute.
typedef ::neuroml2::Nml2Quantity_time	time_type
	Attribute type.

typedef ::xsd::cxx::tree::traits< time_type, char >	time_traits
	Attribute traits type.

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

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

void	time (const time_type &x)
	Set the attribute value. More...

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

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

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

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

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

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

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

Emits a single spike at the specified time
:param time: Time at which to emit one spike event :type time: time

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

Constructor & Destructor Documentation

◆ Spike() [1/2]

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

◆ Spike() [2/2]

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

Member Function Documentation

◆ _clone()

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

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

◆ operator=()

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

◆ time() [1/4]

Spike::time_type & neuroml2::Spike::time ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ time() [2/4]

const Spike::time_type & neuroml2::Spike::time ( ) const

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

Returns: A constant reference to the attribute.

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

◆ time() [3/4]

void neuroml2::Spike::time ( ::std::unique_ptr< time_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 13520 of file NeuroML_v2.3.cxx.

◆ time() [4/4]

void neuroml2::Spike::time ( const time_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 13514 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

time

Constructors

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Spike() [1/2]

◆ Spike() [2/2]

Member Function Documentation

◆ _clone()

◆ operator=()

◆ time() [1/4]

◆ time() [2/4]

◆ time() [3/4]

◆ time() [4/4]