Property kinds carry the semantics of property values. They are used to identify if the values are, for example, representing porosity, length, stress tensor, etc. Energistics provides a list of standard property kind that represent the basis for the commonly used properties in the E&P subsurface workflow. More...

#include <PropertyKind.h>

Inheritance diagram for eml2::PropertyKind:

Public Member Functions
virtual	~PropertyKind ()=default

std::string	getNamingSystem () const

virtual std::string	getBaseUomAsString () const =0

virtual std::string	getParentAsString () const =0

virtual common::DataObjectReference	getParentPropertyKindDor () const =0

PropertyKind *	getParentPropertyKind () const

void	setParentPropertyKind (PropertyKind *parentPropertyKind)

virtual bool	isAbstract () const =0

virtual bool	isParentPartial () const =0

virtual std::string	getXmlTag () const final

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)

void	setGsoapProxy (gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *gsoapProxy)

void	setGsoapProxy (gsoap_eml2_1::eml21__AbstractObject *gsoapProxy)

gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *	getEml20GsoapProxy () const

gsoap_eml2_1::eml21__AbstractObject *	getEml21GsoapProxy () const

gsoap_eml2_2::eml22__AbstractObject *	getEml22GsoapProxy () const

void	setGsoapProxy (gsoap_eml2_2::eml22__AbstractObject *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_1::eml21__DataObjectReference *	newEmlReference () const

gsoap_eml2_2::eml22__DataObjectReference *	newEml22Reference () 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)

unsigned int	getAliasCount () const

std::string	getAliasAuthorityAtIndex (unsigned int index) const

std::string	getAliasTitleAtIndex (unsigned int index) const

std::vector< eml2::Activity * >	getActivitySet () const

unsigned int	getActivityCount () const

eml2::Activity *	getActivity (unsigned int 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

virtual void	loadTargetRelationships ()=0

Static Public Attributes
static const char *	XML_TAG

Additional Inherited Members
Public Types inherited from common::AbstractObject
enum	hdfDatatypeEnum { UNKNOWN = 0 , DOUBLE = 1 , FLOAT = 2 , LONG_64 = 3 , ULONG_64 = 4 , INT = 5 , UINT = 6 , SHORT = 7 , USHORT = 8 , CHAR = 9 , UCHAR = 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

Property kinds carry the semantics of property values. They are used to identify if the values are, for example, representing porosity, length, stress tensor, etc. Energistics provides a list of standard property kind that represent the basis for the commonly used properties in the E&P subsurface workflow.

Constructor & Destructor Documentation

◆ ~PropertyKind()

virtual eml2::PropertyKind::~PropertyKind ( )

virtualdefault

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

Reimplemented in resqml2_0_1::PropertyKind, eml2_3::PropertyKind, and eml2_1::PropertyKind.

Member Function Documentation

◆ getBaseUomAsString()

virtual std::string eml2::PropertyKind::getBaseUomAsString ( ) const

pure virtual

Get the base unit of measure for conversion of the values of this property kind as a string.

Returns: The unit or measure of the values of this property kind as a string.

Implemented in resqml2_0_1::PropertyKind, eml2_3::PropertyKind, and eml2_1::PropertyKind.

◆ getNamingSystem()

std::string eml2::PropertyKind::getNamingSystem ( ) const

Gets (in read only mode) the naming system of this property type. It is the name of the dictionary within which the property is unique. This also defines the name of the controlling authority. It is an URN of the form urn:x-resqml:domainOrEmail:dictionaryName

Returns: The naming system.

◆ getParentAsString()

virtual std::string eml2::PropertyKind::getParentAsString ( ) const

pure virtual

Get the title of the parent property kind

Returns: The title of the parent property kind.

Implemented in resqml2_0_1::PropertyKind, eml2_3::PropertyKind, and eml2_1::PropertyKind.

◆ getParentPropertyKind()

PropertyKind* eml2::PropertyKind::getParentPropertyKind ( ) const

Gets the parent local property kind

Exceptions

std::invalid_argument If the parent property kind is not a local one (it is an Energistics standard one).

Returns: The parent local property kind.

◆ getParentPropertyKindDor()

virtual common::DataObjectReference eml2::PropertyKind::getParentPropertyKindDor ( ) const

pure virtual

Gets a data object reference on the parent local property kind

Exceptions

std::invalid_argument If the parent property kind is not a local one (it is an Energistics standard one).

Returns: The data object reference of the associated parent local property kind.

Implemented in resqml2_0_1::PropertyKind, eml2_3::PropertyKind, and eml2_1::PropertyKind.

◆ getXmlTag()

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

inlinefinalvirtual

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

Returns: The XML tag.

Implements common::AbstractObject.

◆ isAbstract()

virtual bool eml2::PropertyKind::isAbstract ( ) const

pure virtual

Checks if this property kind is abstract or not

Returns: True if abstract, false if not.

Implemented in resqml2_0_1::PropertyKind, eml2_3::PropertyKind, and eml2_1::PropertyKind.

◆ isParentPartial()

virtual bool eml2::PropertyKind::isParentPartial ( ) const

pure virtual

Checks if this property kind is partial or if one of its parent is partial.

Returns: True if this property kind or one of its parent is partial, false if not.

Implemented in resqml2_0_1::PropertyKind, eml2_3::PropertyKind, and eml2_1::PropertyKind.

◆ setParentPropertyKind()

void eml2::PropertyKind::setParentPropertyKind ( PropertyKind * parentPropertyKind )

Sets the parent property kind of this property kind

Exceptions

std::invalid_argument If parentPropertyKind is null.

Parameters

[in] parentPropertyKind The parent property kind to set to this property kind.

Member Data Documentation

◆ XML_TAG

const char* eml2::PropertyKind::XML_TAG

static

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.0.0.0/src/eml2/PropertyKind.h

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~PropertyKind()

Member Function Documentation

◆ getBaseUomAsString()

◆ getNamingSystem()

◆ getParentAsString()

◆ getParentPropertyKind()

◆ getParentPropertyKindDor()

◆ getXmlTag()

◆ isAbstract()

◆ isParentPartial()

◆ setParentPropertyKind()

Member Data Documentation

◆ XML_TAG