SensorData Class Reference

Detailed Description

A container for sensor data at an observation site. The class stores a number of time series and has been created for use in Station-objects.

See also

Station

Definition at line 51 of file SensorData.h.

#include <SensorData.h>

Public Member Functions
	SensorData (const std::string &file_name)
	SensorData (std::vector< std::size_t > time_steps)
	~SensorData ()
void	addTimeSeries (const std::string &data_name, std::vector< float > *data, const std::string &data_unit_string="")
void	addTimeSeries (SensorDataType data_name, std::vector< float > *data, const std::string &data_unit_string="")
const std::vector< float > *	getTimeSeries (SensorDataType time_series_name) const
	Returns the time series with the given name.
const std::vector< SensorDataType > &	getTimeSeriesNames () const
	Returns all time series names contained in this container.
const std::vector< std::size_t > &	getTimeSteps () const
	Returns the time step vector (if it exists)
std::size_t	getStartTime () const
	Returns the first time step.
std::size_t	getEndTime () const
	Returns the last time step.
std::size_t	getStepSize () const
void	setTimeUnit (TimeStepType t)
	Allows to set a unit for the time steps.
TimeStepType	getTimeUnit () const
	Returns the unit the time steps.

Static Public Member Functions
static std::string	convertSensorDataType2String (SensorDataType t)
	Converts Sensor Data Types to Strings.
static SensorDataType	convertString2SensorDataType (const std::string &s)
	Converts Strings to Sensor Data Types.

Private Member Functions
int	readDataFromFile (const std::string &file_name)
	Reads a CSV-file with time series data and fills the container.

Private Attributes
std::size_t	_start
std::size_t	_end
std::size_t	_step_size
TimeStepType	_time_unit
std::vector< std::string >	_data_unit_string
std::vector< std::size_t >	_time_steps
std::vector< SensorDataType >	_vec_names
std::vector< std::vector< float > * >	_data_vecs

Constructor & Destructor Documentation

SensorData() [1/2]

SensorData::SensorData ( const std::string & file_name )

explicit

Constructor using file name (automatically reads the file and fills all data structures)

Definition at line 14 of file SensorData.cpp.

    : _start(0), _end(0), _step_size(0), _time_unit(TimeStepType::NONE)
{
    readDataFromFile(file_name);
}

References _end, _start, _step_size, _time_unit, NONE, and readDataFromFile().

SensorData() [2/2]

SensorData::SensorData ( std::vector< std::size_t > time_steps )

explicit

Constructor using a time step vector valid for all time series that will be added later

Definition at line 20 of file SensorData.cpp.

    : _start(time_steps.front()),
      _end(time_steps.back()),
      _step_size(0),
      _time_unit(TimeStepType::NONE),
      _time_steps(time_steps)
{
    if (!std::is_sorted(
            time_steps.begin(), time_steps.end(), std::less_equal{}))
    {
        ERR("Error in SensorData() - Time series has no order!");
    }
}

References _end, _start, _step_size, _time_steps, _time_unit, and NONE.

~SensorData()

SensorData::~SensorData

(

)

Definition at line 34 of file SensorData.cpp.

{
    for (std::vector<float>* vec : _data_vecs)
    {
        delete vec;
    }
}

References _data_vecs.

Member Function Documentation

addTimeSeries() [1/2]

void SensorData::addTimeSeries	(	const std::string &	data_name,
		std::vector< float > *	data,
		const std::string &	data_unit_string = "" )

Adds a time series that needs to conform to the time step vector specified in the constructor. Optionally a unit for the time series can be given. The name is converted to SensorDataType enum.

Definition at line 42 of file SensorData.cpp.

{
    addTimeSeries(SensorData::convertString2SensorDataType(data_name),
                  data,
                  data_unit_string);
}

References addTimeSeries(), and convertString2SensorDataType().

Referenced by addTimeSeries().

addTimeSeries() [2/2]

void SensorData::addTimeSeries	(	SensorDataType	data_name,
		std::vector< float > *	data,
		const std::string &	data_unit_string = "" )

Adds a time series that needs to conform to the time step vector specified in the constructor. Optionally a unit for the time series can be given.

Definition at line 51 of file SensorData.cpp.

