common::DataObjectReference Class Reference

This class wraps an Energistics Data Object Reference whatever its version is. More...

#include <DataObjectReference.h>

Public Member Functions
	DataObjectReference ()
	DataObjectReference (gsoap_resqml2_0_1::eml20__DataObjectReference *dor)
	DataObjectReference (gsoap_eml2_3::eml23__DataObjectReference *dor)
	DataObjectReference (AbstractObject const *dataObj)
	~DataObjectReference ()=default
bool	isEmpty () const
std::string	getUuid () const
std::string	getTitle () const
std::string	getVersion () const
std::string	getContentType () const
std::string	getEnergisticsUri () const
gsoap_resqml2_0_1::eml20__DataObjectReference *	toDor20 () const

Detailed Description

This class wraps an Energistics Data Object Reference whatever its version is.

Constructor & Destructor Documentation

DataObjectReference() [1/4]

common::DataObjectReference::DataObjectReference ( )

inline

Default constructor

DataObjectReference() [2/4]

common::DataObjectReference::DataObjectReference ( gsoap_resqml2_0_1::eml20__DataObjectReference * dor )

inline

Constructor

Parameters

[in]

dor

If non-nullptr, the EML2.0 DOR to wrap.

DataObjectReference() [3/4]

common::DataObjectReference::DataObjectReference ( gsoap_eml2_3::eml23__DataObjectReference * dor )

inline

Constructor

Parameters

[in,out]

dor

If non-nullptr, the EML2.3 DOR to wrap.

DataObjectReference() [4/4]

common::DataObjectReference::DataObjectReference ( AbstractObject const * dataObj )

explicit

Constructor

Parameters

[in,out]

dor

If non-nullptr, the Energistics DataObject to wrap.

~DataObjectReference()

common::DataObjectReference::~DataObjectReference ( )

default

Destructor

Member Function Documentation

getContentType()

std::string common::DataObjectReference::getContentType ( ) const

inline

Gets the referenced data object type

Returns

The content type of the referenced data object if it exists, otherwise empty string.

getEnergisticsUri()

std::string common::DataObjectReference::getEnergisticsUri ( ) const

inline

Gets the Energistics URI of the referenced data object

Returns

The Energistics URI of the referenced data object if it exists, otherwise empty string.

getTitle()

std::string common::DataObjectReference::getTitle ( ) const

inline

Gets the referenced data object title (i.e. its name)

Returns

The title of the referenced data object if it exists, otherwise empty string.

getUuid()

std::string common::DataObjectReference::getUuid ( ) const

inline

Gets the referenced data object UUID

Returns

The UUID of the referenced data object if it exists, otherwise empty string.

getVersion()

std::string common::DataObjectReference::getVersion ( ) const

inline

Gets the referenced data object version

Returns

The version of the referenced data object if it exists, otherwise empty string.

isEmpty()

bool common::DataObjectReference::isEmpty ( ) const

inline

Checks if this reference is empty (i.e. it points to nothing)

Returns

True if this reference empty, false if it is not.

toDor20()

gsoap_resqml2_0_1::eml20__DataObjectReference * common::DataObjectReference::toDor20

(

)

const

Convert this instance to an EML2.0 DataObjectReference The return type memory will be managed by gSoap, don't delete it.

Returns

A potentially new EML2.0 DataObjectReference corresponding to this instance. Do not delete it.

---

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

• C:/Users/philippe/dev/fesapiEnv/fesapi-2.10.1.0/src/common/DataObjectReference.h