neuroml2::SpikeThresh Class Reference

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

#include <NeuroML_v2.3.hxx>

Inheritance diagram for neuroml2::SpikeThresh:

Collaboration diagram for neuroml2::SpikeThresh:

value
Accessor and modifier functions for the value required attribute.
typedef ::neuroml2::Nml2Quantity_voltage	value_type
	Attribute type.
typedef ::xsd::cxx::tree::traits< value_type, char >	value_traits
	Attribute traits type.
const value_type &	value () const
	Return a read-only (constant) reference to the attribute. More...
value_type &	value ()
	Return a read-write reference to the attribute. More...
void	value (const value_type &x)
	Set the attribute value. More...
void	value (::std::unique_ptr< value_type > p)
	Set the attribute value without copying. More...

segmentGroup
Accessor and modifier functions for the segmentGroup optional attribute with a default value.
typedef ::neuroml2::NmlId	segmentGroup_type
	Attribute type.
typedef ::xsd::cxx::tree::traits< segmentGroup_type, char >	segmentGroup_traits
	Attribute traits type.
const segmentGroup_type &	segmentGroup () const
	Return a read-only (constant) reference to the attribute. More...
segmentGroup_type &	segmentGroup ()
	Return a read-write reference to the attribute. More...
void	segmentGroup (const segmentGroup_type &x)
	Set the attribute value. More...
void	segmentGroup (::std::unique_ptr< segmentGroup_type > p)
	Set the attribute value without copying. More...
static const segmentGroup_type &	segmentGroup_default_value ()
	Return the default value for the attribute. More...

Constructors
	SpikeThresh (const value_type &)
	Create an instance from the ultimate base and initializers for required elements and attributes.
	SpikeThresh (const ::xercesc::DOMElement &e, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
	Create an instance from a DOM element. More...
	SpikeThresh (const SpikeThresh &x, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
	Copy constructor. More...
virtual SpikeThresh *	_clone (::xml_schema::flags f=0, ::xml_schema::container *c=0) const
	Copy the instance polymorphically. More...
SpikeThresh &	operator= (const SpikeThresh &x)
	Copy assignment operator. More...
virtual	~SpikeThresh ()
	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 SpikeThresh schema type.

Membrane potential at which to emit a spiking event. Note, usually the spiking event will not be emitted again until the membrane potential has fallen below this value and rises again to cross it in a positive direction
:param value: :type value: voltage

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

Constructor & Destructor Documentation

SpikeThresh() [1/2]

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

SpikeThresh() [2/2]

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

Member Function Documentation

_clone()

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

operator=()

SpikeThresh & neuroml2::SpikeThresh::operator=

(

const SpikeThresh &

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

segmentGroup() [1/4]

SpikeThresh::segmentGroup_type & neuroml2::SpikeThresh::segmentGroup

(

)

Return a read-write reference to the attribute.

Returns

A reference to the attribute.

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

segmentGroup() [2/4]

const SpikeThresh::segmentGroup_type & neuroml2::SpikeThresh::segmentGroup

(

)

const

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

Returns

A constant reference to the attribute.

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

segmentGroup() [3/4]

void neuroml2::SpikeThresh::segmentGroup

(

::std::unique_ptr< segmentGroup_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 10784 of file NeuroML_v2.3.cxx.

segmentGroup() [4/4]

void neuroml2::SpikeThresh::segmentGroup

(

const segmentGroup_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 10778 of file NeuroML_v2.3.cxx.

segmentGroup_default_value()

const SpikeThresh::segmentGroup_type & neuroml2::SpikeThresh::segmentGroup_default_value ( )

static

Return the default value for the attribute.

Returns

A read-only (constant) reference to the attribute's default value.

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

value() [1/4]

SpikeThresh::value_type & neuroml2::SpikeThresh::value

(

)

Return a read-write reference to the attribute.

Returns

A reference to the attribute.

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

value() [2/4]

const SpikeThresh::value_type & neuroml2::SpikeThresh::value

(

)

const

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

Returns

A constant reference to the attribute.

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

value() [3/4]

void neuroml2::SpikeThresh::value

(

::std::unique_ptr< value_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 10760 of file NeuroML_v2.3.cxx.

value() [4/4]

void neuroml2::SpikeThresh::value

(

const value_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 10754 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