datatypes::timeseries::IdentifiersProvider¶

An interface definition for objects that can provide hierarchical identification. More...

#include <time_series_store.hpp>

Inherited by datatypes::timeseries::EnsembleTimeSeriesStore< double >, datatypes::timeseries::SingleTimeSeriesStore< double >, datatypes::timeseries::TimeSeriesProvider< double >, datatypes::timeseries::EnsembleTimeSeriesStore< T >, datatypes::timeseries::SingleTimeSeriesStore< T >, datatypes::timeseries::TimeSeriesEnsembleTimeSeriesStore< T >, datatypes::timeseries::TimeSeriesProvider< T >

Public Functions¶

	Name
virtual	~IdentifiersProvider()
virtual vector< string >	GetIdentifiers() const =0
vector< string >	SplitHierarchicalIdentifier(const string & longId)
string	GetTopmostIdentifier(const string & longId)
void	CheckNotEmpty(const string & longId)

Detailed Description¶

class datatypes::timeseries::IdentifiersProvider;

An interface definition for objects that can provide hierarchical identification.

    A parent class for objects that can provide hierarchical identification. 
    For instance a dot-separated identification scheme such as "category.subcatcgory.catchment.instant_flow"

Public Functions Documentation¶

function ~IdentifiersProvider¶

inline virtual ~IdentifiersProvider()

function GetIdentifiers¶

virtual vector< string > GetIdentifiers() const =0

Reimplemented by: datatypes::tests::TestSingleTimeSeriesStore::GetIdentifiers, datatypes::timeseries::NetCdfSingleSeriesStore::GetIdentifiers, datatypes::timeseries::NetCdfEnsembleTimeSeriesStore::GetIdentifiers, datatypes::timeseries::NetCdfTimeSeriesEnsembleTimeSeriesStore::GetIdentifiers, datatypes::timeseries::EnsembleTimeSeriesStore::GetIdentifiers, datatypes::timeseries::EnsembleTimeSeriesStore::GetIdentifiers, datatypes::timeseries::TimeSeriesEnsembleTimeSeriesStore::GetIdentifiers, datatypes::timeseries::TimeSeriesLibrary::GetIdentifiers

function SplitHierarchicalIdentifier¶

static vector< string > SplitHierarchicalIdentifier(
    const string & longId
)

function GetTopmostIdentifier¶

static string GetTopmostIdentifier(
    const string & longId
)

function CheckNotEmpty¶

static void CheckNotEmpty(
    const string & longId
)

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