common::AbstractObject Class Reference

An abstract data object. More...

#include <AbstractObject.h>

Inheritance diagram for common::AbstractObject:

Public Types
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 }

Public Member Functions
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	getXmlTag () 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 ()
virtual void	loadTargetRelationships ()=0

Static Public Member Functions
static void	setFormat (const std::string &vendor, const std::string &applicationName, const std::string &applicationVersionNumber)

Friends
bool	common::DataObjectRepository::addDataObject (common::AbstractObject *proxy)
common::AbstractObject *	common::DataObjectRepository::addOrReplaceDataObject (AbstractObject *proxy, bool replaceOnlyContent)

Detailed Description

An abstract data object.

Member Function Documentation

addAlias()

void common::AbstractObject::addAlias	(	const std::string &	authority,
		const std::string &	title )

Adds an alias for this data object

Exceptions

std::invalid_argument	If this instance is actually a partial object.
std::range_error	If authority or title is more than 64 chars long.

Parameters

authority	The authority of the alias.
title	The title of the alias.

buildEtp12Uri()

std::string common::AbstractObject::buildEtp12Uri ( ) const

inline

Build and return an ETP1.2 URI from an Energistics dataobject. If its URI source has not been set, the Energistics dataobject is considered belonging to the default ETP dataspace.

Returns

The ETP1.2 URI built from the Energistics dataobject

changeToPartialObject()

void common::AbstractObject::changeToPartialObject

(

)

Transform a non partial object into a partial one It is particularly useful when a dataobject happens to be unvalid.

getActivity()

eml2::Activity * common::AbstractObject::getActivity

(

uint64_t

index

)

const

Gets an associated activity at a particular index

Exceptions

std::invalid_argument	If this instance is actually a partial object or if there is no underlying gSOAP proxy.
std::out_of_range	If index is out of range.

Parameters

index

Zero-based index of the asked activity.

Returns

The associated activity at index.

getActivityCount()

uint64_t common::AbstractObject::getActivityCount

(

)

const

Gets the count of the activities where this instance is involved

Exceptions

std::out_of_range

If the count of activities is strictly greater than unsigned int max.

Returns

The count of all activities involving this instance.

getActivitySet()

std::vector< eml2::Activity * > common::AbstractObject::getActivitySet

(

)

const

Gets all the activities where this instance is involved

Returns

The vector of all activities involving this instance.

getAliasAuthorityAtIndex()

std::string common::AbstractObject::getAliasAuthorityAtIndex

(

uint64_t

index

)

const

Gets the alias authority at a particular index in the aliases set

Exceptions

std::invalid_argument	If this instance is actually a partial object or if there is no underlying gSOAP proxy.
std::out_of_range	If index is out of range.

Parameters

index

Zero-based index of the asked alias authority.

Returns

The alias authority at index.

getAliasCount()

uint64_t common::AbstractObject::getAliasCount

(

)

const

Gets the count of aliases in this instance

Exceptions

std::invalid_argument

If this instance is actually a partial object.

Returns

The alias count of this instance.

getAliasTitleAtIndex()

std::string common::AbstractObject::getAliasTitleAtIndex

(

uint64_t

index

)

const

Gets the alias title at a particular index in the aliases set

Exceptions

std::invalid_argument	If this instance is actually a partial object or if there is no underlying gSOAP proxy.
std::out_of_range	If index is out of range.

Parameters

index

Zero-based index of the asked alias title.

Returns

The alias title at index.

getContentType()

virtual std::string common::AbstractObject::getContentType ( ) const

virtual

Gets the content type of this instance according to EPC recommendation

Returns

The content type of this instance.

getCreation()

time_t common::AbstractObject::getCreation

(

)

const

Gets the date and time the data object was created in the source application or, if that information is not available, when it was saved to the file. This is the equivalent of the ISO 19115 CI_Date where the CI_DateTypeCode is creation

Exceptions

std::invalid_argument

If this instance is actually a partial object or if no available gSOAP proxy instance is associated to this data object.

Returns

The creation date and time of the data object.

getCreationAsTimeStructure()

tm common::AbstractObject::getCreationAsTimeStructure

(

)

const

Same as getCreation(). Please use this method if you want to read some dates out of the range of time_t

Exceptions

std::invalid_argument

If this instance is actually a partial object or if no available gSOAP proxy instance is associated to this data object.

Returns

The creation date and time of the data object.

getDescription()

std::string common::AbstractObject::getDescription

