All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
te::st::PointCoverageDataSetInfo Class Reference

A class that contains infos about a DataSource and DataSet that contains observations of a point coverage. More...

#include <PointCoverageDataSetInfo.h>

Inheritance diagram for te::st::PointCoverageDataSetInfo:
te::st::CoverageDataSetInfo

Public Member Functions

int getPointPropIdx () const
 It returns the property index that contains the points of the coverage. More...
 
std::auto_ptr< te::dt::DateTimegetTime () const
 It returns the date and time associated to the entire point coverage. More...
 
const std::vector< int > & getValuePropIdxs () const
 It returns the property indexes that contains the values of the coverage. More...
 
 PointCoverageDataSetInfo (const te::da::DataSourceInfo &dsinfo, const std::string &dsName, int tPropIdx, int ptPropIdx, int vlPropIdx, te::dt::DateTime *time)
 Constructor. More...
 
 PointCoverageDataSetInfo (const te::da::DataSourceInfo &dsinfo, const std::string &dsName, int ptPropIdx, int vlPropIdx, te::dt::DateTime *time)
 Constructor. More...
 
 PointCoverageDataSetInfo (const te::da::DataSourceInfo &dsinfo, const std::string &dsName, const std::vector< int > &tPropIdx, int ptPropIdx, const std::vector< int > &vlPropIdx, te::dt::DateTime *time)
 Constructor. More...
 
 PointCoverageDataSetInfo (const te::da::DataSourceInfo &dsinfo, const std::string &dsName, int ptPropIdx, const std::vector< int > &vlPropIdx, te::dt::DateTime *time)
 Constructor. More...
 
 PointCoverageDataSetInfo (const ObservationDataSetInfo &info, const std::vector< int > &vlPropIdxs, te::dt::DateTime *time)
 Constructor. More...
 
virtual ~PointCoverageDataSetInfo ()
 Virtual destructor. More...
 
Inhered methods
te::st::CoverageType getCoverageType () const
 It returns the type of the coverage. More...
 
const ObservationDataSetInfogetObservationDataSetInfo () const
 It returns information about the DataSet that contains the coverage observations. More...
 
const te::da::DataSourceInfogetDataSourceInfo () const
 It returns information about the DataSource from which the DataSet comes. More...
 
const std::vector< int > & getTimePropIdxs () const
 It returns the indexes of the DataSet properties that contains the times associated to the coverage. More...
 

Protected Attributes

ObservationDataSetInfo m_obsDsInfo
 Infos about the DataSource and DataSet that contains the point coverage observations. More...
 
std::auto_ptr< te::dt::DateTimem_time
 
std::vector< int > m_vlPropIdx
 The indexes of the properties that contain the point coverage values. More...
 

Detailed Description

A class that contains infos about a DataSource and DataSet that contains observations of a point coverage.

See also
ObservationDataSetInfo

Definition at line 50 of file PointCoverageDataSetInfo.h.

Constructor & Destructor Documentation

te::st::PointCoverageDataSetInfo::PointCoverageDataSetInfo ( const te::da::DataSourceInfo dsinfo,
const std::string &  dsName,
int  tPropIdx,
int  ptPropIdx,
int  vlPropIdx,
te::dt::DateTime time 
)

Constructor.

A user must use this constructor when the DataSet has a property that contain a date and time associated to each observation.

Parameters
dsinfoInfos about the DataSource.
dsNameThe DataSet name.
tPropIdxThe property index that contains the times associated to the coverage observations.
ptPropIdxThe property index that contains the points associated to the coverage observations.
vlPropIdxThe property index that contains the values of the coverage.
timeThe date and time associated to the entire point coverage.

Definition at line 31 of file PointCoverageDataSetInfo.cpp.

te::st::PointCoverageDataSetInfo::PointCoverageDataSetInfo ( const te::da::DataSourceInfo dsinfo,
const std::string &  dsName,
int  ptPropIdx,
int  vlPropIdx,
te::dt::DateTime time 
)

Constructor.

A user must use this constructor when the DataSet has NOT a property that contain a date and time associated to each observation.

Parameters
dsinfoInfos about the DataSource.
dsNameThe DataSet name.
ptPropIdxThe property index that contains the points associated to the coverage.
vlPropIdxThe property index that contains the values of the coverage.
timeThe date and time associated to the entire point coverage.
Note
It will take the ownership of the given pointers.

Definition at line 39 of file PointCoverageDataSetInfo.cpp.

te::st::PointCoverageDataSetInfo::PointCoverageDataSetInfo ( const te::da::DataSourceInfo dsinfo,
const std::string &  dsName,
const std::vector< int > &  tPropIdx,
int  ptPropIdx,
const std::vector< int > &  vlPropIdx,
te::dt::DateTime time 
)

Constructor.

A user must use this constructor when the DataSet has a property that contain a date and time associated to each observation.

