In file TrigClient/TrigClient.hh:

class TrigClient

Trigger Client API

Inheritance:


Public Methods

TrigClient (void)
Construct a trigger client.
TrigClient (trig::TrigWriter::trig_mode mode)
Construct a trigger client.
virtual ~TrigClient (void)
Destroy a trigger client.
lmsg::error_type enroll (trig::TrigWriter::trig_mode mode=trig::TrigWriter::kNone)
Enroll process with the Trigger Manager.
lmsg::index_type getDebug (void) const
get the debug level.
lmsg::error_type sendSegment (const trig::Segment& segm)
Log a Segment with the trigger manager.
lmsg::error_type sendTrigger (const trig::TrigBase& trigger)
Log a trigger with the trigger manager.
void setDebug (lmsg::index_type level)
Set the debug level.
void setTableFile (const char* name)
Set the table file.

Documentation

The TrigClient class provides the client API for the Trigger Manager server. The trigger manager maintains a registry of monitors that may produce triggers. The client API requests that it be added to the registry with the enroll method. The client may then sends one or more triggers to the trigger manager with the sendTrigger() method. The trigger data may be routed to an xml file instead by setting the TRIGGER_FILE environmwnt variable.
TrigClient(void)
Construct a trigger client.

TrigClient(trig::TrigWriter::trig_mode mode)
Construct a trigger client with the specified mode.

virtual ~TrigClient(void)
Destroy a trigger client.

lmsg::error_type enroll(trig::TrigWriter::trig_mode mode=trig::TrigWriter::kNone)
The process is registered with the trigger manager. On successful enrolment, the trigger manager returns a unique process identifier which is used to identify the process in subsequent requests.
Returns:
Error code enumerated in lmsg::Errorlist.hh.

lmsg::index_type getDebug(void) const
Get the debug printout level.

lmsg::error_type sendSegment(const trig::Segment& segm)
Send a segment to be logged by the trigger manager.
Returns:
Error code enumerated in lmsg::Errorlist.hh.
Parameters:
segm - Segment to be logged in the metadatabase.

lmsg::error_type sendTrigger(const trig::TrigBase& trigger)
Log a trigger with the trigger manager.
Returns:
Error code enumerated in lmsg::Errorlist.hh.
Parameters:
trigger - Trigger to be logged in the metadatabase.

void setDebug(lmsg::index_type level)
Set the debug level.
Parameters:
level - New debugging level.

void setTableFile(const char* name)
Set the table output file name and the mode to kWriter. If the mode has been previously set to kMgr (logging via the trigger manager) this request is ignored.
Parameters:
name - Table file name


This class has no child classes.
Author:
John G. Zweizig
Version:
1.4; Modified November 24, 2003

alphabetic index hierarchy of classes


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


generated by doc++