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

#include <NeuroML_v2.3.hxx>

Inheritance diagram for neuroml2::SineGenerator:

Collaboration diagram for neuroml2::SineGenerator:

delay
Accessor and modifier functions for the delay required attribute.
typedef ::neuroml2::Nml2Quantity_time	delay_type
	Attribute type.

typedef ::xsd::cxx::tree::traits< delay_type, char >	delay_traits
	Attribute traits type.

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

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

void	delay (const delay_type &x)
	Set the attribute value. More...

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

phase
Accessor and modifier functions for the phase required attribute.
typedef ::neuroml2::Nml2Quantity_none	phase_type
	Attribute type.

typedef ::xsd::cxx::tree::traits< phase_type, char >	phase_traits
	Attribute traits type.

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

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

void	phase (const phase_type &x)
	Set the attribute value. More...

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

duration
Accessor and modifier functions for the duration required attribute.
typedef ::neuroml2::Nml2Quantity_time	duration_type
	Attribute type.

typedef ::xsd::cxx::tree::traits< duration_type, char >	duration_traits
	Attribute traits type.

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

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

void	duration (const duration_type &x)
	Set the attribute value. More...

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

amplitude
Accessor and modifier functions for the amplitude required attribute.
typedef ::neuroml2::Nml2Quantity_current	amplitude_type
	Attribute type.

typedef ::xsd::cxx::tree::traits< amplitude_type, char >	amplitude_traits
	Attribute traits type.

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

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

void	amplitude (const amplitude_type &x)
	Set the attribute value. More...

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

period
Accessor and modifier functions for the period required attribute.
typedef ::neuroml2::Nml2Quantity_time	period_type
	Attribute type.

typedef ::xsd::cxx::tree::traits< period_type, char >	period_traits
	Attribute traits type.

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

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

void	period (const period_type &x)
	Set the attribute value. More...

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

Constructors
	SineGenerator (const id_type &, const delay_type &, const phase_type &, const duration_type &, const amplitude_type &, const period_type &)
	Create an instance from the ultimate base and initializers for required elements and attributes.

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

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

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

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

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

Generates a sinusoidally varying current after a time delay, for a fixed duration. The period and maximum amplitude of the current can be set as well as the phase at which to start. Scaled by weight, if set
:param phase: Phase ( between 0 and 2*pi ) at which to start the varying current ( i. e. at time given by delay ) :type phase: none :param delay: Delay before change in current. Current is zero prior to this. :type delay: time :param duration: Duration for holding current at amplitude. Current is zero after delay + duration. :type duration: time :param amplitude: Maximum amplitude of current :type amplitude: current :param period: Time period of oscillation :type period: time

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

Constructor & Destructor Documentation

◆ SineGenerator() [1/2]

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

◆ SineGenerator() [2/2]

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

Member Function Documentation

◆ _clone()

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

◆ amplitude() [1/4]

SineGenerator::amplitude_type & neuroml2::SineGenerator::amplitude ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ amplitude() [2/4]

const SineGenerator::amplitude_type & neuroml2::SineGenerator::amplitude ( ) const

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

Returns: A constant reference to the attribute.

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

◆ amplitude() [3/4]

void neuroml2::SineGenerator::amplitude ( ::std::unique_ptr< amplitude_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 12708 of file NeuroML_v2.3.cxx.

◆ amplitude() [4/4]

void neuroml2::SineGenerator::amplitude ( const amplitude_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 12702 of file NeuroML_v2.3.cxx.

◆ delay() [1/4]

SineGenerator::delay_type & neuroml2::SineGenerator::delay ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ delay() [2/4]

const SineGenerator::delay_type & neuroml2::SineGenerator::delay ( ) const

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

Returns: A constant reference to the attribute.

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

◆ delay() [3/4]

void neuroml2::SineGenerator::delay ( ::std::unique_ptr< delay_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 12636 of file NeuroML_v2.3.cxx.

◆ delay() [4/4]

void neuroml2::SineGenerator::delay ( const delay_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 12630 of file NeuroML_v2.3.cxx.

◆ duration() [1/4]

SineGenerator::duration_type & neuroml2::SineGenerator::duration ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ duration() [2/4]

const SineGenerator::duration_type & neuroml2::SineGenerator::duration ( ) const

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

Returns: A constant reference to the attribute.

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

◆ duration() [3/4]

void neuroml2::SineGenerator::duration ( ::std::unique_ptr< duration_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 12684 of file NeuroML_v2.3.cxx.

◆ duration() [4/4]

void neuroml2::SineGenerator::duration ( const duration_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 12678 of file NeuroML_v2.3.cxx.

◆ operator=()

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

◆ period() [1/4]

SineGenerator::period_type & neuroml2::SineGenerator::period ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ period() [2/4]

const SineGenerator::period_type & neuroml2::SineGenerator::period ( ) const

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

Returns: A constant reference to the attribute.

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

◆ period() [3/4]

void neuroml2::SineGenerator::period ( ::std::unique_ptr< period_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 12732 of file NeuroML_v2.3.cxx.

◆ period() [4/4]

void neuroml2::SineGenerator::period ( const period_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 12726 of file NeuroML_v2.3.cxx.

◆ phase() [1/4]

SineGenerator::phase_type & neuroml2::SineGenerator::phase ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ phase() [2/4]

const SineGenerator::phase_type & neuroml2::SineGenerator::phase ( ) const

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

Returns: A constant reference to the attribute.

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

◆ phase() [3/4]

void neuroml2::SineGenerator::phase ( ::std::unique_ptr< phase_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 12660 of file NeuroML_v2.3.cxx.

◆ phase() [4/4]

void neuroml2::SineGenerator::phase ( const phase_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 12654 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

delay

phase

duration

amplitude

period

Constructors

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SineGenerator() [1/2]

◆ SineGenerator() [2/2]

Member Function Documentation

◆ _clone()

◆ amplitude() [1/4]

◆ amplitude() [2/4]

◆ amplitude() [3/4]

◆ amplitude() [4/4]

◆ delay() [1/4]

◆ delay() [2/4]

◆ delay() [3/4]

◆ delay() [4/4]

◆ duration() [1/4]

◆ duration() [2/4]

◆ duration() [3/4]

◆ duration() [4/4]

◆ operator=()

◆ period() [1/4]

◆ period() [2/4]

◆ period() [3/4]

◆ period() [4/4]

◆ phase() [1/4]

◆ phase() [2/4]

◆ phase() [3/4]

◆ phase() [4/4]