resqml2_0_1::CommentProperty Class Reference

#include <CommentProperty.h>

Inheritance diagram for resqml2_0_1::CommentProperty:

Public Member Functions
	CommentProperty (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
	CommentProperty (resqml2 ::AbstractRepresentation *rep, const std::string &guid, const std::string &title, unsigned int dimension, gsoap_eml2_3::eml23__IndexableElement attachmentKind, gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind energisticsPropertyKind)
	CommentProperty (resqml2 ::AbstractRepresentation *rep, const std::string &guid, const std::string &title, unsigned int dimension, gsoap_eml2_3::eml23__IndexableElement attachmentKind, eml2 ::PropertyKind *localPropKind)
	CommentProperty (gsoap_resqml2_0_1::_resqml20__CommentProperty *fromGsoap)
	~CommentProperty ()=default
std::string	pushBackRefToExistingDataset (eml2 ::AbstractHdfProxy *hdfProxy, const std::string &datasetName="") final
gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind	getEnergisticsPropertyKind () const
bool	validatePropertyKindAssociation (eml2 ::PropertyKind *pk) final
bool	validatePropertyKindAssociation (gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind pk) final
std::string	getXmlNamespace () const final

Static Public Attributes
static const char *	XML_NS

Detailed Description

Proxy class for a comment property.

Constructor & Destructor Documentation

CommentProperty() [1/4]

resqml2_0_1::CommentProperty::CommentProperty ( gsoap_resqml2_0_1::eml20__DataObjectReference * partialObject )

inline

Only to be used in partial transfer context.

Parameters

[in]

partialObject

If non-null, the partial object.

CommentProperty() [2/4]

resqml2_0_1::CommentProperty::CommentProperty	(	resqml2 ::AbstractRepresentation *	rep,
		const std::string &	guid,
		const std::string &	title,
		unsigned int	dimension,
		gsoap_eml2_3::eml23__IndexableElement	attachmentKind,
		gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind	energisticsPropertyKind )

Creates a comment property which is of a well known Energistics property kind.

Exceptions

std::invalid_argument

If rep is null.

Parameters

[in]	rep	The representation on which this property is attached to. It cannot be null.
	guid	The guid to set to the property. If empty then a new guid will be generated.
	title	The title to set to the property. If empty then "unknown" title will be set.
	dimension	The dimension of each value of this property. Dimension is 1 for a scalar property.
	attachmentKind	The topological element on which the property values are attached to.
	energisticsPropertyKind	The property kind of these property values which must be defined in the standard Energistics property type dictionary.

CommentProperty() [3/4]

resqml2_0_1::CommentProperty::CommentProperty	(	resqml2 ::AbstractRepresentation *	rep,
		const std::string &	guid,
		const std::string &	title,
		unsigned int	dimension,
		gsoap_eml2_3::eml23__IndexableElement	attachmentKind,
		eml2 ::PropertyKind *	localPropKind )

Creates a comment property which is of a local property kind.

Exceptions

std::invalid_argument

If rep or localPropKind is null.

Parameters

[in]	rep	The representation on which this property is attached to. It cannot be null.
	guid	The guid to set to the property. If empty then a new guid will be generated.
	title	The title to set to the property. If empty then "unknown" title will be set.
	dimension	The dimension of each value of this property. Dimension is 1 for a scalar property.
	attachmentKind	The topological element on which the property values are attached to.
[in]	localPropKind	The property kind of these property values which must be defined in the EPC document as a local property kind. It cannot be null.

CommentProperty() [4/4]

resqml2_0_1::CommentProperty::CommentProperty ( gsoap_resqml2_0_1::_resqml20__CommentProperty * fromGsoap )

inline

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

Parameters

[in]

fromGsoap

If non-null, the gSOAP instance.

~CommentProperty()

resqml2_0_1::CommentProperty::~CommentProperty ( )

default

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

Member Function Documentation

getEnergisticsPropertyKind()

gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind resqml2_0_1::CommentProperty::getEnergisticsPropertyKind

(

)

const

Gets the Energistics property kind which is associated to this intance

Exceptions

std::invalid_argument

If the property kind of this property is not an Energistics one.

Returns

The Energistics property kind.

getXmlNamespace()

std::string resqml2_0_1::CommentProperty::getXmlNamespace ( ) const

inlinefinal

Get the standard XML namespace for serializing this data object.

Member Data Documentation

XML_NS

const char* resqml2_0_1::CommentProperty::XML_NS

static

The standard 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.9.0.1/src/resqml2_0_1/CommentProperty.h