Rythmos::TimeRange< TimeType > Class Template Reference

Represent a time range. More...

#include <Rythmos_TimeRange.hpp>

Inheritance diagram for Rythmos::TimeRange< TimeType >:

[legend]

List of all members.

Public Member Functions
	TimeRange ()
	Construct an invalid range.
	TimeRange (const TimeType &lower, const TimeType &upper)
	Construct a valid range.
bool	isValid () const
TimeType	lower () const
TimeType	upper () const
TimeType	length () const
bool	isInRange (const TimeType &t) const
TimeRange< TimeType >	copyAndScale (const TimeType &scale) const
Related Functions
(Note that these are not member functions.)
template<class TimeType >
TimeRange< TimeType >	timeRange (const TimeType lower, const TimeType upper)
	Nonmember constructor.
template<class TimeType >
TimeRange< TimeType >	invalidTimeRange ()
	Nonmember constructor.
template<class TimeType >
bool	isInRange_cc (const TimeRange< TimeType > &tr, const TimeType &p)
	Nonmember isInRange function [closed, closed].
template<class TimeType >
bool	isInRange_oc (const TimeRange< TimeType > &tr, const TimeType &p)
	Nonmember isInRange function (open, closed].
template<class TimeType >
bool	isInRange_co (const TimeRange< TimeType > &tr, const TimeType &p)
	Nonmember isInRange function [closed, open).
template<class TimeType >
bool	isInRange_oo (const TimeRange< TimeType > &tr, const TimeType &p)
	Nonmember isInRange function (open, open).

---

Detailed Description

template<class TimeType>
class Rythmos::TimeRange< TimeType >

Represent a time range.

The compiler-generated default constructor, copy constructor, and assignment operators are allowed and perform correctly.

ToDo: Put in checks for the range if needed.

Definition at line 84 of file Rythmos_TimeRange.hpp.

---

Constructor & Destructor Documentation

template<class TimeType>

Rythmos::TimeRange< TimeType >::TimeRange

(

)

[inline]

Construct an invalid range.

Definition at line 87 of file Rythmos_TimeRange.hpp.

template<class TimeType>

Rythmos::TimeRange< TimeType >::TimeRange	(	const TimeType &	lower,
		const TimeType &	upper
	)			[inline]

Construct a valid range.

Definition at line 91 of file Rythmos_TimeRange.hpp.

---

Member Function Documentation

template<class TimeType>

bool Rythmos::TimeRange< TimeType >::isValid

(

)

const [inline]

Definition at line 99 of file Rythmos_TimeRange.hpp.

template<class TimeType>

TimeType Rythmos::TimeRange< TimeType >::lower

(

)

const [inline]

Definition at line 101 of file Rythmos_TimeRange.hpp.

template<class TimeType>

TimeType Rythmos::TimeRange< TimeType >::upper

(

)

const [inline]

Definition at line 103 of file Rythmos_TimeRange.hpp.

template<class TimeType>

TimeType Rythmos::TimeRange< TimeType >::length

(

)

const [inline]

Definition at line 105 of file Rythmos_TimeRange.hpp.

template<class TimeType>

bool Rythmos::TimeRange< TimeType >::isInRange

(

const TimeType &

t

)

const [inline]

Definition at line 107 of file Rythmos_TimeRange.hpp.

template<class TimeType>

TimeRange<TimeType> Rythmos::TimeRange< TimeType >::copyAndScale

(

const TimeType &

scale

)

const [inline]

Definition at line 115 of file Rythmos_TimeRange.hpp.

---

Friends And Related Function Documentation

template<class TimeType >

TimeRange< TimeType > timeRange	(	const TimeType	lower,
		const TimeType	upper
	)			[related]

Nonmember constructor.

Definition at line 137 of file Rythmos_TimeRange.hpp.

template<class TimeType >

TimeRange< TimeType > invalidTimeRange

(

)

[related]

Nonmember constructor.

Definition at line 149 of file Rythmos_TimeRange.hpp.

template<class TimeType >

bool isInRange_cc	(	const TimeRange< TimeType > &	tr,
		const TimeType &	p
	)			[related]

Nonmember isInRange function [closed, closed].

tr.lower() <= p <= tr.upper()

Definition at line 181 of file Rythmos_TimeRange.hpp.

template<class TimeType >

bool isInRange_oc	(	const TimeRange< TimeType > &	tr,
		const TimeType &	p
	)			[related]

Nonmember isInRange function (open, closed].

tr.lower() < p <= tr.upper()

Definition at line 197 of file Rythmos_TimeRange.hpp.

template<class TimeType >

bool isInRange_co	(	const TimeRange< TimeType > &	tr,
		const TimeType &	p
	)			[related]

Nonmember isInRange function [closed, open).

tr.lower() <= p < tr.upper()

Definition at line 213 of file Rythmos_TimeRange.hpp.

template<class TimeType >

bool isInRange_oo	(	const TimeRange< TimeType > &	tr,
		const TimeType &	p
	)			[related]

Nonmember isInRange function (open, open).

tr.lower() < p < tr.upper()

Definition at line 229 of file Rythmos_TimeRange.hpp.

---

The documentation for this class was generated from the following file:

• Rythmos_TimeRange.hpp