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

update a MarSystem control value More...

#include <EvValUpd.h>

Inherits EvEvent.

Public Member Functions

virtual EvValUpdclone ()
 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.
 EvValUpd (std::string cname, MarControlPtr)
 EvValUpd (MarSystem *, std::string cname, MarControlPtr)
 EvValUpd (EvValUpd &e)
std::string getCName () const
MarSystemgetTarget () const
MarControlPtr getValue () const
void set (MarSystem *ms, std::string cname, MarControlPtr)
void setCName (std::string cname)
void setTarget (MarSystem *ms)
void setValue (MarControlPtr value)
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 ~EvValUpd ()

Friends

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

Detailed Description

update a MarSystem control value

Author:
Neil Burroughs inb@cs.uvic.ca

Definition at line 42 of file EvValUpd.h.


Constructor & Destructor Documentation

EvValUpd ( std::string  cname,
MarControlPtr  val 
)

Definition at line 25 of file EvValUpd.cpp.

EvValUpd ( MarSystem ms,
std::string  cname,
MarControlPtr  val 
)

Definition at line 30 of file EvValUpd.cpp.

EvValUpd ( EvValUpd e)

Definition at line 35 of file EvValUpd.cpp.

~EvValUpd ( ) [virtual]

Definition at line 40 of file EvValUpd.cpp.


Member Function Documentation

EvValUpd * 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 59 of file EvValUpd.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 51 of file EvValUpd.cpp.

std::string getCName ( ) const [inline]

Definition at line 56 of file EvValUpd.h.

MarSystem* getTarget ( ) const [inline]

Definition at line 58 of file EvValUpd.h.

MarControlPtr getValue ( ) const [inline]

Definition at line 57 of file EvValUpd.h.

void set ( MarSystem ms,
std::string  cname,
MarControlPtr  value 
)

Definition at line 43 of file EvValUpd.cpp.

void setCName ( std::string  cname) [inline]

Definition at line 60 of file EvValUpd.h.

void setTarget ( MarSystem ms) [inline]

Definition at line 62 of file EvValUpd.h.

void setValue ( MarControlPtr  value) [inline]

Definition at line 61 of file EvValUpd.h.

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 65 of file EvValUpd.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: