Inheritance diagram for RESQML2_NS::AbstractProperty:

Public Member Functions
virtual	~AbstractProperty ()

DLL_IMPORT_OR_EXPORT void	setRepresentation (class AbstractRepresentation *rep)

gsoap_resqml2_0_1::eml20__DataObjectReference *	getRepresentationDor () const

DLL_IMPORT_OR_EXPORT class AbstractRepresentation *	getRepresentation () const

DLL_IMPORT_OR_EXPORT std::string	getRepresentationUuid () const

DLL_IMPORT_OR_EXPORT std::string	getRepresentationTitle () const

DLL_IMPORT_OR_EXPORT std::string	getRepresentationContentType () const

DLL_IMPORT_OR_EXPORT unsigned int	getElementCountPerValue () const

DLL_IMPORT_OR_EXPORT gsoap_resqml2_0_1::resqml20__IndexableElements	getAttachmentKind () const

DLL_IMPORT_OR_EXPORT std::vector< RESQML2_NS::PropertySet * >	getPropertySets () const

DLL_IMPORT_OR_EXPORT unsigned int	getPropertySetCount () const

DLL_IMPORT_OR_EXPORT RESQML2_NS::PropertySet *	getPropertySet (unsigned int index) const

DLL_IMPORT_OR_EXPORT bool	hasRealizationIndex () const

DLL_IMPORT_OR_EXPORT ULONG64	getRealizationIndex () const

DLL_IMPORT_OR_EXPORT void	setRealizationIndex (ULONG64 realizationIndex)

DLL_IMPORT_OR_EXPORT void	setTimeSeries (class TimeSeries *ts)

DLL_IMPORT_OR_EXPORT TimeSeries *	getTimeSeries () const

gsoap_resqml2_0_1::eml20__DataObjectReference *	getTimeSeriesDor () const

DLL_IMPORT_OR_EXPORT std::string	getTimeSeriesUuid () const

DLL_IMPORT_OR_EXPORT std::string	getTimeSeriesTitle () const

DLL_IMPORT_OR_EXPORT void	setTimeIndex (const unsigned int &timeIndex, class TimeSeries *ts)

DLL_IMPORT_OR_EXPORT void	setTimeStep (const unsigned int &timeStep)

DLL_IMPORT_OR_EXPORT time_t	getTimestamp () const

DLL_IMPORT_OR_EXPORT unsigned int	getTimeIndex () const

DLL_IMPORT_OR_EXPORT bool	isAssociatedToOneStandardEnergisticsPropertyKind () const

DLL_IMPORT_OR_EXPORT std::string	getPropertyKindDescription () const

DLL_IMPORT_OR_EXPORT std::string	getPropertyKindAsString () const

DLL_IMPORT_OR_EXPORT std::string	getPropertyKindParentAsString () const

DLL_IMPORT_OR_EXPORT gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind	getEnergisticsPropertyKind () const

DLL_IMPORT_OR_EXPORT void	setLocalPropertyKind (class PropertyKind *propKind)

gsoap_resqml2_0_1::eml20__DataObjectReference *	getLocalPropertyKindDor () const

DLL_IMPORT_OR_EXPORT std::string	getLocalPropertyKindUuid () const

DLL_IMPORT_OR_EXPORT std::string	getLocalPropertyKindTitle () const

DLL_IMPORT_OR_EXPORT class PropertyKind *	getLocalPropertyKind () const

virtual bool	validatePropertyKindAssociation (class PropertyKind *pk)=0

virtual bool	validatePropertyKindAssociation (gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind pk)=0

bool	validate ()

Public Member Functions inherited from COMMON_NS::AbstractObject
DLL_IMPORT_OR_EXPORT bool	isPartial () const

DLL_IMPORT_OR_EXPORT std::string	getUuid () const

DLL_IMPORT_OR_EXPORT std::string	getTitle () const

DLL_IMPORT_OR_EXPORT std::string	getEditor () const

DLL_IMPORT_OR_EXPORT time_t	getCreation () const

DLL_IMPORT_OR_EXPORT tm	getCreationAsTimeStructure () const

DLL_IMPORT_OR_EXPORT std::string	getOriginator () const

DLL_IMPORT_OR_EXPORT std::string	getDescription () const

DLL_IMPORT_OR_EXPORT time_t	getLastUpdate () const

DLL_IMPORT_OR_EXPORT tm	getLastUpdateAsTimeStructure () const

DLL_IMPORT_OR_EXPORT std::string	getFormat () const

DLL_IMPORT_OR_EXPORT std::string	getDescriptiveKeywords () const

DLL_IMPORT_OR_EXPORT std::string	getVersion () const

DLL_IMPORT_OR_EXPORT void	setTitle (const std::string &title)

DLL_IMPORT_OR_EXPORT void	setEditor (const std::string &editor)

DLL_IMPORT_OR_EXPORT void	setCreation (time_t creation)

DLL_IMPORT_OR_EXPORT void	setCreation (const tm &creation)

DLL_IMPORT_OR_EXPORT void	setOriginator (const std::string &originator)

DLL_IMPORT_OR_EXPORT void	setDescription (const std::string &description)

DLL_IMPORT_OR_EXPORT void	setLastUpdate (time_t lastUpdate)

DLL_IMPORT_OR_EXPORT void	setLastUpdate (const tm &lastUpdate)

DLL_IMPORT_OR_EXPORT void	setDescriptiveKeywords (const std::string &descriptiveKeywords)

DLL_IMPORT_OR_EXPORT void	setVersion (const std::string &version)

DLL_IMPORT_OR_EXPORT 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)

DLL_IMPORT_OR_EXPORT void	serializeIntoStream (std::ostream *stream)

void	setGsoapProxy (gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *gsoapProxy)

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::resqml20__ContactElementReference *	newResqmlContactElementReference () const

DLL_IMPORT_OR_EXPORT COMMON_NS::DataObjectRepository *	getRepository () const

virtual std::string	getXmlNamespace () const

virtual DLL_IMPORT_OR_EXPORT std::string	getXmlTag () const =0

virtual DLL_IMPORT_OR_EXPORT std::string	getXmlNamespaceVersion () const

virtual DLL_IMPORT_OR_EXPORT std::string	getContentType () const

virtual std::string	getPartNameInEpcDocument () const

DLL_IMPORT_OR_EXPORT std::string	serializeIntoString ()

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

DLL_IMPORT_OR_EXPORT unsigned int	getAliasCount () const

DLL_IMPORT_OR_EXPORT std::string	getAliasAuthorityAtIndex (unsigned int index) const

DLL_IMPORT_OR_EXPORT std::string	getAliasTitleAtIndex (unsigned int index) const

DLL_IMPORT_OR_EXPORT std::vector< RESQML2_NS::Activity * >	getActivitySet () const

DLL_IMPORT_OR_EXPORT unsigned int	getActivityCount () const

DLL_IMPORT_OR_EXPORT RESQML2_NS::Activity *	getActivity (unsigned int index) const

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

DLL_IMPORT_OR_EXPORT std::unordered_map< std::string, std::string >	getExtraMetadataSet () const

DLL_IMPORT_OR_EXPORT std::vector< std::string >	getExtraMetadata (const std::string &key) const

DLL_IMPORT_OR_EXPORT unsigned int	getExtraMetadataCount () const

DLL_IMPORT_OR_EXPORT std::string	getExtraMetadataKeyAtIndex (unsigned int index) const

DLL_IMPORT_OR_EXPORT std::string	getExtraMetadataStringValueAtIndex (unsigned int index) const

Protected Member Functions
DLL_IMPORT_OR_EXPORT	AbstractProperty (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)

	AbstractProperty ()

	AbstractProperty (gsoap_resqml2_0_1::resqml20__AbstractProperty *fromGsoap)

virtual void	loadTargetRelationships ()

