In file AlarmClient/AlarmData.hh:

class AlarmHandle

Active alarm identifier.

Inheritance:


Public Methods

AlarmHandle (void)
construct a handle.
AlarmHandle (const AlarmHandle& x)
Copy constructor.
explicit AlarmHandle (long x)
Hate to do this, but it's really hard to get around it
~AlarmHandle (void)
Destructor.
AlarmHandle& operator= (const AlarmHandle& x)
Assignment operator.
bool operator< (const AlarmHandle& x) const
Comparison operator (less than)
bool operator== (const AlarmHandle& x) const
Comparison operator (equal to)
bool operator! (void) const
Test for invalid state.
static AlarmHandle getUnique (void)
generate a unique handle
long getInt (void) const
Get integer version of handle.

Documentation

The AlarmHandle class defines an identifier used by the Alarm Manager to refer to a specific active alarm.
AlarmHandle(void)
Construct a handle. THe handle is initialized to an invalid (not defined) state.

AlarmHandle(const AlarmHandle& x)
Copy an alarm handle.
Parameters:
x - Alarm handle to be copied.

explicit AlarmHandle(long x)
Hate to do this, but it's really hard to get around it

~AlarmHandle(void)
Destroy an alarm handle.

AlarmHandle& operator= (const AlarmHandle& x)
Alarm handle assignment operator.
Returns:
Reference to the lhs object.

bool operator< (const AlarmHandle& x) const
Comparison operator (less than)

bool operator==(const AlarmHandle& x) const
Comparison operator (equal to)

bool operator!(void) const
Test for invalid state.
Returns:
true if handle is not defined or invalid.

static AlarmHandle getUnique(void)
generate a unique handle
Returns:
Unique handle.

long getInt(void) const
Get a unique integer equicvalent ot the handle.
Returns:
integer with handle encoded.


This class has no child classes.
Author:
J. Zweizig
Version:
; Modified

alphabetic index hierarchy of classes


Please send questions and comments to zweizig_j@ligo.caltech.edu


generated by doc++