resqml2::AbstractProperty Class Reference

Inheritance diagram for resqml2::AbstractProperty:

Public Member Functions
	AbstractProperty (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
	AbstractProperty ()
	AbstractProperty (gsoap_resqml2_0_1::resqml2__AbstractProperty *fromGsoap)
virtual	~AbstractProperty ()
void	setRepresentation (class AbstractRepresentation *rep)
gsoap_resqml2_0_1::eml20__DataObjectReference *	getRepresentationDor () const
class AbstractRepresentation *	getRepresentation () const
std::string	getRepresentationUuid () const
std::string	getRepresentationTitle () const
std::string	getRepresentationContentType () const
void	setTimeSeries (class TimeSeries *ts)
TimeSeries *	getTimeSeries () const
gsoap_resqml2_0_1::eml20__DataObjectReference *	getTimeSeriesDor () const
std::string	getTimeSeriesUuid () const
std::string	getTimeSeriesTitle () const
void	setTimeIndex (const unsigned int &timeIndex, class TimeSeries *ts)
void	setTimeStep (const unsigned int &timeStep)
time_t	getTimestamp () const
unsigned int	getTimeIndex () const
void	setHdfProxy (common::AbstractHdfProxy *proxy)
common::AbstractHdfProxy *	getHdfProxy () const
std::string	getHdfProxyUuid () const
unsigned int	getElementCountPerValue () const
gsoap_resqml2_0_1::resqml2__IndexableElements	getAttachmentKind () const
bool	isAssociatedToOneStandardEnergisticsPropertyKind () const
std::string	getPropertyKindDescription () const
std::string	getPropertyKindAsString () const
std::string	getPropertyKindParentAsString () const
gsoap_resqml2_0_1::resqml2__ResqmlPropertyKind	getEnergisticsPropertyKind () const
void	setLocalPropertyKind (class PropertyKind *propKind)
gsoap_resqml2_0_1::eml20__DataObjectReference *	getLocalPropertyKindDor () const
std::string	getLocalPropertyKindUuid () const
std::string	getLocalPropertyKindTitle () const
class PropertyKind *	getLocalPropertyKind () const
virtual bool	validatePropertyKindAssociation (class PropertyKind *pk)=0
virtual bool	validatePropertyKindAssociation (const gsoap_resqml2_0_1::resqml2__ResqmlPropertyKind &pk)=0
Public Member Functions inherited from common::AbstractObject
bool	isPartial () const
std::string	getUuid () const
std::string	getTitle () const
std::string	getEditor () const
time_t	getCreation () const
std::string	getOriginator () const
std::string	getDescription () const
time_t	getLastUpdate () const
std::string	getFormat () const
std::string	getDescriptiveKeywords () const
void	setTitle (const std::string &title)
void	setEditor (const std::string &editor)
void	setCreation (const time_t &creation)
void	setOriginator (const std::string &originator)
void	setDescription (const std::string &description)
void	setLastUpdate (const time_t &lastUpdate)
void	setFormat (const std::string &format)
void	setDescriptiveKeywords (const std::string &descriptiveKeywords)
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::EpcDocument *	getEpcDocument () const
virtual std::string	getXmlNamespace () const
virtual std::string	getXmlTag () const =0
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::Activity * > &	getActivitySet () const
unsigned int	getActivityCount () const
resqml2::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

Protected Member Functions
void	setXmlRepresentation (class AbstractRepresentation *rep)
void	setXmlTimeSeries (TimeSeries *ts)
void	setXmlLocalPropertyKind (class PropertyKind *propKind)
virtual std::vector< epc::Relationship >	getAllEpcRelationships () const
virtual void	importRelationshipSetFromEpc (common::EpcDocument *epcDoc)
Protected Member Functions inherited from common::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
class AbstractLocal3dCrs *	local3dCrs
Protected Attributes inherited from common::AbstractObject
gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *	gsoapProxy2_0_1
gsoap_eml2_1::eml21__AbstractObject *	gsoapProxy2_1
common::EpcDocument *	epcDocument
std::vector< resqml2::Activity * >	activitySet
bool	updateXml

Additional Inherited Members
Protected Types inherited from common::AbstractObject
enum	EmlVersion { TWO_DOT_ZERO = 0, TWO_DOT_ONE = 1 }
Static Protected Member Functions inherited from common::AbstractObject
static void	addActivityToResqmlObject (resqml2::Activity *activity, AbstractObject *resqmlObject)

Constructor & Destructor Documentation

resqml2::AbstractProperty::AbstractProperty ( gsoap_resqml2_0_1::eml20__DataObjectReference *  partialObject )

inline

Only to be used in partial transfer context

resqml2::AbstractProperty::AbstractProperty ( )

inline

Default constructor Set the relationship with an AbstractRepresentation and a local property type.

resqml2::AbstractProperty::AbstractProperty ( gsoap_resqml2_0_1::resqml2__AbstractProperty *  fromGsoap )

inline

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

virtual resqml2::AbstractProperty::~AbstractProperty ( )

inlinevirtual

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

Member Function Documentation

vector< Relationship > AbstractProperty::getAllEpcRelationships ( ) const

protectedvirtual

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

Implements common::AbstractObject.

Reimplemented in resqml2_0_1::CategoricalProperty.

gsoap_resqml2_0_1::resqml2__IndexableElements AbstractProperty::getAttachmentKind

(

)

const

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

unsigned int 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, the it should be more than one. It is not possible to have some tensor property values (more dimension than a vector).

gsoap_resqml2_0_1::resqml2__ResqmlPropertyKind AbstractProperty::getEnergisticsPropertyKind

(

)

const

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

common::AbstractHdfProxy * AbstractProperty::getHdfProxy

(

)

const

Getter for the hdf proxy which stores this instance values.

PropertyKind * 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.

gsoap_resqml2_0_1::eml20__DataObjectReference * 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.

std::string AbstractProperty::getLocalPropertyKindTitle

(

)

const

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

std::string AbstractProperty::getLocalPropertyKindUuid

(

)

const

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

std::string AbstractProperty::getPropertyKindAsString

(

)

const

Get the title of the property kind of this property

std::string AbstractProperty::getPropertyKindDescription

(

)

const

Get the title of the property kind of this property

std::string AbstractProperty::getPropertyKindParentAsString

(

)

const

Get the title of the parent of the property kind.

AbstractRepresentation * AbstractProperty::getRepresentation

(

)

const

Getter for the representation which supports this instance values.

gsoap_resqml2_0_1::eml20__DataObjectReference * AbstractProperty::getRepresentationDor

(

)

const

Returns

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

unsigned int AbstractProperty::getTimeIndex

(

)

const

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

TimeSeries * AbstractProperty::getTimeSeries

(

)

const

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

gsoap_resqml2_0_1::eml20__DataObjectReference * 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.

time_t AbstractProperty::getTimestamp

(

)

const

Get the timestamp of this property

Returns

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

void AbstractProperty::importRelationshipSetFromEpc ( common::EpcDocument *  epcDoc )

protectedvirtual

Resolve all relationships of the object in an epc document

Implements common::AbstractObject.

Reimplemented in resqml2_0_1::CategoricalProperty.

bool 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.

void AbstractProperty::setHdfProxy

(

common::AbstractHdfProxy *

proxy

)

Set the Hdf Proxy where the numerical values are stored.

void AbstractProperty::setLocalPropertyKind

(

class PropertyKind *

propKind

)

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

void AbstractProperty::setRepresentation

(

class AbstractRepresentation *

rep

)

Set the representation which is associated to the current property.

void 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.

void AbstractProperty::setTimeSeries

(

class TimeSeries *

ts

)

Set the representation which is associated to the current property.

void AbstractProperty::setTimeStep

(

const unsigned int &

timeStep

)

Set the timestep of this property

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

pure virtual

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

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

virtual bool resqml2::AbstractProperty::validatePropertyKindAssociation ( const gsoap_resqml2_0_1::resqml2__ResqmlPropertyKind &  pk )

pure virtual

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

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

---

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

• C:/Users/Philippe/dev/fesapiEnv/fesapi/src/resqml2/AbstractProperty.h
• C:/Users/Philippe/dev/fesapiEnv/fesapi/src/resqml2/AbstractProperty.cpp