Documentation for OpenFLUID 2.2.0
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
openfluid::tools::ChronologicalSerie< DataType > Class Template Reference

Detailed Description

template<typename DataType = double>
class openfluid::tools::ChronologicalSerie< DataType >

Container for a chronological data serie

#include <tools/ChronologicalSerie.hpp>

Public Member Functions

 ChronologicalSerie ()
 
void reset ()
 
bool getSurroundingValues (const openfluid::core::DateTime &DT, ChronItem_t< DataType > &Before, ChronItem_t< DataType > &After)
 
Inheritance diagram for openfluid::tools::ChronologicalSerie< DataType >:
Collaboration diagram for openfluid::tools::ChronologicalSerie< DataType >:

Constructor & Destructor Documentation

◆ ChronologicalSerie()

template<typename DataType = double>
openfluid::tools::ChronologicalSerie< DataType >::ChronologicalSerie ( )
inline

Default constructor

Member Function Documentation

◆ getSurroundingValues()

template<typename DataType = double>
bool openfluid::tools::ChronologicalSerie< DataType >::getSurroundingValues ( const openfluid::core::DateTime DT,
ChronItem_t< DataType > &  Before,
ChronItem_t< DataType > &  After 
)
inline

Finds the two surrending values for a given date. If the given date is exactly found in the serie, the two surrounding values are the same.

Parameters
[in]DTThe date to find surrounding values
[out]BeforeThe closest date before the given date
[out]AfterThe closest date after the given date
Returns
true if the closest dates before and after have been found

◆ reset()

template<typename DataType = double>
void openfluid::tools::ChronologicalSerie< DataType >::reset ( )
inline

Resets the internal iterator


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