Fesapi  0.13.0.0
This project provides C++ classes which allow an easy access in import and export to the Energistics standards.
Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Friends | List of all members
RESQML2_NS::TimeSeries Class Reference
Inheritance diagram for RESQML2_NS::TimeSeries:
COMMON_NS::AbstractObject RESQML2_0_1_NS::TimeSeries

Public Member Functions

 ~TimeSeries ()
 
virtual std::string getXmlTag () const
 
void pushBackTimestamp (const time_t &timestamp)
 
void pushBackTimestamp (const tm &timestamp)
 
unsigned int getTimestampIndex (const time_t &timestamp) const
 
unsigned int getTimestampIndex (const tm &timestamp) const
 
unsigned int getTimestampCount () const
 
time_t getTimestamp (const unsigned int &index) const
 
tm getTimestampAsTimeStructure (const unsigned int &index) const
 
const std::vector< RESQML2_NS::AbstractProperty * > & getPropertySet () const
 
- Public Member Functions inherited from COMMON_NS::AbstractObject
bool isPartial () 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 getVersionString () const
 
void setTitle (const std::string &title)
 
void setEditor (const std::string &editor)
 
void setCreation (const time_t &creation)
 
void setCreation (const tm &creation)
 
void setOriginator (const std::string &originator)
 
void setDescription (const std::string &description)
 
void setLastUpdate (const time_t &lastUpdate)
 
void setLastUpdate (const tm &lastUpdate)
 
void setFormat (const std::string &format)
 
void setDescriptiveKeywords (const std::string &descriptiveKeywords)
 
void setVersionString (const std::string &versionString)
 
void setMetadata (const std::string &title, const std::string &editor, const time_t &creation, const std::string &originator, const std::string &description, const time_t &lastUpdate, const std::string &format, const std::string &descriptiveKeywords)
 
void serializeIntoStream (std::ostream *stream)
 
gsoap_resqml2_0_1::eml20__AbstractCitedDataObject * getGsoapProxy () const
 
soap * getGsoapContext () const
 
int getGsoapType () const
 
gsoap_resqml2_0_1::eml20__DataObjectReference * newResqmlReference () const
 
gsoap_eml2_1::eml21__DataObjectReference * newEmlReference () const
 
gsoap_resqml2_0_1::resqml2__ContactElementReference * newResqmlContactElementReference () const
 
COMMON_NS::EpcDocument * getEpcDocument () const
 
virtual std::string getXmlNamespace () const
 
virtual std::string getResqmlVersion () const
 
virtual std::string getContentType () const
 
virtual std::string getPartNameInEpcDocument () const
 
std::string serializeIntoString ()
 
void addAlias (const std::string &authority, const std::string &title)
 
unsigned int getAliasCount () const
 
std::string getAliasAuthorityAtIndex (const unsigned int &index) const
 
std::string getAliasTitleAtIndex (const unsigned int &index) const
 
const std::vector< RESQML2_NS::Activity * > & getActivitySet () const
 
unsigned int getActivityCount () const
 
RESQML2_NS::Activity * getActivity (const unsigned int &index) const
 
void pushBackExtraMetadata (const std::string &key, const std::string &value)
 
std::tr1::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 (const unsigned int &index) const
 
std::string getExtraMetadataStringValueAtIndex (const unsigned int &index) const
 

Static Public Attributes

static const char * XML_TAG = "TimeSeries"
 