{
    if (_step_size > 0)
    {
        if (((_end - _start) / _step_size) != data->size())
        {
            WARN(
                "Warning in SensorData::addTimeSeries() - Lengths of time "
                "series does not match number of time steps.");
            return;
        }
    }
    else
    {
        if (data->size() != _time_steps.size())
        {
            WARN(
                "Warning in SensorData::addTimeSeries() - Lengths of time "
                "series does not match number of time steps.");
            return;
        }
    }
 
    _vec_names.push_back(data_name);
    _data_vecs.push_back(data);
    _data_unit_string.push_back(data_unit_string);
}

References _data_unit_string, _data_vecs, _end, _start, _step_size, _time_steps, _vec_names, and WARN().

convertSensorDataType2String()

std::string SensorData::convertSensorDataType2String ( SensorDataType t )

static

Converts Sensor Data Types to Strings.

Definition at line 161 of file SensorData.cpp.

{
    if (SensorDataType::EVAPORATION == t)
    {
        return "Evaporation";
    }
    if (SensorDataType::PRECIPITATION == t)
    {
        return "Precipitation";
    }
    if (SensorDataType::TEMPERATURE == t)
    {
        return "Temperature";
    }
    // pls leave this as last choice
    return "Unknown";
}

References EVAPORATION, PRECIPITATION, and TEMPERATURE.

Referenced by getTimeSeries(), and DiagramList::readList().

convertString2SensorDataType()

SensorDataType SensorData::convertString2SensorDataType ( const std::string & s )

static

Converts Strings to Sensor Data Types.

Definition at line 179 of file SensorData.cpp.

{
    if (s == "Evaporation" || s == "EVAPORATION")
    {
        return SensorDataType::EVAPORATION;
    }
    if (s == "Precipitation" || s == "PRECIPITATION")
    {
        return SensorDataType::PRECIPITATION;
    }
    if (s == "Temperature" || s == "TEMPERATURE")
    {
        return SensorDataType::TEMPERATURE;
    }
    return SensorDataType::OTHER;
}

References EVAPORATION, OTHER, PRECIPITATION, and TEMPERATURE.

Referenced by addTimeSeries(), and readDataFromFile().

getEndTime()

std::size_t SensorData::getEndTime ( ) const

inline

Returns the last time step.

Definition at line 93 of file SensorData.h.

{ return _end; }

References _end.

Referenced by DiagramPrefsDialog::DiagramPrefsDialog(), and DiagramList::readList().

getStartTime()

std::size_t SensorData::getStartTime ( ) const

inline

Returns the first time step.

Definition at line 90 of file SensorData.h.

{ return _start; }

References _start.

Referenced by DiagramPrefsDialog::DiagramPrefsDialog(), and DiagramList::readList().

getStepSize()

std::size_t SensorData::getStepSize ( ) const

inline

Returns the interval between time steps (Returns "0" if a vector is given!)

Definition at line 97 of file SensorData.h.

{ return _step_size; }

References _step_size.

Referenced by DiagramList::readList().

getTimeSeries()

const std::vector< float > * SensorData::getTimeSeries

(

SensorDataType

time_series_name

)

const

Returns the time series with the given name.

Definition at line 81 of file SensorData.cpp.

{
    for (std::size_t i = 0; i < _vec_names.size(); i++)
    {
        if (time_series_name == _vec_names[i])
        {
            return _data_vecs[i];
        }
    }
    ERR("Error in SensorData::getTimeSeries() - Time series '{:s}' not found.",
        convertSensorDataType2String(time_series_name));
    return nullptr;
}

References _data_vecs, _vec_names, convertSensorDataType2String(), and ERR().

Referenced by DiagramList::readList().

getTimeSeriesNames()

const std::vector< SensorDataType > & SensorData::getTimeSeriesNames ( ) const

inline

Returns all time series names contained in this container.

Definition at line 81 of file SensorData.h.

    {
        return _vec_names;
    }

References _vec_names.

Referenced by DiagramList::readList().

getTimeSteps()

const std::vector< std::size_t > & SensorData::getTimeSteps ( ) const

inline

Returns the time step vector (if it exists)

Definition at line 87 of file SensorData.h.

{ return _time_steps; }

References _time_steps.

Referenced by DiagramList::readList().

getTimeUnit()