Protected Member Functions inherited from COMMON_NS::AbstractObject
	AbstractObject ()

	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, time_t creation, const std::string &originator, const std::string &description, time_t lastUpdate, const std::string &descriptiveKeywords)

void	cannotBePartial () const

void	changeToPartialObject ()

void	readArrayNdOfDoubleValues (gsoap_resqml2_0_1::resqml20__AbstractDoubleArray arrayInput, double arrayOutput) const

void	readArrayNdOfUIntValues (gsoap_resqml2_0_1::resqml20__AbstractIntegerArray arrayInput, unsigned int arrayOutput) const

ULONG64	getCountOfIntegerArray (gsoap_resqml2_0_1::resqml20__AbstractIntegerArray *arrayInput) const

void	convertDorIntoRel (gsoap_resqml2_0_1::eml20__DataObjectReference const *dor)

template<class valueType >
void	convertDorIntoRel (gsoap_resqml2_0_1::eml20__DataObjectReference const *dor)

template<class valueType >
void	convertDorIntoRel (gsoap_eml2_1::eml21__DataObjectReference const *dor)

COMMON_NS::AbstractHdfProxy *	getHdfProxyFromDataset (gsoap_resqml2_0_1::eml20__Hdf5Dataset const *dataset, bool throwException=true) const

Additional Inherited Members
Static Public Member Functions inherited from COMMON_NS::AbstractObject
static DLL_IMPORT_OR_EXPORT void	setFormat (const std::string &vendor, const std::string &applicationName, const std::string &applicationVersionNumber)

Protected Types inherited from COMMON_NS::AbstractObject
enum	EmlVersion { TWO_DOT_ZERO = 0, TWO_DOT_ONE = 1, TWO_DOT_TWO = 2 }

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::DataObjectRepository *	repository

Constructor & Destructor Documentation

◆ AbstractProperty() [1/3]

DLL_IMPORT_OR_EXPORT RESQML2_NS::AbstractProperty::AbstractProperty ( gsoap_resqml2_0_1::eml20__DataObjectReference * partialObject )

inlineprotected

Only to be used in partial transfer context

◆ AbstractProperty() [2/3]

RESQML2_NS::AbstractProperty::AbstractProperty ( )

inlineprotected

Default constructor

◆ AbstractProperty() [3/3]

RESQML2_NS::AbstractProperty::AbstractProperty ( gsoap_resqml2_0_1::resqml20__AbstractProperty * fromGsoap )

inlineprotected

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

◆ ~AbstractProperty()

virtual RESQML2_NS::AbstractProperty::~AbstractProperty ( )

inlinevirtual

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

Member Function Documentation

◆ getAttachmentKind()

DLL_IMPORT_OR_EXPORT gsoap_resqml2_0_1::resqml20__IndexableElements RESQML2_NS::AbstractProperty::getAttachmentKind ( ) const

Get the kind of elements the property values are attached to.

◆ getElementCountPerValue()

DLL_IMPORT_OR_EXPORT unsigned int RESQML2_NS::AbstractProperty::getElementCountPerValue ( ) const

Getter (in read only mode) of the element count per property value. If the property is a scalar one then it should be one. If it is a vectorial one, then it should be more than one. It is not possible to have some tensor property values (more dimensions than a vector).

◆ getEnergisticsPropertyKind()

DLL_IMPORT_OR_EXPORT gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind RESQML2_NS::AbstractProperty::getEnergisticsPropertyKind ( ) const

Getter for the energistics property kind which is associated to this intance.

◆ getLocalPropertyKind()

DLL_IMPORT_OR_EXPORT class PropertyKind* RESQML2_NS::AbstractProperty::getLocalPropertyKind ( ) const

Getter for the local property kind which is associated to this instance. If nullptr is returned then it means this instance is associated to an energistics standard property kind.

◆ getLocalPropertyKindDor()

gsoap_resqml2_0_1::eml20__DataObjectReference* RESQML2_NS::AbstractProperty::getLocalPropertyKindDor ( ) const

