AAO DRAMA/DRAMA2 C++ Interface
DRAMA C++11 and later interface
Public Member Functions | Protected Member Functions | List of all members
drama::thread::MonitorToParam Class Reference

Detailed Description

A class implementing Monitor which copies the value of a monitored parameter into one of the same name or a derived name in the current task.

If the name of the parameter in this task is NOT the same as the name of the parameter being monitored, the user should sub-class this class and override the Transform() method to transform the name as required.

Inherits the Monitor class constructors.

Author
Tony Farrell, AAO $Revision$ $Date$
Examples
monitor1.cpp.

#include "threadmonitor.hh"

Inheritance diagram for drama::thread::MonitorToParam:
drama::thread::Monitor

Public Member Functions

virtual ~MonitorToParam ()
 Destructor.
 
void Cancel ()
 Cancel the monitor.
 
int GetMonitorId () const
 Return the monitor ID.
 
bool IsCancelling () const
 Indicate if the monitor is being canceled.
 
bool IsRunning () const
 Indicate if the monitor is running.
 
template<typename EventProcType = MonitorMessageHandler>
void Run (Path *thePath, thread::TMessHandler *action)
 Run a monitor operation - handler by type.
 
void Run (Path *thePath, thread::TMessHandler *action, MonitorMessageHandler *evtProcessor)
 Run a monitor operation - handler by address.
 
virtual std::string Transform (const std::string &in)
 Transform method, default implementation.
 

Protected Member Functions

virtual std::shared_ptr< TaskGetTask () const
 Get a reference to the task we are part of.
 
virtual void ParameterChanged (const sds::IdPtr &arg) override final
 Method invoked when a parameter is changed.
 

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