Marsyas  0.5.0-beta1
Public Member Functions | Friends
EvExpr Class Reference

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

#include <EvExpr.h>

Inherits 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.
 EvExpr (MarSystem *target, std::string e, std::string nm="Expr")
 EvExpr (MarSystem *target, Ex e, Rp r, std::string nm="Expr")
 EvExpr (MarSystem *target, ExFile ef, std::string nm="Expr")
ExprgetExpression ()
virtual bool repeat ()
 report if the event is to be repeated
virtual std::string repeat_interval ()
virtual void set_repeat (Repeat r)
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.
virtual ~EvExpr ()

Friends

std::ostream & operator<< (std::ostream &, EvEvent &)
std::istream & operator>> (std::istream &, EvEvent &)

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.


Constructor & Destructor Documentation

EvExpr ( MarSystem target,
std::string  e,
std::string  nm = "Expr" 
)

Definition at line 26 of file EvExpr.cpp.

EvExpr ( MarSystem target,
Ex  e,
Rp  r,
std::string  nm = "Expr" 
)

Definition at line 31 of file EvExpr.cpp.

EvExpr ( MarSystem target,
ExFile  ef,
std::string  nm = "Expr" 
)

Definition at line 36 of file EvExpr.cpp.

~EvExpr ( ) [virtual]

Definition at line 41 of file EvExpr.cpp.


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.

void dispatch ( ) [virtual]

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.

Implements EvEvent.

Definition at line 63 of file EvExpr.cpp.

Expr* getExpression ( ) [inline]

Definition at line 63 of file EvExpr.h.

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.

std::string repeat_interval ( ) [virtual]

Definition at line 81 of file EvExpr.cpp.

virtual void set_repeat ( Repeat  r) [inline, virtual]

Definition at line 67 of file EvExpr.h.

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:
tthe timer on which this event is posted.

Reimplemented from EvEvent.

Definition at line 47 of file EvExpr.cpp.

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:
cnamethe path name of the parameter to be modified.
valuethe value to be assigned

Reimplemented from EvEvent.

Definition at line 88 of file EvExpr.cpp.


Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  ,
EvEvent  
) [friend]

Reimplemented from EvEvent.

std::istream& operator>> ( std::istream &  ,
EvEvent  
) [friend]

Reimplemented from EvEvent.


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