Parameters
dsinfoInfos about the DataSource.
dsNameThe DataSet name.
tPropIdxThe property indexes that contains the times associated to the coverage observations.
ptPropIdxThe property index that contains the points associated to the coverage observations.
vlPropIdxThe property index that contains the values of the coverage observations.
timeThe date and time associated to the entire point coverage.

Definition at line 47 of file PointCoverageDataSetInfo.cpp.

te::st::PointCoverageDataSetInfo::PointCoverageDataSetInfo ( const te::da::DataSourceInfo dsinfo,
const std::string &  dsName,
int  ptPropIdx,
const std::vector< int > &  vlPropIdx,
te::dt::DateTime time 
)

Constructor.

A user must use this constructor when the DataSet has NOT a property that contain a date and time associated to each observation.

Parameters
dsinfoInfos about the DataSource.
dsNameThe DataSet name.
ptPropIdxThe property index that contains the points associated to the coverage observations.
vlPropIdxThe property index that contains the values of the coverage observations.
timeThe date and time associated to the entire point coverage.
Note
It will take the ownership of the given pointers.

Definition at line 56 of file PointCoverageDataSetInfo.cpp.

te::st::PointCoverageDataSetInfo::PointCoverageDataSetInfo ( const ObservationDataSetInfo info,
const std::vector< int > &  vlPropIdxs,
te::dt::DateTime time 
)

Constructor.

Parameters
infoInfos about the DataSource and DataSet that contains the coverage observations
vlPropIdxThe property index that contains the values of the coverage.
timeThe date and time associated to the entire point coverage.
Note
It will take the ownership of the given pointers.

Definition at line 64 of file PointCoverageDataSetInfo.cpp.

te::st::PointCoverageDataSetInfo::~PointCoverageDataSetInfo ( )
virtual

Virtual destructor.

Definition at line 107 of file PointCoverageDataSetInfo.cpp.

Member Function Documentation

te::st::CoverageType te::st::PointCoverageDataSetInfo::getCoverageType ( ) const
virtual

It returns the type of the coverage.

Returns
the type of the coverage.

Implements te::st::CoverageDataSetInfo.

Definition at line 72 of file PointCoverageDataSetInfo.cpp.

References te::st::POINT_COVERAGE.

const te::da::DataSourceInfo & te::st::PointCoverageDataSetInfo::getDataSourceInfo ( ) const
virtual

It returns information about the DataSource from which the DataSet comes.

Returns
A reference to the internal DataSourceInfo.

Implements te::st::CoverageDataSetInfo.

Definition at line 82 of file PointCoverageDataSetInfo.cpp.

Referenced by te::st::STDataLoader::getCoverage().

const te::st::ObservationDataSetInfo & te::st::PointCoverageDataSetInfo::getObservationDataSetInfo ( ) const
virtual

It returns information about the DataSet that contains the coverage observations.

Returns
A reference to the internal ObservationDataSetInfo.

Implements te::st::CoverageDataSetInfo.

Definition at line 77 of file PointCoverageDataSetInfo.cpp.

Referenced by te::st::STDataLoader::getCoverage().

int te::st::PointCoverageDataSetInfo::getPointPropIdx ( ) const

It returns the property index that contains the points of the coverage.

Returns
The property index that contains the points of the coverage.

Definition at line 92 of file PointCoverageDataSetInfo.cpp.

Referenced by te::st::STDataLoader::getCoverage().

std::auto_ptr< te::dt::DateTime > te::st::PointCoverageDataSetInfo::getTime ( ) const

It returns the date and time associated to the entire point coverage.

Returns
The date and time associated to the point coverage.

Definition at line 102 of file PointCoverageDataSetInfo.cpp.

Referenced by te::st::STDataLoader::getCoverage().

const std::vector< int > & te::st::PointCoverageDataSetInfo::getTimePropIdxs ( ) const
virtual

It returns the indexes of the DataSet properties that contains the times associated to the coverage.

Returns
The indexes of the DataSet properties that contains the time.

Implements te::st::CoverageDataSetInfo.

Definition at line 87 of file PointCoverageDataSetInfo.cpp.

Referenced by te::st::STDataLoader::getCoverage().

const std::vector< int > & te::st::PointCoverageDataSetInfo::getValuePropIdxs ( ) const

It returns the property indexes that contains the values of the coverage.

Returns
The property indexes that contains the values of the coverage.

Definition at line 97 of file PointCoverageDataSetInfo.cpp.

Referenced by te::st::STDataLoader::getCoverage().

Member Data Documentation

ObservationDataSetInfo te::st::PointCoverageDataSetInfo::m_obsDsInfo
protected

Infos about the DataSource and DataSet that contains the point coverage observations.

Definition at line 170 of file PointCoverageDataSetInfo.h.

std::auto_ptr<te::dt::DateTime> te::st::PointCoverageDataSetInfo::m_time
protected

Definition at line 172 of file PointCoverageDataSetInfo.h.

std::vector<int> te::st::PointCoverageDataSetInfo::m_vlPropIdx
protected

The indexes of the properties that contain the point coverage values.

Definition at line 171 of file PointCoverageDataSetInfo.h.


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