GKContext Class Reference

Public Member Functions
	GKContext ()
void	setTime (const QDateTime &f, const QDateTime &t, const QDateTime &n)
void	setFrom (const QDateTime &)
void	setNow (const QDateTime &)
void	setTo (const QDateTime &)
const QDateTime &	getNow () const
const QDateTime &	getFrom () const
const QDateTime &	getTo () const
bool	sameDay () const
void	setAggregated (bool)
bool	isAggregated () const
GK::AggregationType	getAggregationType () const
void	setAggregationType (GK::AggregationType t)

Static Public Attributes
static GKContext	anyContext

Detailed Description

A GKContext holds the initial and end time for data that depends on time (as time series either produced by a simulator or from real detection data).

It also includes a "now" time used to fetch (or show) data at a given instant.

See also

GKObject, GKTimeSerie, GKTSDescription

Constructor & Destructor Documentation

GKContext()

GKContext::GKContext

(

)

Member Function Documentation

getAggregationType()

GK::AggregationType GKContext::getAggregationType

(

)

const

Defines the aggregation type to be used when the context is aggregated.

getFrom()

const QDateTime & GKContext::getFrom

(

)

const

Returns 'from' time.

getNow()

const QDateTime & GKContext::getNow

(

)

const

Returns 'now' time.

getTo()

const QDateTime & GKContext::getTo

(

)

const

Returns 'to' time.

isAggregated()

bool GKContext::isAggregated

(

)

const

On time series, it returns the aggregated data instead of an interval value

sameDay()

bool GKContext::sameDay

(

)

const

Returns true if the initial and end time are in the same day.

setAggregated()

void GKContext::setAggregated

(

bool

)

On time series, it returns the aggregated data instead of an interval value

setAggregationType()

void GKContext::setAggregationType

(

GK::AggregationType

t

)

Defines the aggregation type to be used when the context is aggregated.

setFrom()

void GKContext::setFrom

(

const QDateTime &

)

Sets 'from' time.

setNow()

void GKContext::setNow

(

const QDateTime &

)

Sets 'now' time.

setTime()

void GKContext::setTime	(	const QDateTime &	f,
		const QDateTime &	t,
		const QDateTime &	n
	)

Sets the 'from', 'to' and 'now' times

setTo()

void GKContext::setTo

(

const QDateTime &

)

Sets 'to' time.

Member Data Documentation

anyContext

GKContext GKContext::anyContext

static

A special value for methods that expect a GKContext. This value means that we will not care about the time context when accessing the information.