impulseModule Class Reference

This module creates a Dirac impulse and has a single output port.

The default amplitude value of the impulse is "1", but can be manually set via the local parameter "A".

Inheritance diagram for impulseModule:

Public Member Functions
	impulseModule (const string &name="ImpulseModule", const string &sds="", const string &lds="", const string &htm="")
	Constructor of the impulseModule class.
virtual ARTItimeModule *	Create (const string &name, const string &sds="", const string &lds="", const string &htm="")
	Factory function which creates a new impulse module object with the given input parameters.
virtual void	addIPort (const string &name, const ARTdataProp *refPort)
	Always throws an ARTerror exception as this module does not allow to add any input ports.
virtual ARTdataProp *	getPort (const string &name)
	Returns a pointer to the port object with the given name.
virtual void	setCurrentIndex (int idx)
	Sets the current time module and all output ports to the given time index.
virtual void	simulateCurrentIndex (int idx)
	Triggers the evaluation of all output ports of the time module for the given time index.
virtual	~impulseModule ()
	Destructor of the impulseModule class.
Public Member Functions inherited from ARTItimeModule
	ARTItimeModule (const string &name, const string &sds="", const string &lds="", const string &htm="")
	Constructor of the ARTItimeModule class.
	ARTItimeModule (const ARTItimeModule &orig)
	Copy constructor which creates a new time module based on the given time module.
virtual void	setLocalParameter (const string &name, const string &expr)
	Sets the definition of the local parameter with the given name.
virtual void	setLocalParameter (const string &name, const std::complex< double > &val)
	Sets the definition of the local parameter with the given name.
virtual void	setLocalParameter (const string &name, const double val)
	Sets the definition of the local parameter with the given name.
virtual void	addGlobalParameter (const ARTdataProp *parameter)
	Adds a global parameter to the current time module by registering it to all output ports and local parameters.
virtual void	removeGlobalParameter (const string &name)
	Removes the definition of the given global parameter from all output ports and local parameters.
virtual void	setSimulator (ARTsimulator *sim)
	Sets the simulator of the current time module and all its output ports.
virtual	~ARTItimeModule ()
	Destructor of the ARTItimeModule class.
Public Member Functions inherited from ARTobject
	ARTobject (const string name, const string sds="", const string lds="", const string htm="")
	objects must have a name, the rest is optional
	ARTobject (const ARTobject &orig)
	copy constructor
virtual ARTcell *	clone ()
ARTproperty *	GetProperties (ARTproperty *pos)
	iterate through property list (pass NULL to restart iteration, receive NULL after last element)
ARTproperty *	FindProperty (const string nam)
	find and return named property (or return NULL if no match)
ARTproperty *	AppendProperty (const string name, const string sds="", const string lds="", const string htm="")
	Append new property with given name to ARTobject.
ARTdataProp *	AppendDataProp (const string name, ARTvariant *val, const string sds="", const string lds="", const string htm="")
	append new data property with given name to ARTobject
ARTdataProp *	AppendDataProp (const string name, const double val, const string sds="", const string lds="", const string htm="")
ARTdataProp *	AppendDataProp (const string name, const float val, const string sds="", const string lds="", const string htm="")
ARTdataProp *	AppendDataProp (const string name, const string val, const string sds="", const string lds="", const string htm="")
ARTdataProp *	AppendDataProp (const string name, const int val, const string sds="", const string lds="", const string htm="")
ARTdataProp *	AppendDataProp (const string name, const string *val, const string sds="", const string lds="", const string htm="")
ARTdataProp *	AppendDataProp (ARTdataProp *dataProp)
ARTlistProp *	AppendListProp (const string name, const string sds="", const string lds="", const string htm="")
	append new listableProperty with given name
bool	DeleteProperty (ARTproperty *prp)
	delete current property (which was recently accessed by GetProperties, FindProperty or AppendProperty)
ARTmethod *	GetMethods (ARTmethod *pos)
	iterate through method list (pass NULL to restart iteration, receive NULL after last element)
ARTmethod *	FindMethod (const string nam)
	find and return named method (or return NULL if no match)
