datatypes::timeseries

Namespaces

Name
datatypes::timeseries::io

Classes

	Name
struct	datatypes::timeseries::DefaultMissingValuePolicyTypeFactory
class	datatypes::timeseries::TTimeSeries A template for univariate, single realisasion time series.
class	datatypes::timeseries::MultiTimeSeries Template for time series with multiple values at time point; e.g. to hold multiple realizations of time series in an ensemble.
struct	datatypes::timeseries::time_series_of
struct	datatypes::timeseries::ensemble_of
struct	datatypes::timeseries::item_type_of
struct	datatypes::timeseries::CommonTypes Typical ensemble and time series data types derived from a fundamental data type for each data item.
class	datatypes::timeseries::TimeSeriesOperations
class	datatypes::timeseries::TimeWindow An object that represents a time window, defining subset/trim operations on time series.
class	datatypes::timeseries::GlobalAttributes A class to hold the global attributes of a file stored in the SWIFT netCDF format.
class	datatypes::timeseries::VariableAttributes A class to hold the attributes of a netCDF variable stored in the SWIFT netCDF format.
class	datatypes::timeseries::VariableDefinition
class	datatypes::timeseries::DimensionsDefinitions
class	datatypes::timeseries::DataGeometryProvider
class	datatypes::timeseries::TimeSeriesIOHelper Representation of an univariate, ensemble time series with a SWIFT netCDF back end.
class	datatypes::timeseries::SingleNetCdfFileStore
class	datatypes::timeseries::NetCdfSingleSeriesStore
class	datatypes::timeseries::NetCdfEnsembleTimeSeriesStore
class	datatypes::timeseries::EagerWriter
class	datatypes::timeseries::NetCdfTimeSeriesEnsembleTimeSeriesStore
class	datatypes::timeseries::MultiFileTimeSeriesEnsembleTimeSeriesStore An implementation of TimeSeriesEnsembleTimeSeriesStore such that the content of a time series is spread amongst several files.
class	datatypes::timeseries::MultiFileTsStorage An implementation of StoragePolicy such that the content of a time series is spread amongst several files.
class	datatypes::timeseries::TimeSeriesLibraryFactory
class	datatypes::timeseries::SwiftNetcdfStoreFactory
class	datatypes::timeseries::IdentifiersProvider An interface definition for objects that can provide hierarchical identification.
class	datatypes::timeseries::TimeSeriesProvider Library of time series, for high level access to sources of univariate, single instance time series that may have varying on-disk representations.
class	datatypes::timeseries::DataDimensionDescriptor Basic descriptor for a named dimension of a data structure (time series).
class	datatypes::timeseries::DataDescriptor Minimalist descriptor for a multidimensional time series.
class	datatypes::timeseries::SingleTimeSeriesStore Interface definition for storages of single, univariate time series.
class	datatypes::timeseries::EnsembleTimeSeriesStore Interface definition for storages of ensembles of univariate time series.
class	datatypes::timeseries::TimeSeriesEnsembleTimeSeriesStore Interface definition for storages of time series of ensembles of time series.
class	datatypes::timeseries::WritableTimeSeriesEnsembleTimeSeriesStore Interface definition for writeable storages of time series of ensembles of time series.
class	datatypes::timeseries::TimeSeriesEnsembleTimeSeriesStoragePolicy
class	datatypes::timeseries::TTimeSeriesLibrary
class	datatypes::timeseries::TimeSeriesSourceInfoImpl
class	datatypes::timeseries::TimeSeriesSourceInfo
class	datatypes::timeseries::NetCdfSourceInfo
class	datatypes::timeseries::TimeSeriesLibraryDescription
class	datatypes::timeseries::TimeSeriesSourceInfoBuilder An abstract class to allow callers to inject custom time series data sources into a time series library.
class	datatypes::timeseries::TimeSeriesStoreFactory
class	datatypes::timeseries::TimeSeriesLibrary Library of time series, for high level access to sources of time series that nmay have varying on-disk representations.
class	datatypes::timeseries::StoragePolicy An interface for classes that can handle the storage of data for time series.
class	datatypes::timeseries::MissingValuePolicy An interface for classes that define missing values in time series.
class	datatypes::timeseries::DefaultMissingFloatingPointPolicy
class	datatypes::timeseries::NullPointerIsMissingPolicy
class	datatypes::timeseries::NegativeIsMissingFloatingPointPolicy
class	datatypes::timeseries::StlVectorStorage Storage policy; data items are stored in standard template library std::vector.
class	datatypes::timeseries::SharedVectorStorage A storage strategy for time serie such that data is a shared state amongst several time series.
class	datatypes::timeseries::MemoryCachingStorageWriter
class	datatypes::timeseries::EnsembleStoragePolicy An interface for classes that can handle the storage of data for ensemble time series.
class	datatypes::timeseries::StdVectorEnsembleStoragePolicy std::vector based storage policy
class	datatypes::timeseries::TimeStep Time step handling for time series.
class	datatypes::timeseries::TimeSeriesInfoProvider An interface definition for classes that can provide essential time series temporal characteristics.
class	datatypes::timeseries::TimeStepImplementation
class	datatypes::timeseries::RegularTimeStepImplementation
class	datatypes::timeseries::IrregularTimeStepImplementation
class	datatypes::timeseries::MonthlyQppTimeStepImplementation

Types

	Name