(

)

const

Gets the user descriptive comments about this data object. Intended for end-user use (human readable); not necessarily meant to be used by software. This is the equivalent of the ISO 19115 abstract.CharacterString

Exceptions

std::invalid_argument

If this instance is actually a partial object.

Returns

The description of this data object if it is defined, else empty string.

getDescriptiveKeywords()

std::string common::AbstractObject::getDescriptiveKeywords

(

)

const

Gets the key words to describe the activity, for example, history match or volumetric calculations, relevant to this data object. Intended to be used in a search function by software. This is the equivalent in ISO 19115 of descriptiveKeywords.MD_Keywords

Exceptions

std::invalid_argument

If this instance is actually a partial object.

Returns

The key words to describe the activity relevant to this data object if they are defined, else empty string.

getEditor()

std::string common::AbstractObject::getEditor

(

)

const

Gets the name (or other human-readable identifier) of the last person who updated the object. In ISO 19115, this is equivalent to the CI_Individual.name or the CI_Organization.name of the citedResponsibleParty whose role is editor

Exceptions

std::invalid_argument

If this instance is actually a partial object.

Returns

The editor of this data object if it is defined, else empty string.

getEml20GsoapProxy()

gsoap_resqml2_0_1::eml20__AbstractCitedDataObject * common::AbstractObject::getEml20GsoapProxy ( ) const

inline

Get the EML2.0 gSOAP proxy which is wrapped by this entity

Returns

A pointer to the EML2.0 gSOAP proxy.

getEml23GsoapProxy()

gsoap_eml2_3::eml23__AbstractObject * common::AbstractObject::getEml23GsoapProxy ( ) const

inline

Get the EML2.3 gSOAP proxy which is wrapped by this entity

Returns

A pointer to the EML2.3 gSOAP proxy.

getEpcSourceFolder()

std::string common::AbstractObject::getEpcSourceFolder ( ) const

inline

Get the absolute folder path where the source EPC document is located. Returns empty if this dataobject does not come from an EPC document.

getExtraMetadata()

std::vector< std::string > common::AbstractObject::getExtraMetadata

(

const std::string &

key

)

const

Gets an extra metadata of this instance according to its key

Exceptions

std::logic_error

If the underlying gSOAP instance is not a RESQML2.0 one.

Parameters

key	The key of an extra metadata.

Returns

The vector of all metadata values sharing this key (empty vector if there is no such value).

getExtraMetadataCount()

unsigned int common::AbstractObject::getExtraMetadataCount

(

)

const

Get the count of extra metadata in this instance

Exceptions

std::logic_error

If the underlying gSOAP instance is not a RESQML2.0 or EML2.2 one.

Returns

The extra metadata count of this instance.

getExtraMetadataKeyAtIndex()

std::string common::AbstractObject::getExtraMetadataKeyAtIndex

(

unsigned int

index

)

const

Get the key of a key value pair at a particular index in the extra metadata set of this instance

Exceptions

std::logic_error

If the underlying gSOAP instance is not a RESQML2.0 or EML2.2 one.

Parameters

index

Zero-based index of the asked key.

Returns

The extra metadata key at index.

getExtraMetadataSet()

std::unordered_map< std::string, std::string > common::AbstractObject::getExtraMetadataSet

(

)

const

Gets all the extra metadata of this instance in read only mode

Exceptions

std::logic_error

If the underlying gSOAP instance is not a RESQML2.0 one.

Returns

A map associated the keys and values of all extra metadata.

getExtraMetadataStringValueAtIndex()

std::string common::AbstractObject::getExtraMetadataStringValueAtIndex

(

unsigned int

index

)

const

Get the value of a key value pair at a particular index in the extra metadata set of this instance

Exceptions

std::logic_error

If the underlying gSOAP instance is not a RESQML2.0 or EML2.2 one.

Parameters

index

Zero-based index of the asked value.

Returns

The extra metadata value at index.

getFormat()

std::string common::AbstractObject::getFormat

(

)

const

Gets the identifier of the software or service that was used to originate the data object and to create the file. Must be human and machine readable and unambiguously identify the software by including the company name, software name and software version. This is the equivalent in ISO 19115 to the istributionFormat.MD_Format. The ISO format for this is [vendor:applicationName]/fileExtension where the application name includes the version number of the application. In our case, fileExtension is not relevant and will be ignored if present. vendor and applicationName are mandatory

Exceptions

std::invalid_argument

