Skip to content

uchronia API documentation

datatypes/interop_conversions.h

csiro-hydroinformatics/uchronia-time-series

datatypes/interop_conversions.h¶

Namespaces¶

Name
cinterop::utils

Functions¶

	Name
TimeSeries	CreateTimeSeries(double * values, const regular_time_series_geometry & g) Helper function for C API interop conversions.
TimeSeries	CreateTimeSeries(double * values, TS_GEOMETRY_PTR geom) Helper function for C API interop conversions.
TimeSeries	CreateTimeSeries(const multi_regular_time_series_data & g) Helper function for C API interop conversions.
TimeSeriesEnsemble< TimeSeries >	ToTimeSeriesEnsemble(const multi_regular_time_series_data & rawData) Helper function for C API interop conversions.
TimeSeriesEnsemble< TimeSeries > *	ToTimeSeriesEnsemblePtr(const multi_regular_time_series_data & rawData) Helper function for C API interop conversions.
multi_regular_time_series_data *	ToMultiTimeSeriesDataPtr(const TimeSeriesEnsemble< TimeSeries > & mts) Helper function for C API interop conversions.
multi_regular_time_series_data *	ToMultiTimeSeriesDataPtr(const TimeSeries & ts) Helper function for C API interop conversions.
TimeSeries *	SingleTsPtrFromMultiTimeSeriesData(const multi_regular_time_series_data & ts) Helper function for C API interop conversions.
TimeSeriesEnsemble< TimeSeries > *	MultiTsPtrFromMultiTimeSeriesData(const multi_regular_time_series_data & ts) Helper function for C API interop conversions.
TimeSeries	SingleTsFromMultiTimeSeriesData(const multi_regular_time_series_data & ts) Helper function for C API interop conversions.
TimeSeriesEnsemble< TimeSeries >	MultiTsFromMultiTimeSeriesData(const multi_regular_time_series_data & ts) Helper function for C API interop conversions.
time_series_dimensions_description *	ToTimeSeriesDimensionDescriptions(vector< DataDimensionDescriptor > & mts) Helper function for C API interop conversions.
void	CopyToMultiTimeSeriesData(const TimeSeriesEnsemble< TimeSeries > & mts, multi_regular_time_series_data & result) Helper function for C API interop conversions.
void	CopyToMultiTimeSeriesData(const TimeSeries & ts, multi_regular_time_series_data & result) Helper function for C API interop conversions.
void	CopyFromMultiTimeSeriesData(const multi_regular_time_series_data & interopdata, TimeSeries & ts) Helper function for C API interop conversions.
void	CopyFromMultiTimeSeriesData(const multi_regular_time_series_data & interopdata, TimeSeriesEnsemble< TimeSeries > & mts) Helper function for C API interop conversions.
double **	ToRawData(const TimeSeriesEnsemble< TimeSeries > & mts) Helper function for C API interop conversions.
double *	ToRawData(const TimeSeries & ts) Helper function for C API interop conversions.
void	DisposeMultiTimeSeriesData(multi_regular_time_series_data * d) Helper function for C API interop conversions.
void	DisposeTimeSeriesDimensionDescriptions(time_series_dimensions_description * d) Helper function for C API interop conversions.

Functions Documentation¶

function CreateTimeSeries¶

TimeSeries CreateTimeSeries(
    double * values,
    const regular_time_series_geometry & g
)

Helper function for C API interop conversions.

function CreateTimeSeries¶

TimeSeries CreateTimeSeries(
    double * values,
    TS_GEOMETRY_PTR geom
)

Helper function for C API interop conversions.

function CreateTimeSeries¶

TimeSeries CreateTimeSeries(
    const multi_regular_time_series_data & g
)

Helper function for C API interop conversions.

function ToTimeSeriesEnsemble¶

TimeSeriesEnsemble< TimeSeries > ToTimeSeriesEnsemble(
    const multi_regular_time_series_data & rawData
)

Helper function for C API interop conversions.

function ToTimeSeriesEnsemblePtr¶

TimeSeriesEnsemble< TimeSeries > * ToTimeSeriesEnsemblePtr(
    const multi_regular_time_series_data & rawData
)

Helper function for C API interop conversions.

function ToMultiTimeSeriesDataPtr¶

multi_regular_time_series_data * ToMultiTimeSeriesDataPtr(
    const TimeSeriesEnsemble< TimeSeries > & mts
)

Helper function for C API interop conversions.

function ToMultiTimeSeriesDataPtr¶

multi_regular_time_series_data * ToMultiTimeSeriesDataPtr(
    const TimeSeries & ts
)

Helper function for C API interop conversions.

function SingleTsPtrFromMultiTimeSeriesData¶

TimeSeries * SingleTsPtrFromMultiTimeSeriesData(
    const multi_regular_time_series_data & ts
)

Helper function for C API interop conversions.

function MultiTsPtrFromMultiTimeSeriesData¶

TimeSeriesEnsemble< TimeSeries > * MultiTsPtrFromMultiTimeSeriesData(
    const multi_regular_time_series_data & ts
)

Helper function for C API interop conversions.

function SingleTsFromMultiTimeSeriesData¶

TimeSeries SingleTsFromMultiTimeSeriesData(
    const multi_regular_time_series_data & ts
)

