Fesapi 2.9.0.1
This project provides C++ classes which allow an easy access in import and export to the Energistics standards.
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | List of all members
resqml2_0_1::TimeSeries Class Referencefinal

#include <TimeSeries.h>

Inheritance diagram for resqml2_0_1::TimeSeries:

Public Member Functions

 TimeSeries (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
 
 TimeSeries (common ::DataObjectRepository *repo, const std::string &guid, const std::string &title)
 
 TimeSeries (gsoap_resqml2_0_1::_resqml20__TimeSeries *fromGsoap)
 
 ~TimeSeries ()=default
 
void pushBackTimestamp (const tm &timestamp) final
 
uint64_t getTimestampIndex (time_t timestamp, LONG64 yearOffset=0) const final
 
uint64_t getTimestampIndex (const tm &timestamp, LONG64 yearOffset=0) const final
 
uint64_t getTimestampCount () const final
 
tm getTimestampAsTimeStructure (uint64_t index) const final
 
std::string getXmlNamespace () const final
 

Static Public Attributes

static const char * XML_NS
 

Detailed Description

A time series.

Constructor & Destructor Documentation

◆ TimeSeries() [1/3]

resqml2_0_1::TimeSeries::TimeSeries ( gsoap_resqml2_0_1::eml20__DataObjectReference * partialObject)
inline

Only to be used in partial transfer context

Parameters
[in,out]partialObjectIf non-null, the partial object.

◆ TimeSeries() [2/3]

resqml2_0_1::TimeSeries::TimeSeries ( common ::DataObjectRepository * repo,
const std::string & guid,
const std::string & title )

Creates a time series

Parameters
[in,out]repothe repo where this intance will be stored.
guidThe guid to set to the local 3d crs. If empty then a new guid will be generated.
titleThe title of the instance.

◆ TimeSeries() [3/3]

resqml2_0_1::TimeSeries::TimeSeries ( gsoap_resqml2_0_1::_resqml20__TimeSeries * fromGsoap)
inline

Creates an instance of this class by wrapping a gsoap instance.

Parameters
[in,out]fromGsoapIf non-null, from gsoap.

◆ ~TimeSeries()

resqml2_0_1::TimeSeries::~TimeSeries ( )
default

Destructor does nothing since the memory is managed by the gsoap context.

Member Function Documentation

◆ getTimestampAsTimeStructure()

tm resqml2_0_1::TimeSeries::getTimestampAsTimeStructure ( uint64_t index) const
final

Gets a timestamp as a time structure at a particular index of this time series. It allows to read dates from 1900-01-01T00:00:00.

Exceptions
std::logic_errorIf the underlying gSOAP instance is not a RESQML2.0 one.
std::out_of_rangeIf index is out of range.
Parameters
indexZero-based index of the timestamp we look for.
Returns
The timestamp at position index.

◆ getTimestampCount()

uint64_t resqml2_0_1::TimeSeries::getTimestampCount ( ) const
final

Get the count of timestamps in this time series.

Exceptions
std::logic_errorIf the underlying gSOAP instance is not a RESQML2.0 one.
Returns
The timestamp count.

◆ getTimestampIndex() [1/2]

uint64_t resqml2_0_1::TimeSeries::getTimestampIndex ( const tm & timestamp,
LONG64 yearOffset = 0 ) const
final

Gets the index of a given timestamp in this time series.

Exceptions
std::logic_errorIf the underlying gSOAP instance is not a RESQML2.0 one.
std::out_of_rangeIf timestamp has not been found in this time series.
Parameters
timestampThe timestamp we look for.
yearOffsetIndicates that the dateTime attribute must be translated according to this value.
Returns
The index of timestamp in this time series.

◆ getTimestampIndex() [2/2]

uint64_t resqml2_0_1::TimeSeries::getTimestampIndex ( time_t timestamp,
LONG64 yearOffset = 0 ) const
final

Gets the index of a given timestamp in this time series.

Exceptions
std::logic_errorIf the underlying gSOAP instance is not a RESQML2.0 one.
std::out_of_rangeIf timestamp has not been found in this time series.
Parameters
timestampThe timestamp we look for.
yearOffsetIndicates that the dateTime attribute must be translated according to this value.
Returns
The index of timestamp in this time series.

◆ getXmlNamespace()

std::string resqml2_0_1::TimeSeries::getXmlNamespace ( ) const
inlinefinal

Get the standard XML namespace for serializing this data object.

◆ pushBackTimestamp()

void resqml2_0_1::TimeSeries::pushBackTimestamp ( const tm & timestamp)
final

Pushes back an timestamp into this time series.

Exceptions
std::logic_errorIf the underlying gSOAP instance is not a RESQML2.0 one.
Parameters
timestampThe timestamp to push back.

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