datatypes::timeseries::TimeSeriesIOHelper¶

Representation of an univariate, ensemble time series with a SWIFT netCDF back end. More...

#include <time_series_io.hpp>

Public Types¶

	Name
using typename CommonTypes< T >::SeriesType	SeriesType
using typename CommonTypes< T >::PtrSeriesType	PtrSeriesType
using typename CommonTypes< T >::EnsemblePtrType	EnsemblePtrType
using typename CommonTypes< T >::PtrEnsemblePtrType	PtrEnsemblePtrType
using typename CommonTypes< T >::TSeriesEnsemblePtrType	TSeriesEnsemblePtrType
using typename CommonTypes< T >::PtrTSeriesEnsemblePtrType	PtrTSeriesEnsemblePtrType

Public Functions¶

	Name
SeriesType *	Read(const string & netCdfFilePath, const string & varName, const string & identifier)
void	Write(const string & varName, std::map< string, TTimeSeries< T > * > & recordedTimeSeries, const std::map< string, string > & idMap, const string & filePath)
void	Write(DimensionsDefinitions & dimDefinitions, const map< std::string, VariableDefinition > & varDefinitions, const GlobalAttributes & GlobalAttributes, std::map< string, TTimeSeries< T > * > & recordedTimeSeries, const string & filePath)
PtrEnsemblePtrType	ReadForecastTimeSeries(const string & netCdfFilepath, const string & varName, const string & identifier, int index)
PtrTSeriesEnsemblePtrType	ReadForecastTimeSeries(const string & netCdfFilepath, const string & varName, const string & identifier)
SeriesType *	Read(const string & netCdfFilePath, const string & varName, const string & identifier, const TimeWindow< SeriesType > & window)
SeriesType *	ReadDailyToHourly(const string & netCdfFilePath, const string & varName, const string & identifier, const TimeWindow< SeriesType > & window)

Detailed Description¶

template <typename T >
class datatypes::timeseries::TimeSeriesIOHelper;

Representation of an univariate, ensemble time series with a SWIFT netCDF back end.

Template Parameters:

T The type of the elements in the series; typically double or float.

Public Types Documentation¶

using SeriesType¶

using datatypes::timeseries::TimeSeriesIOHelper< T >::SeriesType =  typename CommonTypes<T>::SeriesType;

using PtrSeriesType¶

using datatypes::timeseries::TimeSeriesIOHelper< T >::PtrSeriesType =  typename CommonTypes<T>::PtrSeriesType;

using EnsemblePtrType¶

using datatypes::timeseries::TimeSeriesIOHelper< T >::EnsemblePtrType =  typename CommonTypes<T>::EnsemblePtrType;

using PtrEnsemblePtrType¶

using datatypes::timeseries::TimeSeriesIOHelper< T >::PtrEnsemblePtrType =  typename CommonTypes<T>::PtrEnsemblePtrType;

using TSeriesEnsemblePtrType¶

using datatypes::timeseries::TimeSeriesIOHelper< T >::TSeriesEnsemblePtrType =  typename CommonTypes<T>::TSeriesEnsemblePtrType;

using PtrTSeriesEnsemblePtrType¶

using datatypes::timeseries::TimeSeriesIOHelper< T >::PtrTSeriesEnsemblePtrType =  typename CommonTypes<T>::PtrTSeriesEnsemblePtrType;

Public Functions Documentation¶

function Read¶

static SeriesType * Read(
    const string & netCdfFilePath,
    const string & varName,
    const string & identifier
)

function Write¶

static void Write(
    const string & varName,
    std::map< string, TTimeSeries< T > * > & recordedTimeSeries,
    const std::map< string, string > & idMap,
    const string & filePath
)

function Write¶

static void Write(
    DimensionsDefinitions & dimDefinitions,
    const map< std::string, VariableDefinition > & varDefinitions,
    const GlobalAttributes & GlobalAttributes,
    std::map< string, TTimeSeries< T > * > & recordedTimeSeries,
    const string & filePath
)

function ReadForecastTimeSeries¶

static PtrEnsemblePtrType ReadForecastTimeSeries(
    const string & netCdfFilepath,
    const string & varName,
    const string & identifier,
    int index
)

function ReadForecastTimeSeries¶

static PtrTSeriesEnsemblePtrType ReadForecastTimeSeries(
    const string & netCdfFilepath,
    const string & varName,
    const string & identifier
)

function Read¶

static inline SeriesType * Read(
    const string & netCdfFilePath,
    const string & varName,
    const string & identifier,
    const TimeWindow< SeriesType > & window
)

function ReadDailyToHourly¶

static inline SeriesType * ReadDailyToHourly(
    const string & netCdfFilePath,
    const string & varName,
    const string & identifier,
    const TimeWindow< SeriesType > & window
)

Updated on 2022-08-21 at 18:10:33 +1000