te::st::TimeSeriesObservation Class Reference

A class to represent an observation (time and value) of a time series. More...

#include <TimeSeriesObservation.h>

Public Member Functions

double getDouble () const
 It returns the value as a double. More...
 
int getInt () const
 It returns the value as a integer. More...
 
std::string getString () const
 It returns the value as a string. More...
 
te::dt::DateTimegetTime () const
 It returns the date time. More...
 
te::dt::AbstractDatagetValue () const
 It returns the value. More...
 
bool operator< (const TimeSeriesObservation &other) const
 Operator <. More...
 
void setTime (te::dt::DateTime *t)
 It sets the date time. More...
 
 TimeSeriesObservation (te::dt::DateTime *t, te::dt::AbstractData *v)
 Constructor. More...
 
 ~TimeSeriesObservation ()
 Destructor. More...
 

Protected Attributes

te::dt::DateTimeShrPtr m_time
 
te::dt::AbstractDataShrPtr m_value
 

Detailed Description

A class to represent an observation (time and value) of a time series.

See also
TimeSeries

Definition at line 60 of file TimeSeriesObservation.h.

Constructor & Destructor Documentation

te::st::TimeSeriesObservation::TimeSeriesObservation ( te::dt::DateTime t,
te::dt::AbstractData v 
)

Constructor.

Parameters
tA date time.
vA value.
Note
It will take the ownership of the input pointers.
te::st::TimeSeriesObservation::~TimeSeriesObservation ( )

Destructor.

Member Function Documentation

double te::st::TimeSeriesObservation::getDouble ( ) const

It returns the value as a double.

int te::st::TimeSeriesObservation::getInt ( ) const

It returns the value as a integer.

std::string te::st::TimeSeriesObservation::getString ( ) const

It returns the value as a string.

te::dt::DateTime* te::st::TimeSeriesObservation::getTime ( ) const

It returns the date time.

Note
The caller will not take the ownership of the returned pointer.
te::dt::AbstractData* te::st::TimeSeriesObservation::getValue ( ) const

It returns the value.

Note
The caller will not take the ownership of the returned pointer.
bool te::st::TimeSeriesObservation::operator< ( const TimeSeriesObservation other) const

Operator <.

It returns TRUE if the internal time is less than the time of the object "other". Otherwise, it returns FALSE.

void te::st::TimeSeriesObservation::setTime ( te::dt::DateTime t)

It sets the date time.

Note
The caller will take the ownership of the returned pointer.

Member Data Documentation

te::dt::DateTimeShrPtr te::st::TimeSeriesObservation::m_time
protected

Definition at line 115 of file TimeSeriesObservation.h.

te::dt::AbstractDataShrPtr te::st::TimeSeriesObservation::m_value
protected

Definition at line 116 of file TimeSeriesObservation.h.


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