An abstract timeseries class for computing statistical data from point values. More...

#include <BaseStatsTimeSeries.h>

Inheritance diagram for RTX::BaseStatsTimeSeries:

Collaboration diagram for RTX::BaseStatsTimeSeries:

Public Types
enum	StatsSamplingMode_t { StatsSamplingModeLeading = 0, StatsSamplingModeLagging = 1, StatsSamplingModeCentered = 2 }
	sampling window mode (lead, lag, center) More...

typedef std::pair< Point, Statistics >	pointSummaryPair_t

typedef boost::shared_ptr < BaseStatsTimeSeries >	sharedPointer

Public Types inherited from RTX::ModularTimeSeries
typedef boost::shared_ptr < ModularTimeSeries >	sharedPointer

Public Types inherited from RTX::TimeSeries
typedef boost::shared_ptr < TimeSeries >	sharedPointer

Public Member Functions
void	setWindow (Clock::sharedPointer window)
	Set the moving statistical window. More...

Clock::sharedPointer	window ()
	Get the statistical sampling window clock. More...

void	setSamplingMode (StatsSamplingMode_t mode)

StatsSamplingMode_t	samplingMode ()

bool	summaryOnly ()

void	setSummaryOnly (bool summaryOnly)

Public Member Functions inherited from RTX::ModularTimeSeries
virtual TimeSeries::sharedPointer	source ()
	Get the source of this time series. More...

virtual void	setSource (TimeSeries::sharedPointer source)
	Set the upstream TimeSeries object. More...

virtual bool	doesHaveSource ()
	Does this Modular time series have an upstream source? More...

virtual TimeSeries::sharedPointer	rootTimeSeries ()

virtual Point	point (time_t time)
	option to add lots of (un)ordered points all at once. More...

virtual Point	pointBefore (time_t time)

virtual Point	pointAfter (time_t time)

virtual std::vector< Point >	points (time_t start, time_t end)
	Get a vector of Points within a specific time range. More...

virtual void	setUnits (Units newUnits)

virtual void	resetCache ()

virtual std::ostream &	toStream (std::ostream &stream)

virtual bool	canAlterDimension ()

virtual bool	canAlterClock ()

Public Member Functions inherited from RTX::TimeSeries
virtual void	insert (Point aPoint)

virtual void	insertPoints (std::vector< Point >)

virtual Point	pointAtOrBefore (time_t time)

virtual Point	interpolatedPoint (time_t time)

virtual std::pair< Point, Point >	adjacentPoints (time_t time)

virtual time_t	period ()

virtual std::string	name ()
	1/frequency (# seconds between data points)

PointRecord::sharedPointer	record ()

TimeSeries::Statistics	summary (time_t start, time_t end)

TimeSeries::Statistics	gapsSummary (time_t start, time_t end)

std::vector< Point >	gaps (time_t start, time_t end)

virtual void	setName (const std::string &name)

void	setRecord (PointRecord::sharedPointer record)

virtual void	setClock (Clock::sharedPointer clock)

Clock::sharedPointer	clock ()

Units	units ()

void	setFirstTime (time_t time)

void	setLastTime (time_t time)

time_t	firstTime ()

time_t	lastTime ()

Protected Member Functions
virtual std::vector < pointSummaryPair_t >	filteredSummaryPoints (TimeSeries::sharedPointer sourceTs, time_t fromTime, time_t toTime)

Protected Member Functions inherited from RTX::ModularTimeSeries
virtual std::vector< Point >	filteredPoints (TimeSeries::sharedPointer sourceTs, time_t fromTime, time_t toTime)

virtual bool	isCompatibleWith (TimeSeries::sharedPointer withTimeSeries)

Detailed Description

An abstract timeseries class for computing statistical data from point values.

The BaseStatsTimeSeries class is designed to provide a moving window (specified by the period length of a Clock in window ), evaluated at regular intervals (also as a Clock), over which statistical measures are taken. The window can lead, lag, or be centered on the time series' clock.

Member Enumeration Documentation

enum RTX::BaseStatsTimeSeries::StatsSamplingMode_t

sampling window mode (lead, lag, center)

Enumerator
StatsSamplingModeLeading	Use a leading window about the time series' clock
StatsSamplingModeLagging	Use a lagging window
StatsSamplingModeCentered	Use a centered sampling window

Member Function Documentation

void RTX::BaseStatsTimeSeries::setWindow ( Clock::sharedPointer window )

Set the moving statistical window.

Parameters

window A moving window to use for statistical calculations

See also: BaseStatsTimeSeries::window

Clock::sharedPointer RTX::BaseStatsTimeSeries::window ( )

Get the statistical sampling window clock.

Returns: A shared pointer to a Clock object.

See also: BaseStatsTimeSeries::setWindow

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

BaseStatsTimeSeries.h
BaseStatsTimeSeries.cpp

Public Types

Public Member Functions

Protected Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation