EvExpr Class Reference
[Scheduler]

Expression Event evaluates the supplied expression when prompted by the scheduler. More...

#include <EvExpr.h>

Inherits Marsyas::EvEvent.


Public Member Functions

virtual EvExprclone ()
 clone this event and all its parameters. This method must be implemented so that scheduled events may be copied.
void dispatch ()
 the action to be performed by the event. This method is called when the event is due. Since Marsyas is not threaded, this method will block so be careful not to do too much.
virtual bool repeat ()
 report if the event is to be repeated
void setTimer (TmTimer *t)
 set the timer on which this event is scheduled. This method is called by the timer's post method when the scheduled event is posted on the timer.
void updctrl (std::string cname, TmControlValue value)
 update event parameters dynamically. Parameters of the event may be updated while the event is on the heap. The support for modifiable parameters is dependent on the implementation of concrete events. Unsupported parameter updates should generate warnings.


Detailed Description

Expression Event evaluates the supplied expression when prompted by the scheduler.

Author:
Neil Burroughs inb@cs.uvic.ca
Version:
1.0
Date:
Jan 5, 2007

Definition at line 44 of file EvExpr.h.


Member Function Documentation

EvExpr * clone (  )  [virtual]

clone this event and all its parameters. This method must be implemented so that scheduled events may be copied.

Returns:
a pointer to a copy of this event

Implements EvEvent.

Definition at line 69 of file EvExpr.cpp.

bool repeat (  )  [virtual]

report if the event is to be repeated

Returns:
true if event should repeat

Reimplemented from EvEvent.

Definition at line 75 of file EvExpr.cpp.

References Expr::repeat().

void setTimer ( TmTimer t  )  [virtual]

set the timer on which this event is scheduled. This method is called by the timer's post method when the scheduled event is posted on the timer.

Parameters:
t the timer on which this event is posted.

Reimplemented from EvEvent.

Definition at line 47 of file EvExpr.cpp.

References Expr::post(), Expr::setTimer(), EvEvent::setTimer(), and EvEvent::timer_.

void updctrl ( std::string  cname,
TmControlValue  value 
) [virtual]

update event parameters dynamically. Parameters of the event may be updated while the event is on the heap. The support for modifiable parameters is dependent on the implementation of concrete events. Unsupported parameter updates should generate warnings.

Parameters:
cname the path name of the parameter to be modified.
value the value to be assigned

Reimplemented from EvEvent.

Definition at line 88 of file EvExpr.cpp.


The documentation for this class was generated from the following files:

Generated on Wed May 23 00:02:23 2012 for Marsyas by  doxygen 1.5.6