Fesapi 2.10.1.0
This project provides C++ classes which allow an easy access in import and export to the Energistics standards.
Loading...
Searching...
No Matches
eml2_3::TimeSeries Class Referencefinal

#include <TimeSeries.h>

Inheritance diagram for eml2_3::TimeSeries:
eml2::TimeSeries common::AbstractObject

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_eml2_3::_eml23__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
 
- Public Member Functions inherited from eml2::TimeSeries
void pushBackTimestamp (time_t timestamp)
 
time_t getTimestamp (uint64_t index) const
 
std::vector< resqml2::AbstractProperty * > getPropertySet () const
 
virtual std::string getXmlTag () const override
 
- Public Member Functions inherited from common::AbstractObject
bool isPartial () const
 
virtual bool isTopLevelElement () const
 
std::string getUuid () const
 
std::string getTitle () const
 
std::string getEditor () const
 
time_t getCreation () const
 
tm getCreationAsTimeStructure () const
 
std::string getOriginator () const
 
std::string getDescription () const
 
time_t getLastUpdate () const
 
tm getLastUpdateAsTimeStructure () const
 
std::string getFormat () const
 
std::string getDescriptiveKeywords () const
 
std::string getVersion () const
 
void setTitle (const std::string &title)
 
void setEditor (const std::string &editor)
 
void setCreation (time_t creation)
 
void setCreation (const tm &creation)
 
void setOriginator (const std::string &originator)
 
void setDescription (const std::string &description)
 
void setLastUpdate (time_t lastUpdate)
 
void setLastUpdate (const tm &lastUpdate)
 
void setDescriptiveKeywords (const std::string &descriptiveKeywords)
 
void setVersion (const std::string &version)
 
void setMetadata (const std::string &title, const std::string &editor, time_t creation, const std::string &originator, const std::string &description, time_t lastUpdate, const std::string &descriptiveKeywords)
 
void serializeIntoStream (std::ostream *stream)
 
gsoap_resqml2_0_1::eml20__AbstractCitedDataObject * getEml20GsoapProxy () const
 
void setGsoapProxy (gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *gsoapProxy)
 
gsoap_eml2_3::eml23__AbstractObject * getEml23GsoapProxy () const
 
void setGsoapProxy (gsoap_eml2_3::eml23__AbstractObject *gsoapProxy)
 
soap * getGsoapContext () const
 
int getGsoapType () const
 
gsoap_resqml2_0_1::eml20__DataObjectReference * newResqmlReference () const
 
gsoap_eml2_3::eml23__DataObjectReference * newEml23Reference () const
 
gsoap_resqml2_0_1::resqml20__ContactElementReference * newContactElementReference2_0_1 () const
 
gsoap_eml2_3::resqml22__ContactElement * newContactElementReference2_2 () const
 
common::DataObjectRepositorygetRepository () const
 
virtual std::string getXmlNamespaceVersion () const
 
virtual std::string getContentType () const
 
virtual std::string getQualifiedType () const
 
virtual std::string getPartNameInEpcDocument () const
 
std::string serializeIntoString ()
 
void addAlias (const std::string &authority, const std::string &title)
 
uint64_t getAliasCount () const
 
std::string getAliasAuthorityAtIndex (uint64_t index) const
 
std::string getAliasTitleAtIndex (uint64_t index) const
 
std::vector< eml2::Activity * > getActivitySet () const
 
uint64_t getActivityCount () const
 
eml2::ActivitygetActivity (uint64_t index) const
 
void pushBackExtraMetadata (const std::string &key, const std::string &value)
 
std::unordered_map< std::string, std::string > getExtraMetadataSet () const
 
std::vector< std::string > getExtraMetadata (const std::string &key) const
 
unsigned int getExtraMetadataCount () const
 
std::string getExtraMetadataKeyAtIndex (unsigned int index) const
 
std::string getExtraMetadataStringValueAtIndex (unsigned int index) const
 
std::string buildEtp12Uri () const
 
void setUriSource (const std::string &uriSource)
 
const std::string & getUriSource () const
 
std::string getEpcSourceFolder () const
 
void changeToPartialObject ()
 

Static Public Attributes

static constexpr char const * XML_NS = "eml23"
 
- Static Public Attributes inherited from eml2::TimeSeries
static constexpr char const * XML_TAG = "TimeSeries"
 

Additional Inherited Members

- Public Types inherited from common::AbstractObject
enum class  numericalDatatypeEnum {
  UNKNOWN = 0 , DOUBLE = 1 , FLOAT = 2 , INT64 = 3 ,
  UINT64 = 4 , INT32 = 5 , UINT32 = 6 , INT16 = 7 ,
  UINT16 = 8 , INT8 = 9 , UINT8 = 10
}
 
- Static Public Member Functions inherited from common::AbstractObject
static void setFormat (const std::string &vendor, const std::string &applicationName, const std::string &applicationVersionNumber)
 

Detailed Description

A time series.

Constructor & Destructor Documentation

◆ 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]partialObjectIf 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]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]

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]fromGsoapIf non-null, from gsoap.

◆ ~TimeSeries()

eml2_3::TimeSeries::~TimeSeries ( )
virtualdefault

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

Reimplemented from eml2::TimeSeries.

Member Function Documentation

◆ getTimestampAsTimeStructure()

tm eml2_3::TimeSeries::getTimestampAsTimeStructure ( uint64_t index) const
finalvirtual

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.

Implements eml2::TimeSeries.

◆ getTimestampCount()

uint64_t eml2_3::TimeSeries::getTimestampCount ( ) const
finalvirtual

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.

Implements eml2::TimeSeries.

◆ getTimestampIndex() [1/2]

uint64_t eml2_3::TimeSeries::getTimestampIndex ( const tm & timestamp,
LONG64 yearOffset = 0 ) const
finalvirtual

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.

Implements eml2::TimeSeries.

◆ getTimestampIndex() [2/2]

uint64_t eml2_3::TimeSeries::getTimestampIndex ( time_t timestamp,
LONG64 yearOffset = 0 ) const
finalvirtual

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.

Implements eml2::TimeSeries.

◆ getXmlNamespace()

std::string eml2_3::TimeSeries::getXmlNamespace ( ) const
inlinefinalvirtual

Get the standard XML namespace for serializing this data object.

Implements common::AbstractObject.

◆ pushBackTimestamp()

void eml2_3::TimeSeries::pushBackTimestamp ( const tm & timestamp)
finalvirtual

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.

Implements eml2::TimeSeries.

Member Data Documentation

◆ XML_NS

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: