namespace trig class TrigProc

Trigger process class.

Public Methods

TrigProc(void)
Default constructor.
TrigProc(const TrigProc& x)
Copy constructor.
TrigProc(const char* cvsid, const char* title=0)
Create a trigger process identifier.
TrigProc(const char* Source, const char* Version, gps_t Start, const char* Host, pid_t PID=0, bool Online=false, const char* IFOs=0, const char* Author=0, gps_t Mod=0, const char* Title=0, const char* Exec=0, gps_t End=0)
Trigger process ID constructor.
~TrigProc()
Destroy a trigger process.
const char* getAuthor(void) const
Get the author's name.
gps_t getEndTime(void) const
Process start time.
const char* getIFOs(void) const
Interferometer list.
gps_t getModTime(void) const
Process start time.
const char* getName(void) const
Get the program name.
const char* getNode(void) const
Get the process node.
const char* getParamSet(void) const
Get the database record ID.
const char* getProcessID(void) const
Get the database record ID.
pid_t getProcID(void) const
Get the unix process ID.
const char* getSource(void) const
Source file name.
gps_t getStartTime(void) const
Process start time.
const char* getTitle(void) const
Get the program title.
const char* getVersion(void) const
Get the program version.
TrigProc& operator=(const TrigProc& x)
Assignment operator
bool operator==(const TrigProc& x) const
Compare two process identifiers.
xsil::XSIL* genXmlDoc(xsil::XSIL* ind=0)
Generate an xml document.
bool isOnline(void) const
Test for online process.
void setProcessID(const std::string& ID)
Set the process Database foreign ID

Documentation

The trigger process class is used to describe the process used to generate a trigger. The current version of the TrigProc class maps directly into the LDAS meta-database process table record as defined in the November 30, 1999 version of Peter Shawhans database memo "Table Definitions for LDAS Metadata / Event Database" (LIGO-T990101-02-E).
TrigProc(void)
Default constructor.

TrigProc(const TrigProc& x)
Copy constructor.

TrigProc(const char* cvsid, const char* title=0)
Make a connection to the trigger broker and get a process ID.

TrigProc(const char* Source, const char* Version, gps_t Start, const char* Host, pid_t PID=0, bool Online=false, const char* IFOs=0, const char* Author=0, gps_t Mod=0, const char* Title=0, const char* Exec=0, gps_t End=0)
Construct the process ID from a detailed list of data.

~TrigProc()
Remove the trigger process. Unregister with the trigger broker.

const char* getAuthor(void) const
getAuthor returns a static pointer to the author's name.

gps_t getEndTime(void) const
getEndTime returns the time at which the process described by this TrigProc object ended. The end time is Time(0) if the process is still running or if the end time was not recorded.
Returns:
Process end tiem or zero (see text).

const char* getIFOs(void) const
Get a list of interferometers that this process monitors.

gps_t getModTime(void) const
Get the time at which the cvs sources were last modified.

const char* getName(void) const
Get a pointer to the program name.
Returns:
A static pointer to the program name.

const char* getNode(void) const
getNode returns a constant pointer to the process node.

const char* getParamSet(void) const
Returns the database ID of this process.

const char* getProcessID(void) const
Returns the database ID of this process.

pid_t getProcID(void) const
Returns the unix process ID of this process.

const char* getSource(void) const
Get the name of the cvs source file (repository and file name) from which the main object was compiled to make the executable.

gps_t getStartTime(void) const
getStartTime returns the time at which the process described by this trigProc object started.

const char* getTitle(void) const
getName returns a static pointer to the program title.

const char* getVersion(void) const
Get the program version number retrieved from the CVS header.
Returns:
a static pointer to the cvs version string.

TrigProc& operator=(const TrigProc& x)
Assignment operator

bool operator==(const TrigProc& x) const
See if two TrigProcs define the identical process. The fields compared are the Program name, the unix process ID, the node name and the start time. These fields are used to generate the primary key in the database, so equal process IDs will necessarily refer to the same metadata table row.
Returns:
true if the processes are the same.
Parameters:
x - Process to be compared to this.

xsil::XSIL* genXmlDoc(xsil::XSIL* ind=0)
Generate an xsil document structure. If the optional argument is coded the document is inserted into the specified document.

bool isOnline(void) const
Test whether the specified is (was) an online process.

void setProcessID(const std::string& ID)
Set the process Database foreign ID


This class has no child classes.
Author:
J. Zweizig
Version:
1.1; Modified December 20, 1999

alphabetic index hierarchy of classes


generated by doc++