In file gdsnotify.h:

namespace diag class cmdnotify

Object for sending command notifications

Inheritance:


Public Classes

enum flag
Flag for specifying the notification message
invalid
invalid message
begin
begin of test message
end
end of test message
testBegin
begin of measurement message
testEnd
end of measurement message
testAnalysis
new analysis result
iterEvaluation
new iterator result
dataError
data receiving error

Public Fields

static const char* const msgs []
contains the notification messages

Public Methods

typedef int(*diagNotification) ( const char* msg, const char* prm, int pLen, char** res, int* rLen)
prototype for callback function
explicit cmdnotify (diagNotification NotifyFunc = 0)
Default constructor.
bool send (flag id) const
Send method.
bool sendError (const string& errmsg) const
Send error method.

Documentation

Command notification object This object send notification messages back to the user interface. In order to work it has to be initialized with a valid callback function and the user interface must have registered a callback handler.

enum flag
Flag for specifying the notification message

invalid
invalid message

begin
begin of test message

end
end of test message

testBegin
begin of measurement message

testEnd
end of measurement message

testAnalysis
new analysis result

iterEvaluation
new iterator result

dataError
data receiving error

typedef int (*diagNotification)( const char* msg, const char* prm, int pLen, char** res, int* rLen)
prototype for callback function

static const char* const msgs[]
contains the notification messages

explicit cmdnotify(diagNotification NotifyFunc = 0)
Constructs a command notification object.
Parameters:
NotifyFunc - notification callback function

bool send(flag id) const
Sends a notification message.
Returns:
true if successful

bool sendError(const string& errmsg) const
Sends an errro notification message.
Returns:
true if successful


This class has no child classes.
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++