Interval Class Reference

#include <interval.h>

Class Description

See also

Advanced Topics sections on Intervals and Time Functions.

Description:

An Interval is a class that represents a length of time. It has two private data members, start and end that are each TimeValues. A TimeValue is a single instant in time. For more explanation see the Advanced Topics section on Intervals. All the methods of this class are implemented by the system.

Definitions:

#define FOREVER Interval(TIME_NegInfinity, TIME_PosInfinity)
#define NEVER Interval(TIME_NegInfinity, TIME_NegInfinity) 

Inheritance diagram for Interval:

Public Member Functions
CoreExport	Interval (TimeValue s, TimeValue e)
	Interval ()
int	operator== (const Interval &i) const
bool	operator!= (const Interval &i) const
CoreExport int	InInterval (const TimeValue t) const
int	InInterval (const Interval interval) const
bool	IsSubset (const Interval &subset) const
	Returns whether an interval is a subset of this interval. More...
int	Empty () const
bool	IsInfinite () const
void	Set (TimeValue s, TimeValue e)
void	SetStart (TimeValue s)
void	SetEnd (TimeValue e)
void	SetEmpty ()
void	SetInfinite ()
void	SetInstant (const TimeValue t)
TimeValue	Start () const
TimeValue	End () const
TimeValue	Duration () const
CoreExport Interval	operator& (const Interval i) const
Interval &	operator&= (const Interval i)
Interval &	operator+= (const TimeValue t)
CoreExport void	ApplyOffset (const TimeValue offset)

Additional Inherited Members
Static Public Member Functions inherited from MaxHeapOperators
static UtilExport void *	operator new (size_t size)
	Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e)
	Standard new operator used to allocate objects if there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new (size_t size, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate objects that takes the type of memory, filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new (size_t size, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void	operator delete (void *ptr)
	Standard delete operator used to deallocate an object If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an object If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an object that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete (void *ptr, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator. More...
static UtilExport void	operator delete (void *ptr, void *placement_ptr)
	Placement delete operator. More...

Constructor & Destructor Documentation

CoreExport Interval	(	TimeValue	s,
		TimeValue	e
	)

Remarks

Constructor that assigns both the start and end times of the interval. If TimeValue e is less than

TimeValue s the values are swapped before they are assigned.

Parameters:

TimeValue s

Specifies the start time.

TimeValue e

Specifies the end time.

Interval ( )

inline

Remarks

Constructor that returns an EMPTY interval, i.e. having a start and end time equal to TIME_NegInfinity

{ SetEmpty(); } 

Member Function Documentation

int operator== ( const Interval &  i ) const

inline

Remarks

Checks for equality between two Intervals.

Returns

Nonzero if the intervals are equal; otherwise 0.

{ return( i.start==start && i.end==end ); }

bool operator!= ( const Interval &  i ) const

inline

Remarks

Checks for inequality between two Intervals.

Returns

false if and only if the intervals are not equal.

{ return ((operator==(i)) == 0); }

CoreExport int InInterval

(

const TimeValue

t

)

const

Remarks

Return Nonzero if the TimeValue passed is greater than or equal to the start value and less than or equal to the end value and not equal to TIME_NegInfinity. Returns 0 otherwise.

Parameters:

const TimeValue t

Returns

Nonzero if the TimeValue passed is greater than or equal to the start value and less than or equal to the end value and not equal to TIME_NegInfinity; otherwise 0.

int InInterval ( const Interval  interval ) const

inline

Remarks

Returns nonzero if the interval passed is contained within the interval; otherwise 0.

return InInterval( interval.Start() ) && InInterval( interval.End() );

Parameters:

const Interval interval

The interval to check.

Returns

Returns nonzero if the interval passed is contained within the interval; otherwise 0.

{ return InInterval( interval.Start() ) && InInterval( interval.End() ); }

bool IsSubset ( const Interval &  subset ) const

inline

Returns whether an interval is a subset of this interval.

This method is different from InInterval() in the way that it deals with infinite and empty sets. Infinite sets are supersets of everything. Empty sets are subsets or everything.

{ return (IsInfinite() || subset.Empty() || InInterval(subset)); }

int Empty ( ) const

inline

Remarks

Returns 1 if the interval is EMPTY, i.e. has a start and end time equal to TIME_NegInfinity. Returns 0 otherwise.

{ return (start == TIME_NegInfinity) && (end == TIME_NegInfinity); }

bool IsInfinite ( ) const

inline

Remarks

Returns true if and only if the interval covers all possible time values, i.e. equals the result of calling SetInfinite().

{ return (start == TIME_NegInfinity) && (end == TIME_PosInfinity); }

void Set ( TimeValue  s, TimeValue  e  )

inline

Remarks

Sets the start and end times for the interval.

Parameters:

TimeValue s

Start time for the interval.

TimeValue e

End time for the interval.

{ start = s; end = e; }

void SetStart ( TimeValue  s )

inline

Remarks

Sets the start value only.

Parameters:

TimeValue s

Start time for the interval.

{ start = s;          }

void SetEnd ( TimeValue  e )

inline

Remarks

Sets the end value only.

Parameters:

TimeValue e

End time for the interval.

{ end = e;            }

void SetEmpty ( )

inline

Remarks

Sets the interval to be EMPTY, i.e. having a start and end time equal to TIME_NegInfinity.

{ start = TIME_NegInfinity; end = TIME_NegInfinity; }

void SetInfinite ( )

inline

Remarks

Sets the interval to be FOREVER, i.e. have a start time equal TIME_NegInfinity and end time equal to TIME_PosInfinity.

{ start = TIME_NegInfinity; end = TIME_PosInfinity; }

void SetInstant ( const TimeValue  t )

inline

Remarks

Sets both the start and end times to the time passed.

{ start = end = t; }

TimeValue Start ( ) const

inline

Remarks

Returns the start time of the interval.

{ return start; }

TimeValue End ( ) const

inline

Remarks

Returns the end time of the interval.

{ return end; }

TimeValue Duration ( ) const

inline

Remarks

Implemented by the System.

Returns the duration of the interval (end points included).

Operators:

{ return end-start+TimeValue(1); } // end points included

CoreExport Interval operator&

(

const Interval

i

)

const

Remarks

Intersects Interval and i. The interval will have a start time of the greater of the two interval start times, and an end value which is the lesser of the two end values. If the end time is less than the start time, both the start and end times are set to TIME_NegInfinity.

Returns

An Interval that is the intersection of the intervals.

Interval& operator&= ( const Interval  i )

inline

Remarks

This updates the invoking interval so it will have a start time of the greater of the two interval start times, and an end value which is the lesser of the two end values.

return (*this = (*this&i));

{ return (*this = (*this&i)); }

Interval& operator+= ( const TimeValue  t )

inline

Remarks

Expands the Interval to include the TimeValue.

if (t<start) start=t; if (t>end) end=t; return *this;

{ if (t<start) start=t; if (t>end) end=t; return *this; }

CoreExport void ApplyOffset

(

const TimeValue

offset

)

Remarks

Offsets the entire interval; shifts the beginning and end by the provided time value. Only effective if the interval is neither empty nor infinite. The offset may be positive or negative. Upon returning, the duration of the interval will be identical to what it was before the call, unless this is made impossible by clamping at either end of the valid numerical range.