ARTmethod *	AppendMethod (const string name, const string sds="", const string lds="", const string htm="")
	append new method with given name
bool	DeleteMethod (ARTmethod *mtd)
	delete current method (which was recently accessed by GetProperties, FindProperty or AppendProperty)
void	SetPropertyList (list< ARTproperty * > &l)
void	CopyPropertyListEntries (ARTobject *obj)
	copies properties from other objects (also copying the objects of all list-entries). OVERWRITES list own list!
void	CopyMethodListEntries (ARTobject *obj)
	copies methods from other objects (also copying the objects of all list-entries). OVERWRITES list own list!
list< ARTproperty * >	GetPropertyList ()
list< ARTmethod * >	GetMethodList ()
Public Member Functions inherited from ARTcell
	ARTcell (const string name="", const string sds="", const string lds="", const string htm="")
	ARTcell (const ARTcell &orig)
const string &	GetName () const
const string &	GetShortDescription () const
const string &	GetLongDescription () const
const string &	GetHelpFilename () const
void	SetName (const string name)

Protected Member Functions
virtual void	initLocalParams ()
	Internal method which creates and initializes all needed local parameters.

Protected Attributes
OPortType *	out_
	Pointer to the single output port of the module.
Protected Attributes inherited from ARTItimeModule
ARTtimeSimulator *	_simulator
	Simulator object to which the current time module belongs.
Protected Attributes inherited from ARTobject
list< ARTproperty * >	propertyList_
list< ARTproperty * >::iterator	piter_
list< ARTmethod * >	methodList_
list< ARTmethod * >::iterator	miter_
Protected Attributes inherited from ARTcell
string	name_
	Identifier of ARTObject.
string	shortDesc_
	Short Description of ARTObject (single line hint)
string	longDesc_
	Long Description of ARTObject (multi line text)
string	helpFile_
	File name of HTML help file for ARTObject.

Constructor & Destructor Documentation

impulseModule::impulseModule ( const string &  name = "ImpulseModule", const string &  sds = "", const string &  lds = "", const string &  htm = ""  )

explicit

Constructor of the impulseModule class.

Parameters

[in]	name	Represents the unique identifier of the impulse module.
[in]	sds	Short description (single line) of the impulse module.
[in]	lds	Long description of the impulse module.
[in]	htm	Path to help file in HTML format.

Member Function Documentation

void impulseModule::addIPort ( const string &  name, const ARTdataProp *  refPort  )

virtual

Always throws an ARTerror exception as this module does not allow to add any input ports.

Parameters

[in]	name	Locally unique identifier of the new input port - will be ignored.
[in]	refPort	Pointer to an existing output port which will be associated with the new input port - will be ignored.

Implements ARTItimeModule.

ARTItimeModule * impulseModule::Create ( const string &  name, const string &  sds = "", const string &  lds = "", const string &  htm = ""  )

virtual

Factory function which creates a new impulse module object with the given input parameters.

Parameters

[in]	name	Represents the unique identifier of the impulse module.
[in]	sds	Short description (single line) of the impulse module.
[in]	lds	Long description of the impulse module.
[in]	htm	Path to help file in HTML format.

Implements ARTItimeModule.

ARTdataProp * impulseModule::getPort ( const string &  name )

virtual

Returns a pointer to the port object with the given name.

The impulse module only has a single valid name for an output port which is called "out". Trying to get any other property with another name will trigger an exception.

Exceptions

ARTerror

If no port with the given name could be found in the current module.

Reimplemented from ARTItimeModule.

void impulseModule::setCurrentIndex ( int  idx )

virtual

Sets the current time module and all output ports to the given time index.

Parameters

[in]

idx

The time index which will be set.

Implements ARTItimeModule.

void impulseModule::simulateCurrentIndex ( int  idx )

virtual

Triggers the evaluation of all output ports of the time module for the given time index.

Parameters

[in]

idx

The time index which will be simulated.

Implements ARTItimeModule.

Member Data Documentation

OPortType* impulseModule::out_

protected

Pointer to the single output port of the module.