Protected Member Functions

 TimeSeries ()
 
 TimeSeries (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
 
 TimeSeries (gsoap_resqml2_0_1::_resqml2__TimeSeries *fromGsoap)
 
std::vector< epc::Relationship > getAllEpcRelationships () const
 
void importRelationshipSetFromEpc (COMMON_NS::EpcDocument *epcDoc)
 
- Protected Member Functions inherited from COMMON_NS::AbstractObject
 AbstractObject ()
 Indicate whether methods update the XML (gSoap) or only the C++ classes of the API.
 
 AbstractObject (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
 
 AbstractObject (gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *proxy)
 
 AbstractObject (gsoap_eml2_1::eml21__AbstractObject *proxy)
 
void initMandatoryMetadata ()
 
void setMetadata (const std::string &guid, const std::string &title, const std::string &editor, const time_t &creation, const std::string &originator, const std::string &description, const time_t &lastUpdate, const std::string &format, const std::string &descriptiveKeywords)
 
void cannotBePartial () const
 
void changeToPartialObject ()
 

Protected Attributes

std::vector< RESQML2_NS::AbstractProperty * > propertySet
 
- Protected Attributes inherited from COMMON_NS::AbstractObject
gsoap_resqml2_0_1::eml20__AbstractCitedDataObject * gsoapProxy2_0_1
 
gsoap_eml2_1::eml21__AbstractObject * gsoapProxy2_1
 
COMMON_NS::EpcDocument * epcDocument
 
std::vector< RESQML2_NS::Activity * > activitySet
 
bool updateXml
 

Friends

void AbstractProperty::setTimeSeries (TimeSeries *ts)
 

Additional Inherited Members

- Protected Types inherited from COMMON_NS::AbstractObject
enum  EmlVersion { TWO_DOT_ZERO = 0, TWO_DOT_ONE = 1 }
 
- Static Protected Member Functions inherited from COMMON_NS::AbstractObject
static void addActivityToResqmlObject (RESQML2_NS::Activity *activity, AbstractObject *resqmlObject)
 

Constructor & Destructor Documentation

RESQML2_NS::TimeSeries::TimeSeries ( )
inlineprotected

Default constructor does nothing

RESQML2_NS::TimeSeries::TimeSeries ( gsoap_resqml2_0_1::eml20__DataObjectReference *  partialObject)
inlineprotected

Only to be used in partial transfer context

RESQML2_NS::TimeSeries::TimeSeries ( gsoap_resqml2_0_1::_resqml2__TimeSeries *  fromGsoap)
inlineprotected

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

RESQML2_NS::TimeSeries::~TimeSeries ( )
inline

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

Member Function Documentation

vector< Relationship > TimeSeries::getAllEpcRelationships ( ) const
protectedvirtual

Return all relationships (backward and forward ones) of the instance using EPC format.

Implements COMMON_NS::AbstractObject.

const std::vector<RESQML2_NS::AbstractProperty*>& RESQML2_NS::TimeSeries::getPropertySet ( ) const
inline

Get all the properties which use this time series

time_t TimeSeries::getTimestamp ( const unsigned int &  index) const

Get a timestamp at a particular index of this timeseries.

tm TimeSeries::getTimestampAsTimeStructure ( const unsigned int &  index) const

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

unsigned int TimeSeries::getTimestampCount ( ) const

Get the count of timestamps in this time series.

unsigned int TimeSeries::getTimestampIndex ( const time_t &  timestamp) const

Get the index of a timestamp in the time series.

Returns
uint.max if this timestamp has not been found in this time series.
unsigned int TimeSeries::getTimestampIndex ( const tm &  timestamp) const

Get the index of a timestamp in the time series.

Returns
uint.max if this timestamp has not been found in this time series.
virtual std::string RESQML2_NS::TimeSeries::getXmlTag ( ) const
inlinevirtual

Get the XML tag for the XML serialization of this instance

Implements COMMON_NS::AbstractObject.

void RESQML2_NS::TimeSeries::importRelationshipSetFromEpc ( COMMON_NS::EpcDocument *  epcDoc)
inlineprotectedvirtual

Does nothing since StringTableLookup has not got any forward relationship.

Implements COMMON_NS::AbstractObject.

void TimeSeries::pushBackTimestamp ( const time_t &  timestamp)

Add a representation values object which uses this property type. Does not add the inverse relationship i.e. from the representation values object to this property type.

void TimeSeries::pushBackTimestamp ( const tm &  timestamp)

Add a representation values object which uses this property type. Does not add the inverse relationship i.e. from the representation values object to this property type.

The documentation for this class was generated from the following files:
Generated by   doxygen 1.8.11