Public Member Functions | List of all members
openfluid::tools::ChronologicalSerie Class Reference

#include <tools/ChronologicalSerie.hpp>

Inheritance diagram for openfluid::tools::ChronologicalSerie:
Inheritance graph
[legend]
Collaboration diagram for openfluid::tools::ChronologicalSerie:
Collaboration graph
[legend]

Public Member Functions

 ChronologicalSerie ()
 
void reset ()
 
bool getSurroundingValues (const openfluid::core::DateTime &DT, ChronItem_t &Before, ChronItem_t &After)
 

Detailed Description

Container for a chronological data serie

Constructor & Destructor Documentation

openfluid::tools::ChronologicalSerie::ChronologicalSerie ( )
inline

Default constructor

Member Function Documentation

bool openfluid::tools::ChronologicalSerie::getSurroundingValues ( const openfluid::core::DateTime DT,
ChronItem_t Before,
ChronItem_t After 
)

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
void openfluid::tools::ChronologicalSerie::reset ( )

Resets the internal iterator


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