#include <TimeSeries.h>
|
| static constexpr char const * | XML_NS = "eml23" |
| |
◆ TimeSeries() [1/3]
| eml2_3::TimeSeries::TimeSeries |
( |
gsoap_resqml2_0_1::eml20__DataObjectReference * | partialObject | ) |
|
|
inline |
Only to be used in partial transfer context
- Parameters
-
| [in,out] | partialObject | If non-null, the partial object. |
◆ TimeSeries() [2/3]
| eml2_3::TimeSeries::TimeSeries |
( |
common ::DataObjectRepository * | repo, |
|
|
const std::string & | guid, |
|
|
const std::string & | title ) |
Creates a time series
- Parameters
-
| [in,out] | repo | the repo where this intance will be stored. |
| guid | The guid to set to the local 3d crs. If empty then a new guid will be generated. |
| title | The title of the instance. |
◆ TimeSeries() [3/3]
| eml2_3::TimeSeries::TimeSeries |
( |
gsoap_eml2_3::_eml23__TimeSeries * | fromGsoap | ) |
|
|
inline |
Creates an instance of this class by wrapping a gsoap instance.
- Parameters
-
| [in,out] | fromGsoap | If non-null, from gsoap. |
◆ ~TimeSeries()
| eml2_3::TimeSeries::~TimeSeries |
( |
| ) |
|
|
default |
Destructor does nothing since the memory is managed by the gsoap context.
◆ getTimestampAsTimeStructure()
| tm eml2_3::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_error | If the underlying gSOAP instance is not a RESQML2.0 one. |
| std::out_of_range | If index is out of range. |
- Parameters
-
| index | Zero-based index of the timestamp we look for. |
- Returns
- The timestamp at position
index.
◆ getTimestampCount()
| uint64_t eml2_3::TimeSeries::getTimestampCount |
( |
| ) |
const |
|
final |
Get the count of timestamps in this time series.
- Exceptions
-
| std::logic_error | If the underlying gSOAP instance is not a RESQML2.0 one. |
- Returns
- The timestamp count.
◆ getTimestampIndex() [1/2]
| uint64_t eml2_3::TimeSeries::getTimestampIndex |
( |
const tm & | timestamp, |
|
|
LONG64 | yearOffset = 0 ) const |
|
final |
Gets the index of a given timestamp in this time series.
- Exceptions
-
| std::logic_error | If the underlying gSOAP instance is not a RESQML2.0 one. |
| std::out_of_range | If timestamp has not been found in this time series. |
- Parameters
-
| timestamp | The timestamp we look for. |
| yearOffset | Indicates 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 eml2_3::TimeSeries::getTimestampIndex |
( |
time_t | timestamp, |
|
|
LONG64 | yearOffset = 0 ) const |
|
final |
Gets the index of a given timestamp in this time series.
- Exceptions
-
| std::logic_error | If the underlying gSOAP instance is not a RESQML2.0 one. |
| std::out_of_range | If timestamp has not been found in this time series. |
- Parameters
-
| timestamp | The timestamp we look for. |
| yearOffset | Indicates that the dateTime attribute must be translated according to this value. |
- Returns
- The index of
timestamp in this time series.
◆ getXmlNamespace()
| std::string eml2_3::TimeSeries::getXmlNamespace |
( |
| ) |
const |
|
inlinefinal |
Get the standard XML namespace for serializing this data object.
◆ pushBackTimestamp()
| void eml2_3::TimeSeries::pushBackTimestamp |
( |
const tm & | timestamp | ) |
|
|
final |
Pushes back an timestamp into this time series.
- Exceptions
-
| std::logic_error | If the underlying gSOAP instance is not a RESQML2.0 one. |
- Parameters
-
| timestamp | The timestamp to push back. |
◆ XML_NS
| constexpr char const* eml2_3::TimeSeries::XML_NS = "eml23" |
|
staticconstexpr |
The standard XML namespace for serializing this data object.
The documentation for this class was generated from the following file:
- C:/Users/philippe/dev/fesapiEnv/fesapi-2.9.0.1/src/eml2_3/TimeSeries.h
