code::TimeWindow Class Reference

List of all members.

Detailed Description

A segment on the time line.

Author:
Thomas E. Vaughan
Version:
Author
Charles.Kerr
Date
2010/04/02 14:30:25
RCSfile
code_TimeWindow.h,v
See also:
Time, TimeInterval


Public Member Functions

 TimeWindow ()
 The default time window begins now and lasts for one minute.
 TimeWindow (const Time &b, const Time &e)
 Define a segment by its end points.
 TimeWindow (const Time &bound, const TimeInterval &length)
 Define a segment by a bound and length.
virtual ~TimeWindow ()
 Reproduce responsibly.
bool contains (const Time &) const
 Return true iff passed-in Time lies within TimeWindow (both extremes included).
bool contains (const Time &, const TimeInterval &) const
 Return true iff passed-in Time lies within this TimeInterval of this window.
void setDuration (const TimeInterval &)
 Set the duration of the time window.
TimeInterval getDuration () const
 Get the duration of the time window.
void setBeginning (const Time &)
 Set the beginning of the time window.
const TimegetBeginning () const
 Get the beginning of the time window.
void setEnd (const Time &)
 Set the end of the time window.
const TimegetEnd () const
 Get the end of the time window.


Constructor & Destructor Documentation

code::TimeWindow::TimeWindow (  ) 

The default time window begins now and lasts for one minute.

code::TimeWindow::TimeWindow ( const Time b,
const Time e 
) [inline]

Define a segment by its end points.

code::TimeWindow::TimeWindow ( const Time bound,
const TimeInterval length 
)

Define a segment by a bound and length.

A positive length implies that the bound is a lower bound. A negative length implies that the bound is an upper bound.

virtual code::TimeWindow::~TimeWindow (  )  [inline, virtual]

Reproduce responsibly.


Member Function Documentation

bool code::TimeWindow::contains ( const Time ,
const TimeInterval  
) const

Return true iff passed-in Time lies within this TimeInterval of this window.

A positive time interval has the effect of expanding this window, while a negative time interval has the effect of narrrowing it.

bool code::TimeWindow::contains ( const Time  )  const

Return true iff passed-in Time lies within TimeWindow (both extremes included).

const Time& code::TimeWindow::getBeginning (  )  const [inline]

Get the beginning of the time window.

TimeInterval code::TimeWindow::getDuration (  )  const

Get the duration of the time window.

const Time& code::TimeWindow::getEnd (  )  const [inline]

Get the end of the time window.

void code::TimeWindow::setBeginning ( const Time  ) 

Set the beginning of the time window.

void code::TimeWindow::setDuration ( const TimeInterval  ) 

Set the duration of the time window.

A positive duration repositions the upper bound, and a negative duration repositions the lower bound.

void code::TimeWindow::setEnd ( const Time  ) 

Set the end of the time window.


Generated on Fri May 4 13:40:12 2012 for WDSS-IIw2 by  doxygen 1.4.7