Proxy class for time series. Stores an ordered list of times, for example, for time- dependent properties, geometries, or representations. It is used in conjunction with the time index to specify times for RESQML. More...

#include <TimeSeries.h>

Inheritance diagram for eml2::TimeSeries:

Public Member Functions
virtual	~TimeSeries ()=default

void	pushBackTimestamp (time_t timestamp)

virtual void	pushBackTimestamp (const tm &timestamp)=0

virtual uint64_t	getTimestampIndex (time_t timestamp, LONG64 yearOffset=0) const =0

virtual uint64_t	getTimestampIndex (const tm &timestamp, LONG64 yearOffset=0) const =0

virtual uint64_t	getTimestampCount () const =0

time_t	getTimestamp (uint64_t index) const

virtual tm	getTimestampAsTimeStructure (uint64_t index) const =0

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::DataObjectRepository *	getRepository () const

virtual std::string	getXmlNamespace () const =0

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::Activity *	getActivity (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_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

Proxy class for time series. Stores an ordered list of times, for example, for time- dependent properties, geometries, or representations. It is used in conjunction with the time index to specify times for RESQML.

Constructor & Destructor Documentation

◆ ~TimeSeries()

virtual eml2::TimeSeries::~TimeSeries ( )

virtualdefault

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

Reimplemented in eml2_3::TimeSeries, and resqml2_0_1::TimeSeries.

Member Function Documentation

◆ getPropertySet()

std::vector< resqml2::AbstractProperty * > eml2::TimeSeries::getPropertySet ( ) const

Get all the properties which use this time series

Returns: A vector of pointers to all the properties which use this time series.

◆ getTimestamp()

time_t eml2::TimeSeries::getTimestamp ( uint64_t index ) const

Gets a timestamp at a particular index of this time series.

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.

◆ getTimestampAsTimeStructure()

virtual tm eml2::TimeSeries::getTimestampAsTimeStructure ( uint64_t index ) const

pure virtual

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.

Implemented in eml2_3::TimeSeries, and resqml2_0_1::TimeSeries.

◆ getTimestampCount()

virtual uint64_t eml2::TimeSeries::getTimestampCount ( ) const

pure virtual

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.

Implemented in eml2_3::TimeSeries, and resqml2_0_1::TimeSeries.

◆ getTimestampIndex() [1/2]

virtual uint64_t eml2::TimeSeries::getTimestampIndex	(	const tm &	timestamp,
		LONG64	yearOffset = 0 ) const

pure virtual

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.

Implemented in eml2_3::TimeSeries, and resqml2_0_1::TimeSeries.

◆ getTimestampIndex() [2/2]

virtual uint64_t eml2::TimeSeries::getTimestampIndex	(	time_t	timestamp,
		LONG64	yearOffset = 0 ) const

pure virtual

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.

Implemented in eml2_3::TimeSeries, and resqml2_0_1::TimeSeries.

◆ getXmlTag()

virtual std::string eml2::TimeSeries::getXmlTag ( ) const

inlineoverridevirtual

Gets the standard XML tag without XML namespace for serializing this data object.

Returns: The XML tag.

Implements common::AbstractObject.

◆ pushBackTimestamp() [1/2]

virtual void eml2::TimeSeries::pushBackTimestamp ( const tm & timestamp )

pure virtual

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.

Implemented in eml2_3::TimeSeries, and resqml2_0_1::TimeSeries.

◆ pushBackTimestamp() [2/2]

void eml2::TimeSeries::pushBackTimestamp ( time_t timestamp )

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.

Member Data Documentation

◆ XML_TAG

char const* eml2::TimeSeries::XML_TAG = "TimeSeries"

staticconstexpr

The standard XML tag without 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.10.1.0/src/eml2/TimeSeries.h

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~TimeSeries()

Member Function Documentation

◆ getPropertySet()

◆ getTimestamp()

◆ getTimestampAsTimeStructure()

◆ getTimestampCount()

◆ getTimestampIndex() [1/2]

◆ getTimestampIndex() [2/2]

◆ getXmlTag()

◆ pushBackTimestamp() [1/2]

◆ pushBackTimestamp() [2/2]

Member Data Documentation

◆ XML_TAG