Segment list class.

Inheritance:

Public Methods

explicit	LockSegList (const char* lid, const char* file=0) Segment list constructor
virtual	~LockSegList (void) Segment list destructor
	LockSegList (void) Segment default constructor
bool	check (void) const Check that segments are inserted in order.
void	clear (void) Erase all the segments in the list
void	coalesce (void) Coalesce overlapping segments
size_type	find (const Time& t) const throw(std::domain_error) Look for the segment containing the specified time
size_type	findafter (const Time& t) const Find the first segment that ends after the specified time.
const char*	getListID (void) const Return the list title
bool	inSegment (const Time& t) const Test whether the specified time is within one of the segments in the list
bool	inSegment (const Time& t, const Time& t2) const Test whether any time between the specified start and end time is within one or more of the list segments
void	insert (const LockSegment& l) Insert a copy of the specified segment into the list.
void	invert (void) Invert the segment list.
Interval	live (Time start=Time(0), Time end=Time(SEGMENT_TINF)) const Calculate the "live time" of the segments list. Return the sum of all segment durations between the start and the end time.
void	merge (const LockSegment& seg) Insert a segment into the list.
void	pad (Interval pFront=0, Interval pBack=0) Pad the front and back of each segment in the list by pFront and pBack.
void	read (const std::string& file) Fill segment list from the contents of the specified file
void	setDebug (int lvl) Set the debug printout level
size_type	size (void) const Return the number of segments in the list
void	sort (void) Sort the list
void	stuff (const LockSegment& seg) Add an segment to the end of the list (unsorted insertion)
const LockSegment&	operator[] (size_type seg) const Return a constant reference to the specified segment
const LockSegment&	operator[] (const Time& t) const throw(std::domain_error) Return a constant reference to the segment containing the specified time
LockSegList&	operator|= (const LockSegList& t) Replace the current list with the union of the list and the argument
LockSegList&	operator&= (const LockSegList& t) Replace the current list with the intersection of the list and the argument
LockSegList&	operator^= (const LockSegList& t) Replace the current list with the differences between the current list and the argument list argument
bool	overlap (const Time& t, const Time& t2) const Test whether any segments in the list overlap the specified time span
std::ostream&	putID (std::ostream& out, size_type inx) const Write a segment specifier to the list.

Documentation

LockSegList is a list of LockSegment objects ordered by Start Time.

explicit LockSegList(const char* lid, const char* file=0)

Segment list constructor

virtual ~LockSegList(void)

Segment list destructor

LockSegList(void)

Segment default constructor

bool check(void) const

Check that segments are inserted in order. print errors to cerr.

void clear(void)

Erase all the segments in the list

void coalesce(void)

Coalesce overlapping segments

size_type find(const Time& t) const throw(std::domain_error)

Look for the segment containing the specified time

size_type findafter(const Time& t) const

Find the first segment that ends after the specified time. The index of the found segment is returned. If there are no segments after the specified time, an index equal to the size of segment list is returned.

const char* getListID(void) const

Return the list title

bool inSegment(const Time& t) const

Test whether the specified time is within one of the segments in the list

bool inSegment(const Time& t, const Time& t2) const

Test whether any time between the specified start and end time is within one or more of the list segments

void insert(const LockSegment& l)

Insert a copy of the specified segment into the list. The segment is inserted to maintain an increasing start-time order.

void invert(void)

Invert the segment list. The gaps between successive segments are converted to segments and the original segments are removed.

Interval live(Time start=Time(0), Time end=Time(SEGMENT_TINF)) const

Calculate the "live time" of the segments list. Return the sum of all segment durations between the start and the end time.

void merge(const LockSegment& seg)

Insert a segment into the list. If the segment overlaps existing one or more segments, the segments are combined. @merge a segment into the list.

Parameters:

seg - Segent to be merged intot the list.

void pad(Interval pFront=0, Interval pBack=0)

Pad the front and back of each segment in the list by pFront and pBack. The pFront and pBack intervals are defined such that a positive interval increases the segment duration and a negative interval decreases the resulting segment duration. i.e. the resulting segment is [start - pStart, end + pBack]. Segments are coalesced after the the padding is added.

Parameters:

pFront - Length of padding to add to the start of the segment.
pBack - Length of padding to add to the back of the segment.

void read(const std::string& file)

Fill segment list from the contents of the specified file

void setDebug(int lvl)

Set the debug printout level

size_type size(void) const

Return the number of segments in the list

void sort(void)

Sort the list

void stuff(const LockSegment& seg)

Add an segment to the end of the list (unsorted insertion)

const LockSegment& operator[](size_type seg) const

Return a constant reference to the specified segment

const LockSegment& operator[](const Time& t) const throw(std::domain_error)

Return a constant reference to the segment containing the specified time

LockSegList& operator|=(const LockSegList& t)

Replace the current list with the union of the list and the argument

LockSegList& operator&=(const LockSegList& t)

Replace the current list with the intersection of the list and the argument

LockSegList& operator^=(const LockSegList& t)

Replace the current list with the differences between the current list and the argument list argument

bool overlap(const Time& t, const Time& t2) const

Test whether any segments in the list overlap the specified time span

std::ostream& putID(std::ostream& out, size_type inx) const

Write a segment specifier to the list. The list specifier consists of the List ID followed by a hyphen and the segment identifier.

This class has no child classes.

Author:

J.Zweizig

Version:

1.2; last modified 11/03/2006

Alphabetic index HTML hierarchy of classes or Java

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