class supervisory

Object for implementing a diagnostics supervisory task

Inheritance:

Public Fields

std::ostringstream

errmsg Error message stream

Public Methods

explicit	supervisory (const string& Name) Default constructor
virtual	~supervisory () Destructor
virtual supervisory*	self () const New supervisory object.
virtual string	name () const Name of supervisory task.
virtual bool	init (diagStorage& Storage, const cmdnotify& Notify, rtddManager& RTDDMgr, testpointMgr& TPMgr, bool* Abort = 0, bool* Pause = 0, bool rtMode = true) Initialization method.
virtual bool	setup () Setup method.
virtual bool	run () Run method.

Protected Fields

recursivemutex	mux Mutex to protect supervisory object
string	myname Name of supervisory task
bool	RTmode Real-time mode
diagStorage*	storage Pointer to diagnostic storage object
cmdnotify	notify Command notification object
rtddManager*	rtddMgr Pointer to real time data distribution management object
testpointMgr*	tpMgr Pointer to test point management object
bool*	abort Pointer to abort variable
bool*	pause Pointer to pause variable

std::ostringstream errmsg

Error message stream

explicit supervisory(const string& Name)

Constructs a supervisory object.

Parameters:

Name - name of supervisory task

virtual ~supervisory()

Destructs a supervisory object.

virtual supervisory* self() const

A function which returns a new supervisory object of the same type. Must be overwritten by descendents.

Returns:

new supervisory task

virtual string name() const

Returns the name of the supervisory task.

Returns:

name of supervisory task

virtual bool init(diagStorage& Storage, const cmdnotify& Notify, rtddManager& RTDDMgr, testpointMgr& TPMgr, bool* Abort = 0, bool* Pause = 0, bool rtMode = true)

Initializes the supervisory task. Sets the storage pointer, the command notification object, the test point management pointer, the abort and pause pointers, and calls the setup function.

Returns:

true if successful

Parameters:

Storage - diagnostics storage object
Notify - command notification object
RTDDMgr - real-time data distribution management object
TPMgr - test point management object
Abort - pointer to abort variable
Pause - pointer to pause variable
rtMode - Real-time mode if true (old data otherwise)

virtual bool setup()

Sets up the supervisory task. This function must be overwritten by descendents.

Returns:

true if successful

virtual bool run()

Runs the supervisory task. This function must be overwritten by descendents.

Returns:

true if successfuls

recursivemutex mux

Mutex to protect supervisory object

string myname

Name of supervisory task

bool RTmode

Real-time mode

diagStorage* storage

Pointer to diagnostic storage object

cmdnotify notify

Command notification object

rtddManager* rtddMgr

Pointer to real time data distribution management object

testpointMgr* tpMgr

Pointer to test point management object

bool* abort

Pointer to abort variable

bool* pause

Pointer to pause variable

Direct child classes:

basic_supervisory

Author:

Written April 1999 by Daniel Sigg

Version:

0.1

alphabetic index hierarchy of classes

Please send questions and comments to sigg_d@ligo-wa.caltech.edu

generated by doc++