Segment

namespace trig class Segment

Trigger result base class.

Public Methods
Segment(void): Default constructor.
Segment(const Segment& trig): Copy constructor.
Segment(const char* group, int version=1, const Time& start=0, const Time& end=0): Create a trigger object.
virtual ~Segment(void): Result destructor.
const char* getGroup(void) const: Get the trigger ID.
int getVersion(void) const: Segment version number.
const char* getProcess(void) const: Process ID.
Time getStartTime(void) const: Get start time.
Time getEndTime(void) const: Get end time.
Segment& operator=(const Segment& trigger): Assignment operator.
bool operator==(const Segment& trigger) const: Compare operator.
void setGroup(const char* group): Set the segment group ID.
void setVersion(int version): Set the version.
void setStartTime(const Time& t0): Set the segment start time.
void setEndTime(const Time& t0): Set the segment end time.
void setProcess(const char* Process): Set the trigger process ID.

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.

Segment(void)

Constructor an empty trigger object.

Segment(const Segment& trig)

Copy constructor.

Segment(const char* group, int version=1, const Time& start=0, const Time& end=0)

A trigger object is created.

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

virtual ~Segment(void)

Release the data after recording the trigger.

const char* getGroup(void) const

Get the trigger ID.

Returns:: Trigger ID.

int getVersion(void) const

Get the segment version number.

Returns:: Segment version number.

const char* getProcess(void) const

Get process table key for the generating process.

Returns:: Process table key.

Time getStartTime(void) const

Get the segment start time.

Returns:: GPS segment start time.

Time getEndTime(void) const

Get the segment end time.

Returns:: GPS segment end time.

Segment& operator=(const Segment& trigger)

Assignment operator.

bool operator==(const Segment& trigger) const

Compare two segments.

void setGroup(const char* group)

Set the group ID for this segment.

Parameters:: Segment - group ID.

void setVersion(int version)

Set the version for this segment.

Parameters:: Segment - version number.

void setStartTime(const Time& t0)

Set the stsrting time of this segment.

Parameters:: Segment - start Time.

void setEndTime(const Time& t0)

Set the ending time of this segment.

Parameters:: Segment - end Time.

void setProcess(const char* Process)

Set the process ID for this trigger.

Parameters:: Process - Unique process ID.

This class has no child classes.

Author:: J. Zweizig
Version:: 1.2; Modified December 29, 1999

alphabetic index hierarchy of classes

generated by doc++