Returns: null pointer if no local property kind is associated to this property. Otherwise return the data object reference of the associated local property kind.

◆ getLocalPropertyKindTitle()

DLL_IMPORT_OR_EXPORT std::string RESQML2_NS::AbstractProperty::getLocalPropertyKindTitle ( ) const

Get the title of the local property kind which is associated to this property.

◆ getLocalPropertyKindUuid()

DLL_IMPORT_OR_EXPORT std::string RESQML2_NS::AbstractProperty::getLocalPropertyKindUuid ( ) const

Get the uuid of the local property kind which is associated to this property.

◆ getPropertyKindAsString()

DLL_IMPORT_OR_EXPORT std::string RESQML2_NS::AbstractProperty::getPropertyKindAsString ( ) const

Get the title of the property kind of this property

◆ getPropertyKindDescription()

DLL_IMPORT_OR_EXPORT std::string RESQML2_NS::AbstractProperty::getPropertyKindDescription ( ) const

Get the title of the property kind of this property

◆ getPropertyKindParentAsString()

DLL_IMPORT_OR_EXPORT std::string RESQML2_NS::AbstractProperty::getPropertyKindParentAsString ( ) const

Get the title of the parent of the property kind.

◆ getPropertySets()

DLL_IMPORT_OR_EXPORT std::vector<RESQML2_NS::PropertySet *> RESQML2_NS::AbstractProperty::getPropertySets ( ) const

Get all property sets which contain this property

◆ getRealizationIndex()

DLL_IMPORT_OR_EXPORT ULONG64 RESQML2_NS::AbstractProperty::getRealizationIndex ( ) const

Get the realization index of this property. You should have verified before that this property actually has a realization index.

◆ getRepresentation()

DLL_IMPORT_OR_EXPORT class AbstractRepresentation* RESQML2_NS::AbstractProperty::getRepresentation ( ) const

Getter for the representation which supports this instance values.

◆ getRepresentationDor()

gsoap_resqml2_0_1::eml20__DataObjectReference* RESQML2_NS::AbstractProperty::getRepresentationDor ( ) const

Returns: null pointer if no representation is associated to this property. Otherwise return the data object reference of the associated representation.

◆ getTimeIndex()

DLL_IMPORT_OR_EXPORT unsigned int RESQML2_NS::AbstractProperty::getTimeIndex ( ) const

Get the time index of this property in its assocaited time series

◆ getTimeSeries()

DLL_IMPORT_OR_EXPORT TimeSeries* RESQML2_NS::AbstractProperty::getTimeSeries ( ) const

Getter for the time series which is associated to this property.

◆ getTimeSeriesDor()

gsoap_resqml2_0_1::eml20__DataObjectReference* RESQML2_NS::AbstractProperty::getTimeSeriesDor ( ) const

Returns: null pointer if no time series is associated to this property. Otherwise return the data object reference of the associated time series.

◆ getTimestamp()

DLL_IMPORT_OR_EXPORT time_t RESQML2_NS::AbstractProperty::getTimestamp ( ) const

Get the timestamp of this property

Returns: maximum value of unsigned int is returned if no timestamp is allowed.

◆ hasRealizationIndex()

DLL_IMPORT_OR_EXPORT bool RESQML2_NS::AbstractProperty::hasRealizationIndex ( ) const

Check if this property has a realization index.

◆ isAssociatedToOneStandardEnergisticsPropertyKind()

DLL_IMPORT_OR_EXPORT bool RESQML2_NS::AbstractProperty::isAssociatedToOneStandardEnergisticsPropertyKind ( ) const

Indicates if the property kind attached to this property is either from the standard catalog of Energistics or from a local property kind.

◆ loadTargetRelationships()

virtual void RESQML2_NS::AbstractProperty::loadTargetRelationships ( )

protectedvirtual

Read the forward relationships of this dataobject and update the rels of the associated datarepository.

Implements COMMON_NS::AbstractObject.

Reimplemented in RESQML2_0_1_NS::CategoricalProperty, and RESQML2_NS::AbstractValuesProperty.

