TrigBase

class TrigBase

Trigger result base class.

Inheritance:

Public Methods
TrigBase(void): Default constructor.
TrigBase(const TrigBase& trig): Copy constructor.
TrigBase(const char* ID, const char* SubID=0, const Time& When=0, const Interval& dTime=0.0, double Size=1.0, double Signif=1.0, double Frequency=0.0, const char* ifo=0): Create a trigger object.
virtual ~TrigBase(void): Result destructor.
index_t getData(index_t inx, index_t len, char* data) const: Get a substring of the result data.
int getDisposition(void) const: Get the trigger disposition mask.
Interval getDt(void) const: Get trigger duration.
const char* getID(void) const: Get the trigger ID.
const char* getIFOs(void) const: Get the trigger ID.
double getLowF(void) const: Low trigger frequency.
double getIntensity(void) const: Trigger Intensity.
double getHighF(void) const: High trigger frequency.
TrigPrio getPriority(void) const: Get trigger priority.
const char* getProcess(void) const: Trigger process ID.
const char* getResult(void) const: Get the trigger Result data.
index_t getResultLength(void) const: Get the trigger result data length.
double getSignificance(void) const: Trigger Significance.
const char* getSubID(void) const: Get the trigger sub-ID.
Time getTime(void) const: Get trigger time.
TrigBase& operator=(const TrigBase& trigger): Assignment operator.
bool operator==(const TrigBase& trigger) const: Compare operator.
void appData(const char* data, index_t len): Append data to result data text.
void modData(const char* data, index_t inx, index_t len): Replace a substring of the result data.
void setData(const char* data, index_t len): Append data to result data text.
void setDisposition(int disp): Set the trigger disposition.
void setDuration(Interval dT): Set the trigger duration.
void setFrequency(double F0): Set the frequency.
void setIfos(const char* IFO): Set the interferometer ID.
void setIntensity(double Mag): Set the intensit.
void setSignificance(double sigma): Set the significance.
void setTime(const Time& T0): Set the trigger time.
void setPriority(TrigPrio prio): Set the trigger priority level.
void setProcess(const char* Process): Set the trigger process ID.
void zeroResult(index_t inx, index_t len): Zero a substring of the result data.
virtual std::istream& read(std::istream& in): Read trigger from a stream.
virtual std::ostream& write(std::ostream& out) const: Write trigger to a stream.
virtual std::ostream& print(std::ostream& out) const: Formatted dump.
virtual xsil::XSIL* genXmlDoc(xsil::XSIL* insert) const: Write result as an XML document.

Protected Methods
char* getResult(void): Get the trigger Result data.

Documentation

The trigger base class contains the information needed from all triggers. It may be used as a base for a specific trigger object. Data contained in the trigger base provide all the information needed to select triggers for cross correlation studies, etc. A 1kB space is allocated for additional, trigger specific (result) data to be provided by the concrete trigger method.

TrigBase(void)

Constructor an empty trigger object.

TrigBase(const TrigBase& trig)

Copy constructor.

TrigBase(const char* ID, const char* SubID=0, const Time& When=0, const Interval& dTime=0.0, double Size=1.0, double Signif=1.0, double Frequency=0.0, const char* ifo=0)

A trigger object is created.

Parameters:: ID - Primary trigger identifier
SubID - Secondary trigger i dentifier.

virtual ~TrigBase(void)

Release the data after recording the trigger.

index_t getData(index_t inx, index_t len, char* data) const

Copy the specified substring of the trigger result data. Only data in the interval (0, mLength) will be copied.

Returns:: Number of bytes actually copied.
Parameters:: inx - Offset into the result data of text to be replaced.
len - Length of result data increment in bytes.
data - Pointer to result data increment.

int getDisposition(void) const

Get the trigger disposition mask.

Returns:: Trigger disposition mask.

Interval getDt(void) const

The trigger time offset from the start of the data epoch is returned.

Returns:: The interval corresponding to the duration of the effect being trigger on.

const char* getID(void) const

Get the trigger ID.

Returns:: Trigger ID.

const char* getIFOs(void) const

Get the trigger ID.

Returns:: Trigger ID.

double getLowF(void) const

Get the lower edge of the triggered frequency band.

Returns:: Trigger effect low fequency.

double getIntensity(void) const

Get the trigger effect intensity in units of the trigger threshold.

Returns:: Trigger effect intensity.

double getHighF(void) const

Get the upper edge of the triggered frequency band.

Returns:: Trigger effect high fequency.

TrigPrio getPriority(void) const

Get the priority level for this trigger.

Returns:: Trigger priority level.

const char* getProcess(void) const

Get the process ID for this trigger.

Returns:: Unique process ID.

const char* getResult(void) const

Get a pointer to the trigger result data. The result data are in general binary numbers and are specific to the trigger type.

Returns:: Pointer to the trigger result data.

index_t getResultLength(void) const

The trigger result data length is returned.

Returns:: Length of trigger result data in bytes.

double getSignificance(void) const

Get the trigger effect significance in units of the error on the trigger amplitude.

Returns:: Trigger effect significance.

const char* getSubID(void) const

The trigger sub-ID is returned. The sub-ID is defined by the trigger program to indicate more prcisely the reason for the trigger.

Returns:: trigger sub-ID.

Time getTime(void) const

Get the time at which the effect being triggered on starts.

Returns:: GPS start time of effect.

TrigBase& operator=(const TrigBase& trigger)

Assignment operator.

bool operator==(const TrigBase& trigger) const

Compare two triggers.

void appData(const char* data, index_t len)

The specified data are appended to the trigger result data. The result data are assumed to be binary numbers, meaning that no content checking is performed and any number of embedded null characters are allowed. The total result data length must not exceed 1024 bytes.

Parameters:: data - Pointer to result data increment.
len - Length of result data increment in bytes.

void modData(const char* data, index_t inx, index_t len)

The specified data replace a substring of the trigger result data. The result data are treated as a binary string in that no content checking is performed and any number of embedded null characters are allowed. The result data length must not exceed 1024 bytes.

Parameters:: data - Pointer to result data increment.
len - Length of result data increment in bytes.
inx - Offset into the result data of text to be replaced.

void setData(const char* data, index_t len)