te::st::Object Class Reference

A class to represent an object. More...

#include <Object.h>

Public Member Functions

Objectclone () const
 It returns a clone of this object. More...
 
std::string getId () const
 It returns the object identification. More...
 
std::pair< te::dt::AbstractData *, te::gm::Geometry * > getState (te::dt::DateTime *t) const
 It returns the state of the object at a given date and time. More...
 
TimeSeriesgetTimeSeries () const
 It returns the time series associated to the object. More...
 
TrajectorygetTrajectory () const
 It returns the trajectory associated to the object. More...
 
Objectoperator= (const Object &other)
 Copy assignment operator. More...
 
void setId (const std::string &id)
 It sets the object identification. More...
 
void setTimeSeries (TimeSeries *ts)
 It sets the time series associated to the object. More...
 
void setTrajectory (Trajectory *tj)
 It sets the trajectory associated to the object. More...
 
virtual ~Object ()
 Virtual destructor. More...
 
Object Constructors
 Object (const std::string &id, TimeSeries *ts, Trajectory *tj)
 Constructor. More...
 
 Object (const std::string &id, TimeSeries *ts)
 Constructor. More...
 
 Object (const std::string &id, Trajectory *tj)
 Constructor. More...
 
 Object (const Object &obj)
 Copy constructor. More...
 

Private Attributes

std::string m_id
 The time series identification. More...
 
std::auto_ptr< TimeSeriesm_timeseries
 The variation of a property of the object. More...
 
std::auto_ptr< Trajectorym_trajectory
 The variation of the spatial property of the object. More...
 

Detailed Description

A class to represent an object.

An object is an identifiable entity whose spatial and non-spatial properties can change. The spatial property variation is represented by a trajectory and the non-spatial property variation by a time series. This first version will consider only a non-spatial property.

See also
TimeSeries Trajectory

Definition at line 59 of file Object.h.

Constructor & Destructor Documentation

te::st::Object::Object ( const std::string &  id,
TimeSeries ts,
Trajectory tj 
)

Constructor.

Parameters
idThe identification of the object.
tsThe time series that represents the variation of a non-spatial property.
tjThe trajectory that represents the variation of the spatial property.
Note
It will take the ownership of the input pointers.
te::st::Object::Object ( const std::string &  id,
TimeSeries ts 
)

Constructor.

Parameters
idThe identification of the object.
tsThe time series that represents the variation of a non-spatial property.
Note
It will take the ownership of the input pointers.
te::st::Object::Object ( const std::string &  id,
Trajectory tj 
)

Constructor.

Parameters
idThe identification of the object.
tjThe trajectory that represents the variation of the spatial property.
Note
It will take the ownership of the input pointers.
te::st::Object::Object ( const Object obj)

Copy constructor.

virtual te::st::Object::~Object ( )
virtual

Virtual destructor.

Member Function Documentation

Object* te::st::Object::clone ( ) const

It returns a clone of this object.

Returns
A new object.
Note
The caller will take the ownership of the returned pointer.
std::string te::st::Object::getId ( ) const

It returns the object identification.

Returns
The object identification.
std::pair<te::dt::AbstractData*,te::gm::Geometry*> te::st::Object::getState ( te::dt::DateTime t) const

It returns the state of the object at a given date and time.

Parameters
tThe given date and time.
Returns
A pair of the value and geometry of the object at the given time.
Note
The caller will take the ownership of the returned pointers.
TimeSeries* te::st::Object::getTimeSeries ( ) const

It returns the time series associated to the object.

Returns
A pointer to the time series associated to the object.
Note
The caller will NOT take the ownership of the returned pointer.
Trajectory* te::st::Object::getTrajectory ( ) const

It returns the trajectory associated to the object.

Returns
A pointer to the trajectory associated to the object.
Note
The caller will NOT take the ownership of the returned pointer.
Object& te::st::Object::operator= ( const Object other)

Copy assignment operator.

void te::st::Object::setId ( const std::string &  id)

It sets the object identification.

Parameters
idThe object identification.
void te::st::Object::setTimeSeries ( TimeSeries ts)

It sets the time series associated to the object.

Parameters
tsThe time series to be set.
Note
It will take the ownership of the input pointer.
void te::st::Object::setTrajectory ( Trajectory tj)

It sets the trajectory associated to the object.

Parameters
tsThe trajectory associated to the object.
Note
It will take the ownership of the input pointer.

Member Data Documentation

std::string te::st::Object::m_id
private

The time series identification.

Definition at line 183 of file Object.h.

std::auto_ptr<TimeSeries> te::st::Object::m_timeseries
private

The variation of a property of the object.

Definition at line 185 of file Object.h.

std::auto_ptr<Trajectory> te::st::Object::m_trajectory
private

The variation of the spatial property of the object.

Definition at line 184 of file Object.h.


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