If this instance is actually a partial object or if no available gSOAP proxy instance is associated to this data object.

Returns

The identifier of the software or service that was used to originate the data object and to create the file.

getGsoapContext()

soap * common::AbstractObject::getGsoapContext

(

)

const

Get the gSOAP context where the underlying gSOAP proxy is defined

Returns

A pointer to the gSOAP context.

getGsoapType()

int common::AbstractObject::getGsoapType

(

)

const

Gets the gSOAP type of the wrapped element

Exceptions

std::invalid_argument

It there is no available gSOAP proxy instance.

Returns

The gSOAP type.

getLastUpdate()

time_t common::AbstractObject::getLastUpdate

(

)

const

Gets the date and time the data object was last modified in the source application or, if that information is not available, when it was last saved to the file. This is the equivalent of the ISO 19115 CI_Date where the CI_DateTypeCode is lastUpdate

Exceptions

std::invalid_argument

If this instance is actually a partial object.

Returns

The last update date and time of the data object.

getLastUpdateAsTimeStructure()

tm common::AbstractObject::getLastUpdateAsTimeStructure

(

)

const

Same as getLastUpdate(). Please use this method if you want to read some dates out of the range of time_t

Exceptions

std::invalid_argument

If this instance is actually a partial object.

Returns

The last update date and time of the data object.

getOriginator()

std::string common::AbstractObject::getOriginator

(

)

const

Gets the name (or other human-readable identifier) of the person who initially originated this data object or document in the source application. If that information is not available, then this is the user of the session during the file creation. The originator remains the same as the object is subsequently edited. This is the equivalent in ISO 19115 to the CI_Individual.name or the CI_Organization.name of the citedResponsibleParty whose role is originator

Exceptions

std::invalid_argument

If this instance is actually a partial object or if no available gSOAP proxy instance is associated to this data object.

Returns

The originator name or identifier.

getPartNameInEpcDocument()

virtual std::string common::AbstractObject::getPartNameInEpcDocument ( ) const

virtual

Gets the part name of this XML top level instance in the EPC document

Returns

The part name of this instance.

getQualifiedType()

virtual std::string common::AbstractObject::getQualifiedType ( ) const

virtual

Get the qualified type of the instance i.e. "namespace.datatype"

Returns

The qualified type of the instance i.e. "namespace.datatype"

getRepository()

common::DataObjectRepository * common::AbstractObject::getRepository ( ) const

inline

Returns the data object repository which contains this instance

Returns

A pointer to the data object repository.

getTitle()

std::string common::AbstractObject::getTitle

(

)

const

Gets the title (i.e. the name) of this data object. This is the equivalent of CI_Citation.title in ISO 19115

Exceptions

std::invalid_argument

If no available gSOAP proxy instance is associated to this data object.

Returns

The title of this data object.

getUriSource()

const std::string & common::AbstractObject::getUriSource ( ) const

inline

Get the EPC document absolute path or the ETP dataspace URI where this dataobject comes from.

getUuid()

std::string common::AbstractObject::getUuid

(

)

const