TimeStepType SensorData::getTimeUnit ( ) const

inline

Returns the unit the time steps.

Definition at line 103 of file SensorData.h.

{ return _time_unit; }

References _time_unit.

readDataFromFile()

int SensorData::readDataFromFile ( const std::string & file_name )

private

Reads a CSV-file with time series data and fills the container.

Definition at line 96 of file SensorData.cpp.

{
    std::ifstream in(file_name.c_str());
 
    if (!in.is_open())
    {
        INFO("SensorData::readDataFromFile() - Could not open file {:s}.",
             file_name);
        return 0;
    }
 
    std::string line;
 
    /* first line contains field names */
    std::getline(in, line);
    std::list<std::string> fields = BaseLib::splitString(line, '\t');
    std::list<std::string>::const_iterator it(fields.begin());
    std::size_t const nFields = fields.size();
 
    if (nFields < 2)
    {
        return 0;
    }
 
    std::size_t const nDataArrays(nFields - 1);
 
    // create vectors necessary to hold the data
    for (std::size_t i = 0; i < nDataArrays; i++)
    {
        _vec_names.push_back(SensorData::convertString2SensorDataType(*++it));
        _data_unit_string.emplace_back("");
        _data_vecs.push_back(new std::vector<float>);
    }
 
    while (std::getline(in, line))
    {
        fields = BaseLib::splitString(line, '\t');
 
        if (nFields != fields.size())
        {
            return 0;
        }
 
        it = fields.begin();
        std::size_t const pos(it->rfind("."));
        std::size_t const current_time_step = (pos == std::string::npos)
                                                  ? atoi((it++)->c_str())
                                                  : BaseLib::strDate2int(*it++);
        _time_steps.push_back(current_time_step);
 
        for (std::size_t i = 0; i < nDataArrays; i++)
        {
            _data_vecs[i]->push_back(
                static_cast<float>(strtod((it++)->c_str(), nullptr)));
        }
    }
 
    in.close();
 
    _start = _time_steps[0];
    _end = _time_steps[_time_steps.size() - 1];
 
    return 1;
}

References _data_unit_string, _data_vecs, _end, _start, _time_steps, _vec_names, convertString2SensorDataType(), INFO(), BaseLib::splitString(), and BaseLib::strDate2int().

Referenced by SensorData().

setTimeUnit()

void SensorData::setTimeUnit ( TimeStepType t )

inline

Allows to set a unit for the time steps.

Definition at line 100 of file SensorData.h.

{ _time_unit = t; }

References _time_unit.

Member Data Documentation

_data_unit_string

std::vector<std::string> SensorData::_data_unit_string

private

Definition at line 119 of file SensorData.h.

Referenced by addTimeSeries(), and readDataFromFile().

_data_vecs

std::vector<std::vector<float>*> SensorData::_data_vecs

private

Definition at line 122 of file SensorData.h.

Referenced by ~SensorData(), addTimeSeries(), getTimeSeries(), and readDataFromFile().

_end

std::size_t SensorData::_end

private

Definition at line 116 of file SensorData.h.

Referenced by SensorData(), SensorData(), addTimeSeries(), getEndTime(), and readDataFromFile().

_start

std::size_t SensorData::_start

private

Definition at line 115 of file SensorData.h.

Referenced by SensorData(), SensorData(), addTimeSeries(), getStartTime(), and readDataFromFile().

_step_size

std::size_t SensorData::_step_size

private

Definition at line 117 of file SensorData.h.

Referenced by SensorData(), SensorData(), addTimeSeries(), and getStepSize().

_time_steps

std::vector<std::size_t> SensorData::_time_steps

private

Definition at line 120 of file SensorData.h.

Referenced by SensorData(), addTimeSeries(), getTimeSteps(), and readDataFromFile().

_time_unit

TimeStepType SensorData::_time_unit

private

Definition at line 118 of file SensorData.h.

Referenced by SensorData(), SensorData(), getTimeUnit(), and setTimeUnit().

_vec_names

std::vector<SensorDataType> SensorData::_vec_names

private

Definition at line 121 of file SensorData.h.

Referenced by addTimeSeries(), getTimeSeries(), getTimeSeriesNames(), and readDataFromFile().

---

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

• SensorData.h
• SensorData.cpp