typedef TTimeSeries< double >	TimeSeries
template <typename ItemType > using TTimeSeries< ItemType * >	PointerTypeTimeSeries
template <typename Tts =TimeSeries> using MultiTimeSeries< Tts * >	MultiTimeSeriesPtr
template <typename Tts =TimeSeries> using PointerTypeTimeSeries< Tts >	ForecastTimeSeries
template <typename Tts =TimeSeries> using MultiTimeSeriesPtr< Tts >	TimeSeriesEnsemble
template <typename Tts =TimeSeries> using PointerTypeTimeSeries< MultiTimeSeriesPtr< Tts > >	EnsembleForecastTimeSeries

Functions

	Name
template <typename T > MissingValuePolicy< T > *	DefaultMissingValuePolicy() Default missing value policy.
template <typename T > StoragePolicy< T > *	DefaultStoragePolicy() Default strategy for storing time series data.
template <typename T > TTimeSeries< T >	operator<<(const TTimeSeries< T > & a, const TTimeSeries< T > & b)
template <typename From ,typename To > To	GetMetadataFrom(const From & ens)
template <typename ElementType > DimensionsDefinitions	DimensionsFromSeries(const TTimeSeries< ElementType > & ts, const size_t ensembleSize =1, const size_t leadTimeSize =1, const vector< string > & stationIds =DEFAULT_STATION_IDENTIFIER)
template <typename ElementType > DimensionsDefinitions	DimensionsFromSeries(EnsembleForecastTimeSeries<> & tsEns, const vector< string > & stationIds =DEFAULT_STATION_IDENTIFIER)
template <typename ElementType > DimensionsDefinitions	DimensionsFromSeries(const vector< EnsembleForecastTimeSeries<>::ElementType > & values, const TimeStep & tsEnsTstep =TimeStep::GetUnknown(), const ptime & tsEnsStart =not_a_date_time, const vector< string > & stationIds =DEFAULT_STATION_IDENTIFIER, int fcastOffset =1)
template <typename TElement > DimensionsDefinitions	DimensionsFromPointTimeSeries(const TTimeSeries< TElement > & ts)

Types Documentation

typedef TimeSeries

typedef TTimeSeries< double > datatypes::timeseries::TimeSeries;

using PointerTypeTimeSeries

template <typename ItemType >
using datatypes::timeseries::PointerTypeTimeSeries = typedef TTimeSeries < ItemType* >;

using MultiTimeSeriesPtr

template <typename Tts  =TimeSeries>
using datatypes::timeseries::MultiTimeSeriesPtr = typedef MultiTimeSeries < Tts* >;

using ForecastTimeSeries

template <typename Tts  =TimeSeries>
using datatypes::timeseries::ForecastTimeSeries = typedef PointerTypeTimeSeries < Tts >;

using TimeSeriesEnsemble

template <typename Tts  =TimeSeries>
using datatypes::timeseries::TimeSeriesEnsemble = typedef MultiTimeSeriesPtr < Tts >;

using EnsembleForecastTimeSeries

template <typename Tts  =TimeSeries>
using datatypes::timeseries::EnsembleForecastTimeSeries = typedef PointerTypeTimeSeries < MultiTimeSeriesPtr<Tts> >;

Functions Documentation

function DefaultMissingValuePolicy

template <typename T >
MissingValuePolicy< T > * DefaultMissingValuePolicy()

Default missing value policy.

Template Parameters:

• T Generic type parameter, the type of the elements of the time series

Return: A new object inheriting from MissingValuePolicy*>

    A function that returnes a suitable default object to handle 
    time series behaviors with respect to missing values

function DefaultStoragePolicy

template <typename T >
StoragePolicy< T > * DefaultStoragePolicy()

Default strategy for storing time series data.

Template Parameters:

• T Generic type parameter, the type of the elements of the time series

Return: A new object inheriting from StoragePolicy*>

    A function that returnes a suitable default object to handle
    the storage of time series data. The default is in memory vector.

function operator<<

template <typename T >
TTimeSeries< T > operator<<(
    const TTimeSeries< T > & a,
    const TTimeSeries< T > & b
)

function GetMetadataFrom

template <typename From ,
typename To >
To GetMetadataFrom(
    const From & ens
)

function DimensionsFromSeries

template <typename ElementType >
DimensionsDefinitions DimensionsFromSeries(
    const TTimeSeries< ElementType > & ts,
    const size_t ensembleSize =1,
    const size_t leadTimeSize =1,
    const vector< string > & stationIds =DEFAULT_STATION_IDENTIFIER
)

function DimensionsFromSeries

template <typename ElementType >
DimensionsDefinitions DimensionsFromSeries(
    EnsembleForecastTimeSeries<> & tsEns,
    const vector< string > & stationIds =DEFAULT_STATION_IDENTIFIER
)

function DimensionsFromSeries

template <typename ElementType >
DimensionsDefinitions DimensionsFromSeries(
    const vector< EnsembleForecastTimeSeries<>::ElementType > & values,
    const TimeStep & tsEnsTstep =TimeStep::GetUnknown(),
    const ptime & tsEnsStart =not_a_date_time,
    const vector< string > & stationIds =DEFAULT_STATION_IDENTIFIER,
    int fcastOffset =1
)

function DimensionsFromPointTimeSeries

template <typename TElement >
DimensionsDefinitions DimensionsFromPointTimeSeries(
    const TTimeSeries< TElement > & ts
)

---

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