Gets the UUID (https://tools.ietf.org/html/rfc4122#page-3) of this data object. The UUID intends to give an id to the "thing" (i.e. the business object), not to this instance

Exceptions

std::invalid_argument

If no available gSOAP proxy instance is associated to this data object.

Returns

The UUID of this data object.

getVersion()

std::string common::AbstractObject::getVersion

(

)

const

Gets the version of this data object. An empty version indicates that this is the latest (and ideally also the unique) version of this data object.

Returns

The version of this object, empty string means latest version.

getXmlNamespace()

virtual std::string common::AbstractObject::getXmlNamespace ( ) const

pure virtual

Gets the XML namespace for the tags for the XML serialization of this instance

Returns

The XML namespace of this instance.

Implemented in eml2_0::HdfProxy, eml2_0::HdfProxyMPI, eml2_3::Activity, eml2_3::ActivityTemplate, eml2_3::GraphicalInformationSet, eml2_3::HdfProxy, eml2_3::LocalEngineering2dCrs, eml2_3::LocalEngineeringCompoundCrs, eml2_3::PropertyKind, eml2_3::TimeSeries, eml2_3::VerticalCrs, prodml2_2::FluidCharacterization, prodml2_2::FluidSystem, prodml2_2::TimeSeriesData, resqml2::AbstractIjkGridRepresentation, resqml2_0_1::Activity, resqml2_0_1::ActivityTemplate, resqml2_0_1::BlockedWellboreRepresentation, resqml2_0_1::BoundaryFeature, resqml2_0_1::BoundaryFeatureInterpretation, resqml2_0_1::CategoricalProperty, resqml2_0_1::CommentProperty, resqml2_0_1::ContinuousProperty, resqml2_0_1::DeviationSurveyRepresentation, resqml2_0_1::DiscreteProperty, resqml2_0_1::DoubleTableLookup, resqml2_0_1::EarthModelInterpretation, resqml2_0_1::FaultInterpretation, resqml2_0_1::FrontierFeature, resqml2_0_1::GenericFeatureInterpretation, resqml2_0_1::GeobodyBoundaryInterpretation, resqml2_0_1::GeobodyInterpretation, resqml2_0_1::GeologicUnitFeature, resqml2_0_1::Grid2dRepresentation, resqml2_0_1::GridConnectionSetRepresentation, resqml2_0_1::HorizonInterpretation, resqml2_0_1::IjkGridExplicitRepresentation, resqml2_0_1::IjkGridLatticeRepresentation, resqml2_0_1::IjkGridNoGeometryRepresentation, resqml2_0_1::IjkGridParametricRepresentation, resqml2_0_1::LocalDepth3dCrs, resqml2_0_1::LocalTime3dCrs, resqml2_0_1::MdDatum, resqml2_0_1::NonSealedSurfaceFrameworkRepresentation, resqml2_0_1::OrganizationFeature, resqml2_0_1::PlaneSetRepresentation, resqml2_0_1::PointSetRepresentation, resqml2_0_1::PointsProperty, resqml2_0_1::PolylineRepresentation, resqml2_0_1::PolylineSetRepresentation, resqml2_0_1::PropertyKind, resqml2_0_1::PropertySet, resqml2_0_1::RepresentationSetRepresentation, resqml2_0_1::RockFluidOrganizationInterpretation, resqml2_0_1::RockFluidUnitInterpretation, resqml2_0_1::SealedSurfaceFrameworkRepresentation, resqml2_0_1::SealedVolumeFrameworkRepresentation, resqml2_0_1::SeismicLatticeFeature, resqml2_0_1::SeismicLineFeature, resqml2_0_1::SeismicLineSetFeature, resqml2_0_1::StratigraphicColumn, resqml2_0_1::StratigraphicColumnRankInterpretation, resqml2_0_1::StratigraphicOccurrenceInterpretation, resqml2_0_1::StratigraphicUnitInterpretation, resqml2_0_1::StreamlinesFeature, resqml2_0_1::StreamlinesRepresentation, resqml2_0_1::StringTableLookup, resqml2_0_1::StructuralOrganizationInterpretation, resqml2_0_1::SubRepresentation, resqml2_0_1::TimeSeries, resqml2_0_1::TriangulatedSetRepresentation, resqml2_0_1::UnstructuredGridRepresentation, resqml2_0_1::WellboreFeature, resqml2_0_1::WellboreFrameRepresentation, resqml2_0_1::WellboreInterpretation, resqml2_0_1::WellboreMarker, resqml2_0_1::WellboreMarkerFrameRepresentation, resqml2_0_1::WellboreTrajectoryRepresentation, resqml2_2::BlockedWellboreRepresentation, resqml2_2::BoundaryFeature, resqml2_2::BoundaryFeatureInterpretation, resqml2_2::CmpLineFeature, resqml2_2::CommentProperty, resqml2_2::ContinuousColorMap, resqml2_2::ContinuousProperty, resqml2_2::CulturalFeature, resqml2_2::DiscreteColorMap, resqml2_2::DiscreteProperty, resqml2_2::EarthModelInterpretation, resqml2_2::FaultInterpretation, resqml2_2::FluidBoundaryInterpretation, resqml2_2::GenericFeatureInterpretation, resqml2_2::GeobodyBoundaryInterpretation, resqml2_2::GeobodyInterpretation, resqml2_2::Grid2dRepresentation, resqml2_2::GridConnectionSetRepresentation, resqml2_2::HorizonInterpretation, resqml2_2::IjkGridExplicitRepresentation, resqml2_2::IjkGridLatticeRepresentation, resqml2_2::IjkGridNoGeometryRepresentation, resqml2_2::IjkGridParametricRepresentation, resqml2_2::Model, resqml2_2::NonSealedSurfaceFrameworkRepresentation, resqml2_2::PlaneSetRepresentation, resqml2_2::PointSetRepresentation, resqml2_2::PointsProperty, resqml2_2::PolylineRepresentation, resqml2_2::PolylineSetRepresentation, resqml2_2::RepresentationSetRepresentation, resqml2_2::RockFluidOrganizationInterpretation, resqml2_2::RockFluidUnitInterpretation, resqml2_2::RockVolumeFeature, resqml2_2::SealedSurfaceFrameworkRepresentation, resqml2_2::SealedVolumeFrameworkRepresentation, resqml2_2::SeismicLatticeFeature, resqml2_2::SeismicLineSetFeature, resqml2_2::SeismicWellboreFrameRepresentation, resqml2_2::ShotPointLineFeature, resqml2_2::StratigraphicColumn, resqml2_2::StratigraphicColumnRankInterpretation, resqml2_2::StratigraphicUnitInterpretation, resqml2_2::StreamlinesFeature, resqml2_2::StreamlinesRepresentation, resqml2_2::StructuralOrganizationInterpretation, resqml2_2::SubRepresentation, resqml2_2::TriangulatedSetRepresentation, resqml2_2::UnstructuredGridRepresentation, resqml2_2::WellboreFeature, resqml2_2::WellboreFrameRepresentation, resqml2_2::WellboreInterpretation, resqml2_2::WellboreTrajectoryRepresentation, witsml2_1::Channel, witsml2_1::ChannelSet, witsml2_1::ErrorTerm, witsml2_1::ErrorTermDictionary, witsml2_1::Log, witsml2_1::ToolErrorModel, witsml2_1::ToolErrorModelDictionary, witsml2_1::Trajectory, witsml2_1::WeightingFunction, witsml2_1::WeightingFunctionDictionary, witsml2_1::Well, witsml2_1::Wellbore, witsml2_1::WellboreCompletion, witsml2_1::WellboreGeometry, witsml2_1::WellboreMarker, witsml2_1::WellboreMarkerSet, and witsml2_1::WellCompletion.

getXmlNamespaceVersion()

virtual std::string common::AbstractObject::getXmlNamespaceVersion ( ) const

virtual

Gets the version of the XML namespace (i.e. WITSML, RESQML, PRODML) for the XML serialization of this instance

Returns

The XML namespace version of this instance.

Reimplemented in resqml2_0_1::Activity, and resqml2_0_1::ActivityTemplate.

getXmlTag()

virtual std::string common::AbstractObject::getXmlTag ( ) const

pure virtual

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

Returns

The XML tag.

Implemented in eml2::Activity, eml2::ActivityTemplate, eml2::EpcExternalPartReference, eml2::GraphicalInformationSet, eml2::PropertyKind, eml2::TimeSeries, eml2_3::LocalEngineering2dCrs, eml2_3::LocalEngineeringCompoundCrs, eml2_3::VerticalCrs, prodml2_2::FluidCharacterization, prodml2_2::FluidSystem, prodml2_2::TimeSeriesData, resqml2::AbstractIjkGridRepresentation, resqml2::BlockedWellboreRepresentation, resqml2::BoundaryFeature, resqml2::BoundaryFeatureInterpretation, resqml2::CategoricalProperty, resqml2::CmpLineFeature, resqml2::CommentProperty, resqml2::ContinuousColorMap, resqml2::ContinuousProperty, resqml2::DiscreteColorMap, resqml2::DiscreteProperty, resqml2::DoubleTableLookup, resqml2::EarthModelInterpretation, resqml2::FaultInterpretation, resqml2::FluidBoundaryInterpretation, resqml2::GenericFeatureInterpretation, resqml2::GeobodyBoundaryInterpretation, resqml2::GeobodyInterpretation, resqml2::Grid2dRepresentation, resqml2::GridConnectionSetRepresentation, resqml2::HorizonInterpretation, resqml2::MdDatum, resqml2::NonSealedSurfaceFrameworkRepresentation, resqml2::PlaneSetRepresentation, resqml2::PointSetRepresentation, resqml2::PointsProperty, resqml2::PolylineRepresentation, resqml2::PolylineSetRepresentation, resqml2::RepresentationSetRepresentation, resqml2::RockFluidUnitInterpretation, resqml2::SealedSurfaceFrameworkRepresentation, resqml2::SealedVolumeFrameworkRepresentation, resqml2::SeismicLatticeFeature, resqml2::SeismicLineSetFeature, resqml2::SeismicWellboreFrameRepresentation, resqml2::ShotPointLineFeature, resqml2::StratigraphicColumn, resqml2::StratigraphicColumnRankInterpretation, resqml2::StratigraphicOccurrenceInterpretation, resqml2::StratigraphicUnitInterpretation, resqml2::StreamlinesFeature, resqml2::StreamlinesRepresentation, resqml2::StringTableLookup, resqml2::StructuralOrganizationInterpretation, resqml2::SubRepresentation, resqml2::TriangulatedSetRepresentation, resqml2::UnstructuredGridRepresentation, resqml2::WellboreFeature, resqml2::WellboreInterpretation, resqml2::WellboreMarker, resqml2::WellboreMarkerFrameRepresentation, resqml2::WellboreTrajectoryRepresentation, resqml2_0_1::BoundaryFeatureInterpretation, resqml2_0_1::DeviationSurveyRepresentation, resqml2_0_1::FluidBoundaryFeature, resqml2_0_1::FrontierFeature, resqml2_0_1::GeneticBoundaryFeature, resqml2_0_1::GeobodyFeature, resqml2_0_1::GeologicUnitFeature, resqml2_0_1::LocalDepth3dCrs, resqml2_0_1::LocalTime3dCrs, resqml2_0_1::OrganizationFeature, resqml2_0_1::PropertySet, resqml2_0_1::RockFluidOrganizationInterpretation, resqml2_0_1::RockFluidUnitFeature, resqml2_0_1::SeismicLineFeature, resqml2_0_1::StratigraphicUnitFeature, resqml2_0_1::TectonicBoundaryFeature, resqml2_0_1::WellboreFrameRepresentation, resqml2_2::CulturalFeature, resqml2_2::Model, resqml2_2::RockFluidOrganizationInterpretation, resqml2_2::RockVolumeFeature, resqml2_2::WellboreFrameRepresentation, witsml2_1::Channel, witsml2_1::ChannelSet, witsml2_1::ErrorTerm, witsml2_1::ErrorTermDictionary, witsml2_1::Log, witsml2_1::ToolErrorModel, witsml2_1::ToolErrorModelDictionary, witsml2_1::WeightingFunction, witsml2_1::WeightingFunctionDictionary, witsml2_1::WellboreCompletion, witsml2_1::WellboreGeometry, witsml2_1::WellboreMarker, witsml2_1::WellboreMarkerSet, witsml2_1::WellCompletion, WITSML2_NS::Trajectory, WITSML2_NS::Well, and WITSML2_NS::Wellbore.

isPartial()

bool common::AbstractObject::isPartial

(

)

const

Indicates if this data object is actually a partial object. A partial object just contains a mime type, an UUID and a title as a minimum amount of information. A partial object is never explicit in an EPC document: it is not a file

Returns

True if is partial, false if is not.

loadTargetRelationships()

virtual void common::AbstractObject::loadTargetRelationships ( )

pure virtual

Reads the forward relationships of this data object and update the .rels of the associated data repository.

Implemented in eml2::GraphicalInformationSet, eml2_3::LocalEngineering2dCrs, eml2_3::LocalEngineeringCompoundCrs, eml2_3::PropertyKind, eml2_3::VerticalCrs, prodml2_2::FluidCharacterization, prodml2_2::FluidSystem, prodml2_2::TimeSeriesData, resqml2::AbstractColorMap, resqml2::AbstractFeature, resqml2::AbstractFeatureInterpretation, resqml2::AbstractGridRepresentation, resqml2::AbstractRepresentation, resqml2::CmpLineFeature, resqml2::RepresentationSetRepresentation, resqml2::StreamlinesFeature, resqml2::StreamlinesRepresentation, resqml2::SubRepresentation, resqml2::WellboreFeature, resqml2_0_1::Activity, resqml2_0_1::LocalDepth3dCrs, resqml2_0_1::LocalTime3dCrs, resqml2_0_1::MdDatum, resqml2_0_1::PropertyKind, resqml2_0_1::PropertySet, resqml2_2::SeismicWellboreFrameRepresentation, witsml2_1::Channel, witsml2_1::ChannelSet, witsml2_1::ErrorTerm, witsml2_1::ErrorTermDictionary, witsml2_1::Log, witsml2_1::ToolErrorModel, witsml2_1::ToolErrorModelDictionary, witsml2_1::WeightingFunction, witsml2_1::WeightingFunctionDictionary, witsml2_1::WellboreCompletion, witsml2_1::WellCompletion, WITSML2_NS::Wellbore, and WITSML2_NS::WellboreObject.

newContactElementReference2_0_1()

gsoap_resqml2_0_1::resqml20__ContactElementReference * common::AbstractObject::newContactElementReference2_0_1

(

)

const

Creates an returns an EML2.0 contact data object reference which targets this data object

Returns

A pointer to the new EML2.0 contact data object reference.

newContactElementReference2_2()

gsoap_eml2_3::resqml22__ContactElement * common::AbstractObject::newContactElementReference2_2

(

)

const

Creates an returns an EML2.2 contact data object reference which targets this data object

Returns

A pointer to the new EML2.2 contact data object reference.

newEml23Reference()

gsoap_eml2_3::eml23__DataObjectReference * common::AbstractObject::newEml23Reference

(

)

const

Creates an returns an EML2.2 data object reference which targets this data object

Returns

A pointer to the new EML2.2 data object reference.

newResqmlReference()

gsoap_resqml2_0_1::eml20__DataObjectReference * common::AbstractObject::newResqmlReference

(

)

const

Creates an returns an EML2.0 data object reference which targets this data object

Returns

A pointer to the new EML2.0 data object reference.

pushBackExtraMetadata()

void common::AbstractObject::pushBackExtraMetadata	(	const std::string &	key,
		const std::string &	value )

Pushes back an extra metadata (not a standard one) onto this instance

Exceptions

std::logic_error

If the underlying gSOAP instance is not a RESQML2.0, EML2.1 or EML2.2 one.

Parameters

key	The key of the metadata.
value	The value of the metadata.

serializeIntoStream()

void common::AbstractObject::serializeIntoStream

(

std::ostream *

stream

)

Serializes this instance into a stream

Exceptions

std::invalid_argument

If this instance is actually a partial object or if stream is null.

Parameters

[out]

stream

A stream. It must be opened for writing and won't be closed.

serializeIntoString()

std::string common::AbstractObject::serializeIntoString

(

)

Serializes the gSOAP proxy of this instance into a string

Returns

The string result of the serialization process.

setCreation() [1/2]

void common::AbstractObject::setCreation

(

const tm &

creation

)

Same as setCreation(). Please use this method if you want to set some dates out of the range of time_t

Exceptions

std::invalid_argument

If this instance is actually a partial object.

Parameters

creation

The creation date and time to set to this data object.

setCreation() [2/2]

void common::AbstractObject::setCreation

(

time_t

creation

)

Sets the date and time the data object was created in the source application or, if that information is not available, when it was saved to the file. This is the equivalent of the ISO 19115 CI_Date where the CI_DateTypeCode is creation

Exceptions

std::invalid_argument

If this instance is actually a partial object.

Parameters

creation

The creation date and time to set to this data object.

setDescription()

void common::AbstractObject::setDescription

(

const std::string &

description

)

Sets a user descriptive comments about this data object. Intended for end-user use (human readable); not necessarily meant to be used by software. This is the equivalent of the ISO 19115 abstract.CharacterString

Exceptions

std::invalid_argument	If this instance is actually a partial object.
std::range_error	If description is too long (more than 4000 chars for RESQML2.0 or more than 2000 chars for EML2.1 and EML2.2).

Parameters

description

The description to set to this data object.

setDescriptiveKeywords()

void common::AbstractObject::setDescriptiveKeywords

(

const std::string &

descriptiveKeywords

)

Set the key words to describe the activity, for example, history match or volumetric calculations, relevant to this object. Intended to be used in a search function by software. This is the equivalent in ISO 19115 of descriptiveKeywords.MD_Keywords

Exceptions

std::invalid_argument	If this instance is actually a partial object.
std::range_error	If descriptiveKeywords is too long (more than 4000 chars for RESQML2.0 or more than 2000 chars for EML2.1 and EML2.2).

Parameters

descriptiveKeywords

The key words to describe the activity relevant to this data object.

setEditor()

void common::AbstractObject::setEditor

(

const std::string &

editor

)

Sets the name (or other human-readable identifier) of the last person who updated the object. In ISO 19115, this is equivalent to the CI_Individual.name or the CI_Organization.name of the citedResponsibleParty whose role is editor

Exceptions

std::invalid_argument	If this instance is actually a partial object.
std::range_error	If editor is more than 64 chars long.

Parameters

editor

The editor to set to this data object.

setFormat()

static void common::AbstractObject::setFormat ( const std::string & vendor, const std::string & applicationName, const std::string & applicationVersionNumber )

static

Sets the default citation format which is going to be written in each created object. A maximum of 256 chars is allowed.

Exceptions

std::range_error

If the format is more than 256 chars long.

Parameters

vendor	The name of the vendor which is exporting the data objects.
applicationName	The name of the application which is exporting the data objects.
applicationVersionNumber	The version of the application which is exporting the data objects.

setGsoapProxy() [1/2]

void common::AbstractObject::setGsoapProxy ( gsoap_eml2_3::eml23__AbstractObject * gsoapProxy )

inline

Sets the underlying EML2.3 gSOAP proxy of this data object

Parameters

[in]

gsoapProxy

If non-null, the gSOAP proxy.

setGsoapProxy() [2/2]

void common::AbstractObject::setGsoapProxy ( gsoap_resqml2_0_1::eml20__AbstractCitedDataObject * gsoapProxy )

inline

Sets the underlying RESQML2.0 gSOAP proxy of this data object

Parameters

[in]

gsoapProxy

If non-null, the gSOAP proxy.

setLastUpdate() [1/2]

void common::AbstractObject::setLastUpdate

(

const tm &

lastUpdate

)

Same as setLastUpdate(). Please use this method if you want to read some dates out of the range of time_t

Parameters

lastUpdate

The last update date and time to set to this data object.

setLastUpdate() [2/2]

void common::AbstractObject::setLastUpdate

(

time_t

lastUpdate

)

Sets the date and time the data object was last modified in the source application or, if that information is not available, when it was last saved to the file. This is the equivalent of the ISO 19115 CI_Date where the CI_DateTypeCode is lastUpdate

Exceptions

std::invalid_argument

If this instance is actually a partial object.

Parameters

lastUpdate

The last update date and time to set to this data object.

setMetadata()

void common::AbstractObject::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 )

