eml2_3::PropertyKind Class Reference

#include <PropertyKind.h>

Inheritance diagram for eml2_3::PropertyKind:

Public Member Functions
	PropertyKind (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
	PropertyKind (common ::DataObjectRepository *repo, const std::string &guid, const std::string &title, gsoap_eml2_3::eml23__QuantityClassKind quantityClass, bool isAbstract=false, eml2 ::PropertyKind *parentPropertyKind=nullptr)
	PropertyKind (gsoap_eml2_3::eml23__PropertyKind *fromGsoap)
	~PropertyKind ()=default
bool	isAbstract () const
bool	isParentPartial () const
std::string	getBaseUomAsString () const final
std::string	getParentAsString () const final
common::DataObjectReference	getParentPropertyKindDor () const final
void	loadTargetRelationships () final
std::string	getXmlNamespace () const final

Static Public Attributes
static constexpr char const *	XML_NS = "eml23"

Detailed Description

A property kind.

Constructor & Destructor Documentation

PropertyKind() [1/3]

eml2_3::PropertyKind::PropertyKind ( gsoap_resqml2_0_1::eml20__DataObjectReference * partialObject )

inline

Only to be used in partial transfer context

Parameters

[in,out]

partialObject

If non-null, the partial object.

PropertyKind() [2/3]

eml2_3::PropertyKind::PropertyKind	(	common ::DataObjectRepository *	repo,
		const std::string &	guid,
		const std::string &	title,
		gsoap_eml2_3::eml23__QuantityClassKind	quantityClass,
		bool	isAbstract = false,
		eml2 ::PropertyKind *	parentPropertyKind = nullptr )

Creates a local property type which uses a standard uom and which derives from a standard Energistics property type.

Parameters

[in,out]	repo	The repo where the underlying gsoap proxy is going to be created.
	guid	The guid to set to the local 3d crs. If empty then a new guid will be generated.
	title	The title of the instance.
	quantityClass	The quantity class of this property kind. It wil constrain its allowed uom collection. The enum comes from Energistics Unit Of Measure.
	isAbstract	(Optional) Inidcates if this property kind can be used directly by a property or not.
[in,out]	parentPropertyKind	(Optional) The parent property kind if this property kind. By default, it is the Energistics root property kind called "property".

PropertyKind() [3/3]

eml2_3::PropertyKind::PropertyKind ( gsoap_eml2_3::eml23__PropertyKind * fromGsoap )

inline

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

Parameters

[in,out]

fromGsoap

If non-null, from gsoap.

~PropertyKind()

eml2_3::PropertyKind::~PropertyKind ( )

default

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

Member Function Documentation

getBaseUomAsString()

std::string eml2_3::PropertyKind::getBaseUomAsString ( ) const

final

Please do not use: not implemented yet.

getParentAsString()

std::string eml2_3::PropertyKind::getParentAsString ( ) const

final

Get the title of the parent property kind

Returns

The title of the parent property kind.

getParentPropertyKindDor()

common::DataObjectReference eml2_3::PropertyKind::getParentPropertyKindDor ( ) const

final

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.

getXmlNamespace()

std::string eml2_3::PropertyKind::getXmlNamespace ( ) const

inlinefinal

Get the standard XML namespace for serializing this data object.

isAbstract()

bool eml2_3::PropertyKind::isAbstract

(

)

const

Query if this object is abstract

Returns

True if abstract, false if not.

isParentPartial()

bool eml2_3::PropertyKind::isParentPartial

(

)

const

Query if this object is parent partial

Returns

True if parent partial, false if not.

loadTargetRelationships()

void eml2_3::PropertyKind::loadTargetRelationships ( )

final

Loads target relationships

Member Data Documentation

XML_NS

constexpr char const* eml2_3::PropertyKind::XML_NS = "eml23"

staticconstexpr

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/eml2_3/PropertyKind.h