Helper function for C API interop conversions.

function MultiTsFromMultiTimeSeriesData¶

TimeSeriesEnsemble< TimeSeries > MultiTsFromMultiTimeSeriesData(
    const multi_regular_time_series_data & ts
)

Helper function for C API interop conversions.

function ToTimeSeriesDimensionDescriptions¶

time_series_dimensions_description * ToTimeSeriesDimensionDescriptions(
    vector< DataDimensionDescriptor > & mts
)

Helper function for C API interop conversions.

function CopyToMultiTimeSeriesData¶

void CopyToMultiTimeSeriesData(
    const TimeSeriesEnsemble< TimeSeries > & mts,
    multi_regular_time_series_data & result
)

Helper function for C API interop conversions.

function CopyToMultiTimeSeriesData¶

void CopyToMultiTimeSeriesData(
    const TimeSeries & ts,
    multi_regular_time_series_data & result
)

Helper function for C API interop conversions.

function CopyFromMultiTimeSeriesData¶

void CopyFromMultiTimeSeriesData(
    const multi_regular_time_series_data & interopdata,
    TimeSeries & ts
)

Helper function for C API interop conversions.

function CopyFromMultiTimeSeriesData¶

void CopyFromMultiTimeSeriesData(
    const multi_regular_time_series_data & interopdata,
    TimeSeriesEnsemble< TimeSeries > & mts
)

Helper function for C API interop conversions.

function ToRawData¶

double ** ToRawData(
    const TimeSeriesEnsemble< TimeSeries > & mts
)

Helper function for C API interop conversions.

function ToRawData¶

double * ToRawData(
    const TimeSeries & ts
)

Helper function for C API interop conversions.

function DisposeMultiTimeSeriesData¶

void DisposeMultiTimeSeriesData(
    multi_regular_time_series_data * d
)

Helper function for C API interop conversions.

function DisposeTimeSeriesDimensionDescriptions¶

void DisposeTimeSeriesDimensionDescriptions(
    time_series_dimensions_description * d
)

Helper function for C API interop conversions.

Source code¶

#pragma once

#include "cinterop/c_cpp_interop.hpp"
#include "datatypes/common.h"
#include "datatypes/time_series_io.hpp"
#include "datatypes/internals_c_api.hpp"

using namespace cinterop::utils;
using namespace datatypes::timeseries;

DATATYPES_DLL_LIB TimeSeries CreateTimeSeries(double * values, const regular_time_series_geometry& g);
DATATYPES_DLL_LIB TimeSeries CreateTimeSeries(double * values, TS_GEOMETRY_PTR geom);
DATATYPES_DLL_LIB TimeSeries CreateTimeSeries(const multi_regular_time_series_data& g);
DATATYPES_DLL_LIB TimeSeriesEnsemble<TimeSeries> ToTimeSeriesEnsemble(const multi_regular_time_series_data& rawData);
DATATYPES_DLL_LIB TimeSeriesEnsemble<TimeSeries>* ToTimeSeriesEnsemblePtr(const multi_regular_time_series_data& rawData);
DATATYPES_DLL_LIB multi_regular_time_series_data* ToMultiTimeSeriesDataPtr(const TimeSeriesEnsemble<TimeSeries>& mts);
DATATYPES_DLL_LIB multi_regular_time_series_data* ToMultiTimeSeriesDataPtr(const TimeSeries& ts);
DATATYPES_DLL_LIB TimeSeries* SingleTsPtrFromMultiTimeSeriesData(const multi_regular_time_series_data& ts);
DATATYPES_DLL_LIB TimeSeriesEnsemble<TimeSeries>* MultiTsPtrFromMultiTimeSeriesData(const multi_regular_time_series_data& ts);
DATATYPES_DLL_LIB TimeSeries SingleTsFromMultiTimeSeriesData(const multi_regular_time_series_data& ts);
DATATYPES_DLL_LIB TimeSeriesEnsemble<TimeSeries> MultiTsFromMultiTimeSeriesData(const multi_regular_time_series_data& ts);
DATATYPES_DLL_LIB time_series_dimensions_description* ToTimeSeriesDimensionDescriptions(vector<DataDimensionDescriptor>& mts);
DATATYPES_DLL_LIB void CopyToMultiTimeSeriesData(const TimeSeriesEnsemble<TimeSeries>& mts, multi_regular_time_series_data& result);
DATATYPES_DLL_LIB void CopyToMultiTimeSeriesData(const TimeSeries& ts, multi_regular_time_series_data& result);
DATATYPES_DLL_LIB void CopyFromMultiTimeSeriesData(const multi_regular_time_series_data& interopdata, TimeSeries& ts);
DATATYPES_DLL_LIB void CopyFromMultiTimeSeriesData(const multi_regular_time_series_data& interopdata, TimeSeriesEnsemble<TimeSeries>& mts);
DATATYPES_DLL_LIB double** ToRawData(const TimeSeriesEnsemble<TimeSeries>& mts);
DATATYPES_DLL_LIB double* ToRawData(const TimeSeries& ts);
DATATYPES_DLL_LIB void DisposeMultiTimeSeriesData(multi_regular_time_series_data* d);
DATATYPES_DLL_LIB void DisposeTimeSeriesDimensionDescriptions(time_series_dimensions_description* d);

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