Sets a title and other common metadata for this instance.

Exceptions

std::invalid_argument	If this instance is actually a partial object.
std::range_error	If title is more than 256 chars long.
std::range_error	If editor title is more than 64 chars long.
std::range_error	If originator title is more than 64 chars long.
std::range_error	If description is too long (more than 4000 chars for RESQML2.0 or more than 2000 chars for EML2.1 and EML2.2).
std::range_error	If descriptiveKeywords is too long (more than 4000 chars for RESQML2.0 or more than 2000 chars for EML2.1 and EML2.2).

Parameters

title	The title to set to this instance. If empty then "unknown" title will be set.
editor	The editor to set to this instance. Set to empty string or zero if you don't want to use.
creation	The creation date and time to set to this instance.
originator	The originator name or identifier to set to this instance. If empty, the user id is set if available, "unknown" if it is not.
description	The description to set to this instance. Set to empty string or zero if you don't want to use.
lastUpdate	The last update date and time to set to this data object.
descriptiveKeywords	The key words to describe the activity relevant to this data object. Set to empty string or zero if you don't want to use.

setOriginator()

void common::AbstractObject::setOriginator

(

const std::string &

originator

)

Sets the name (or other human-readable identifier) of the person who initially originated this data object or document in the source application. If that information is not available, then this is the user of the session during the file creation. The originator remains the same as the object is subsequently edited. This is the equivalent in ISO 19115 to the CI_Individual.name or the CI_Organization.name of the citedResponsibleParty whose role is originator

Exceptions

std::invalid_argument	If this instance is actually a partial object.
std::range_error	If originator is more than 64 chars long.

Parameters

originator

The originator name or identifier to set to this data object. If empty, the user id is set if available, "unknown" if it is not.

setTitle()

void common::AbstractObject::setTitle

(

const std::string &

title

)

Sets the title (i.e. the name) of this data object. This is the equivalent of CI_Citation.title in ISO 19115

Exceptions

std::invalid_argument	If this instance is actually a partial object.
std::range_error	If title is more than 256 chars long.

Parameters

title

The title to set to this data object. If empty then "unknown" title will be set.

setUriSource()

void common::AbstractObject::setUriSource ( const std::string & uriSource )

inline

Set the EPC document absolute path or the ETP dataspace URI where this dataobject comes from.

setVersion()

void common::AbstractObject::setVersion

(

const std::string &

version

)

Set the version of this data object

Exceptions

std::invalid_argument	If version is empty.
std::range_error	If version is more than 64 chars long.

Parameters

version

The version to set to 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/common/AbstractObject.h