FBTimeSpan Class Reference

Search for all occurrences

Detailed Description

TimeSpan class.

Definition at line 320 of file fbtime.h.

#include <fbtime.h>

List of all members.

Public Member Functions
	FBTimeSpan (FBTime pStart=0, FBTime pStop=0)
	Constructor.
void	Set (FBTime pStart, FBTime pStop)
	Set the TimeSpan.
FBTime	GetDuration ()
	Get the unsigned duration value of a timespan.
FBTime	GetSignedDuration ()
	Get the signed duration value of a timespan.
int	GetDirection ()
	Get the direction of the timespan.
bool	operator& (FBTime &pTime)
	Verify if pTime is contained within the timespan.
FBTimeSpan	operator& (FBTimeSpan &pTimeSpan)
	Calculate the intersection of two timespans.

FBTime &	GetStart ()
	Get the start/stop time.
FBTime &	GetStop ()
const FBTime &	GetStart () const
const FBTime &	GetStop () const

Constructor & Destructor Documentation

FBTimeSpan	(	FBTime	pStart = `0`,
		FBTime	pStop = `0`
	)

Constructor.

Parameters:

pStart	Start time(default=0).
pStop	Stop time(default=0).

Member Function Documentation

FBTime& GetStart ( )

Search for all occurrences

Get the start/stop time.

Returns:: Start/Stop time.

FBTime& GetStop ( )

Search for all occurrences

const FBTime& GetStart ( ) const

Search for all occurrences

const FBTime& GetStop ( ) const

Search for all occurrences

void Set	(	FBTime	pStart,
		FBTime	pStop
	)

Search for all occurrences

Set the TimeSpan.

Parameters:

pStart	Start time.
pStop	Stop time.

FBTime GetDuration ( )

Search for all occurrences

Get the unsigned duration value of a timespan.

Returns:: Unsigned duration of the timespan.

FBTime GetSignedDuration ( )

Search for all occurrences

Get the signed duration value of a timespan.

Returns:: Signed duration of the timespan.

int GetDirection ( )

Search for all occurrences

Get the direction of the timespan.

Returns 1 if positive, -1 otherwise.

Returns:: Direction of timespan.

bool operator& ( FBTime & pTime )

Verify if pTime is contained within the timespan.

Parameters:

pTime Time to verify if within the timespan.

Returns:: true if pTime is within the timespan.

FBTimeSpan operator& ( FBTimeSpan & pTimeSpan )

Calculate the intersection of two timespans.

Returns:: Timespan representing the intersection of the two timespans.

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

fbsdk/fbtime.h