DcppMonitor Class Reference

A class which runs DRAMA parameter monitoring transactions. More...

#include <dcppmonitor.h>

Public Member Functions
	DcppMonitor (DcppTask *Task)
	Construct a parameter monitor controller for the specified task.
void	Add (const char *const name, StatusType *const status, const DcppHandlerRoutine SuccessHandler=0, const DcppHandlerRoutine ErrorHandler=0, const DcppVoidPnt ClientData=0) const
	Add a parameter to the list of parameters being monitored.
void	Cancel (StatusType *const status, const DcppHandlerRoutine SuccessHandler=0, const DcppHandlerRoutine ErrorHandler=0, const DcppVoidPnt ClientData=0) const
	Trigger the cancelling of a monitor operation.
void	Delete (const char *const name, StatusType *const status, const DcppHandlerRoutine SuccessHandler=0, const DcppHandlerRoutine ErrorHandler=0, const DcppVoidPnt ClientData=0) const
	Delete a parameter from the list of parameters being monitored.
void	Forward (const char *const MTask, const char *const Action, const DcppHandlerRoutine CompletedHandler, const DcppVoidPnt ClientData, const bool SendCurrent, const int count, StatusType *const status,...)
	Start a monitor forward operation.
void	Forward (const char *const MTask, const char *const Action, const DcppHandlerRoutine StartedHandler, const DcppHandlerRoutine CompletedHandler, const DcppVoidPnt ClientData, const bool SendCurrent, const int count, StatusType *const status,...)
	Start a monitor forward operation, with started handler.
void	ForwardForget (const char *const MTask, const char *const Action, const DcppHandlerRoutine CompletedHandler, const DcppVoidPnt ClientData, const bool SendCurrent, const int count, StatusType *const status,...)
	Start a monitor forward operation but orphan it.
void	ForwardStartForget (const char *const MTask, const char *const Action, const DcppHandlerRoutine StartHandler, const DcppHandlerRoutine CompletedHandler, const DcppVoidPnt ClientData, const bool SendCurrent, const int count, StatusType *const status,...)
	Start a monitor forward operation but orphan it after starting.
bool	IsActive ()
	Returns true if the monitor operation is active.
bool	IsInitial ()
	Returns true if the monitor operation has not yet been started.
bool	IsStarting ()
	Returns true if the monitor operation is currently starting.
void	Monitor (const DcppMonChangedRoutine ChangedHandler, const DcppHandlerRoutine CompletedHandler, const DcppVoidPnt ClientData, const bool SendCurrent, const int count, StatusType *const status,...)
	Start a monitor operation.
void	MonitorForget (const DcppMonChangedRoutine ChangedHandler, const DcppHandlerRoutine CompletedHandler, const DcppVoidPnt ClientData, const bool SendCurrent, const int count, StatusType *const status,...)
	Start a monitor operation but orphan it.
void	Reset ()
	Reset the state of the monitor.
DcppTask *	Task () const
	Return the associated task object.

Detailed Description

A class which runs DRAMA parameter monitoring transactions.

This class provides a wrap around to parameter monitoring operations. It uses a DcppTask object previously constructed by the user and on which a GetPath operation must have been completed.

See also

DcppTask

DcppHandler

Arg

SdsId

DitsInitiateMessage()

DRAMA C++ interface

DRAMA DITS Specification

Remarks

The approach used here is wrong, instead of using call back functions an client data, we should be using an object which the user can override to provide the functionality. This may be added later.

---

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

• dcppmonitor.h