A Curve Function Class to perform arbitrary mapping of values. More...

#include <CurveFunction.h>

Inheritance diagram for RTX::CurveFunction:

Collaboration diagram for RTX::CurveFunction:

Public Types
typedef boost::shared_ptr < CurveFunction >	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
virtual void	setSource (TimeSeries::sharedPointer source)
	Set the upstream TimeSeries object. More...

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

virtual void	setUnits (Units newUnits)

void	setInputUnits (Units inputUnits)

Units	inputUnits ()

void	addCurveCoordinate (double inputValue, double outputValue)

void	setCurve (std::vector< std::pair< double, double > > curve)

void	clearCurve ()

std::vector< std::pair< double, double > >	curve ()

virtual bool	canAlterDimension ()

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

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

virtual TimeSeries::sharedPointer	rootTimeSeries ()

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	resetCache ()

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

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< Point >	filteredPoints (TimeSeries::sharedPointer sourceTs, time_t fromTime, time_t toTime)

Protected Member Functions inherited from RTX::ModularTimeSeries
virtual bool	isCompatibleWith (TimeSeries::sharedPointer withTimeSeries)

Detailed Description

A Curve Function Class to perform arbitrary mapping of values.

This time series class allows you to specify points on a curve for value transformation, for instance transforming a tank level time series into a volume time series. Generally, can be used for dimensional conversions.

Member Function Documentation

Point CurveFunction::point ( time_t time )

virtual

option to add lots of (un)ordered points all at once.

Get a Point at a specific time.

Parameters

time	The requested time.

Returns: The requested Point, or the Point just prior to the passed time value.

See also: Point

Reimplemented from RTX::ModularTimeSeries.

void CurveFunction::setSource ( TimeSeries::sharedPointer source )

virtual

Set the upstream TimeSeries object.

Parameters

source A shared pointer to the intended upstream TimeSeries object.

Reimplemented from RTX::ModularTimeSeries.

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

CurveFunction.h
CurveFunction.cpp

Public Types

Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation