Trigger result base class.

Inheritance:

Public Methods

	Segment (void) Default constructor.
	Segment (const std::string& group, int version=1, const Time& start=Time(0), const Time& end=Time(0)) Create a trigger object.
virtual	~Segment (void) Result destructor.
int	getActivity (void) const Get the segment activity code.
const char*	getComment (void) const Get the comment.
Time	getEndTime (void) const Get end time.
const char*	getGroup (void) const Get the segment name.
const char*	getIfos (void) const Get the trigger ID.
int	getMinor (void) const Get the mnor version number.
int	getPlusMinus (void) const Get the segment plus/minus code.
const char*	getProcess (void) const Process ID.
const char*	getSegID (void) const Segment ID.
Time	getStartTime (void) const Get start time.
int	getVersion (void) const Segment version number.
bool	operator== (const Segment& trigger) const Compare operator.
void	setActivity (int act) Set the activity flag, on=1, off=0, remove=-1.
void	setComment (const std::string& com) Set the segment end time.
void	setEndTime (const Time& t0) Set the segment end time.
void	setGroup (const char* group) Set the segment group ID.
void	setIfos (const char* ifos) Set the segment IFO list.
void	setProcess (const char* Process) Set the trigger process ID.
void	setSegID (const std::string& SegID) Set the segment ID.
void	setStartTime (const Time& t0) Set the segment start time.
void	setVersion (int version) Set the version.

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 std::string& group, int version=1, const Time& start=Time(0), const Time& end=Time(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.

int getActivity(void) const

Get the segment activity code. On=1, Off=0.

Returns:

Activity code.

const char* getComment(void) const

Get the segment comment.

Returns:

segment name string.

Time getEndTime(void) const

Get the segment end time.

Returns:

GPS segment end time.

const char* getGroup(void) const

Get the segment name.

Returns:

segment name.

const char* getIfos(void) const

Get the trigger ID.

Returns:

Trigger ID.

int getMinor(void) const

Get the minor version number.

Returns:

Minor version ID.

int getPlusMinus(void) const

Get the segment plus/minus code. Add=1, Remove=0.

Returns:

Plus/Minus code.

const char* getProcess(void) const

Get process table key for the generating process.

Returns:

Process table key.

const char* getSegID(void) const

Get the internal segment id.

Returns:

Segment table key.

Time getStartTime(void) const

Get the segment start time.

Returns:

GPS segment start time.

int getVersion(void) const

Get the segment version number.

Returns:

Segment version number.

bool operator==(const Segment& trigger) const

Compare two segments.

void setActivity(int act)

Set the activity flag.

Parameters:

act - Activity value.

void setComment(const std::string& com)

Set the ending time of this segment.

Parameters:

- Segment end Time.

void setEndTime(const Time& t0)

Set the ending time of this segment.

Parameters:

- Segment end Time.

void setGroup(const char* group)

Set the group ID for this segment.

Parameters:

- Segment group ID.

void setIfos(const char* ifos)

Set the interferometer ID(s) for this segment.

Parameters:

ifos - Segment IFO list.

void setProcess(const char* Process)

Set the process ID for this segment.

Parameters:

Process - Unique process ID.

void setSegID(const std::string& SegID)

Set the segment ID.

Parameters:

Process - Unique segment ID.

void setStartTime(const Time& t0)

Set the start time of this segment.

Parameters:

- Segment start Time.

void setVersion(int version)

Set the version for this segment.

Parameters:

version - Segment version number.

This class has no child classes.

Author:

J. Zweizig

Version:

1.2; Modified December 29, 1999

Alphabetic index HTML hierarchy of classes or Java

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