◆ setLocalPropertyKind()

DLL_IMPORT_OR_EXPORT void RESQML2_NS::AbstractProperty::setLocalPropertyKind ( class PropertyKind * propKind )

Set the property kind of the property to a local one.

◆ setRealizationIndex()

DLL_IMPORT_OR_EXPORT void RESQML2_NS::AbstractProperty::setRealizationIndex ( ULONG64 realizationIndex )

Set the realization index of this property

◆ setRepresentation()

DLL_IMPORT_OR_EXPORT void RESQML2_NS::AbstractProperty::setRepresentation ( class AbstractRepresentation * rep )

Set the representation which is associated to the current property.

◆ setTimeIndex()

DLL_IMPORT_OR_EXPORT void RESQML2_NS::AbstractProperty::setTimeIndex	(	const unsigned int &	timeIndex,
		class TimeSeries *	ts
	)

Set the timestamp of this property by means of an index in a time series

Parameters

[in]	timeIndex	The index of the timestamp of the property in the time series.
[in]	ts	The time series which contains the timestamp of this property.

◆ setTimeSeries()

DLL_IMPORT_OR_EXPORT void RESQML2_NS::AbstractProperty::setTimeSeries ( class TimeSeries * ts )

Set the representation which is associated to the current property.

◆ setTimeStep()

DLL_IMPORT_OR_EXPORT void RESQML2_NS::AbstractProperty::setTimeStep ( const unsigned int & timeStep )

Set the timestep of this property

◆ validate()

bool RESQML2_NS::AbstractProperty::validate ( )

Check if the associated property kind is allowed for this property.

◆ validatePropertyKindAssociation() [1/2]

virtual bool RESQML2_NS::AbstractProperty::validatePropertyKindAssociation ( class PropertyKind * pk )

pure virtual

Check if the associated local property kind is allowed for this property.

Implemented in RESQML2_0_1_NS::ContinuousProperty, RESQML2_0_1_NS::CategoricalProperty, RESQML2_0_1_NS::DiscreteProperty, and RESQML2_0_1_NS::CommentProperty.

◆ validatePropertyKindAssociation() [2/2]

virtual bool RESQML2_NS::AbstractProperty::validatePropertyKindAssociation ( gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind pk )

pure virtual

Check if the associated standard property kind is allowed for this property.

Implemented in RESQML2_0_1_NS::ContinuousProperty, RESQML2_0_1_NS::CategoricalProperty, RESQML2_0_1_NS::DiscreteProperty, and RESQML2_0_1_NS::CommentProperty.

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

C:/Dev/fesapiEnv/fesapi-1.0.0.0/src/resqml2/AbstractProperty.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ AbstractProperty() [1/3]

◆ AbstractProperty() [2/3]

◆ AbstractProperty() [3/3]

◆ ~AbstractProperty()

Member Function Documentation

◆ getAttachmentKind()

◆ getElementCountPerValue()

◆ getEnergisticsPropertyKind()

◆ getLocalPropertyKind()

◆ getLocalPropertyKindDor()

◆ getLocalPropertyKindTitle()

◆ getLocalPropertyKindUuid()

◆ getPropertyKindAsString()

◆ getPropertyKindDescription()

◆ getPropertyKindParentAsString()

◆ getPropertySets()

◆ getRealizationIndex()

◆ getRepresentation()

◆ getRepresentationDor()

◆ getTimeIndex()

◆ getTimeSeries()

◆ getTimeSeriesDor()

◆ getTimestamp()

◆ hasRealizationIndex()

◆ isAssociatedToOneStandardEnergisticsPropertyKind()

◆ loadTargetRelationships()

◆ setLocalPropertyKind()

◆ setRealizationIndex()

◆ setRepresentation()

◆ setTimeIndex()

◆ setTimeSeries()

◆ setTimeStep()

◆ validate()

◆ validatePropertyKindAssociation() [1/2]

◆ validatePropertyKindAssociation() [2/2]