#include <PropertyKind.h>

Inheritance diagram for resqml2_0_1::PropertyKind:

Public Member Functions
	PropertyKind (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)

	PropertyKind (common ::DataObjectRepository *repo, const std::string &guid, const std::string &title, const std::string &namingSystem, gsoap_resqml2_0_1::resqml20__ResqmlUom uom, gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind parentEnergisticsPropertyKind)

	PropertyKind (const std::string &guid, const std::string &title, const std::string &namingSystem, gsoap_resqml2_0_1::resqml20__ResqmlUom uom, eml2 ::PropertyKind *parentPropType)
	Creates a local property type which uses a standard uom and which derives from another local property type.

	PropertyKind (common ::DataObjectRepository *repo, const std::string &guid, const std::string &title, const std::string &namingSystem, const std::string &nonStandardUom, gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind parentEnergisticsPropertyKind)
	Creates a local property type which uses a non standard uom and which derives from a standard Energistics property type.

	PropertyKind (const std::string &guid, const std::string &title, const std::string &namingSystem, const std::string &nonStandardUom, eml2 ::PropertyKind *parentPropType)
	Creates a local property type which uses a non standard uom which derives from another local property type.

	PropertyKind (gsoap_resqml2_0_1::_resqml20__PropertyKind *fromGsoap)

	~PropertyKind ()=default

bool	isChildOf (gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind standardPropKind) const

bool	isAbstract () const final

bool	isParentPartial () const final

std::string	getBaseUomAsString () const final

std::string	getParentAsString () const final

common::DataObjectReference	getParentPropertyKindDor () const final

bool	isParentAnEnergisticsPropertyKind () const

gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind	getParentEnergisticsPropertyKind () const

void	loadTargetRelationships () final

std::string	getXmlNamespace () const final

Static Public Attributes
static const char *	XML_NS

Friends
resqml2_0_1::PropertyKind *	PropertyKindMapper::addResqmlLocalPropertyKindToEpcDocumentFromApplicationPropertyKindName (const std::string &applicationPropertyKindName, const std::string &application)

Detailed Description

A property kind.

Constructor & Destructor Documentation

◆ PropertyKind() [1/6]

resqml2_0_1::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/6]

resqml2_0_1::PropertyKind::PropertyKind	(	common ::DataObjectRepository *	repo,
		const std::string &	guid,
		const std::string &	title,
		const std::string &	namingSystem,
		gsoap_resqml2_0_1::resqml20__ResqmlUom	uom,
		gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind	parentEnergisticsPropertyKind )

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.
	namingSystem	The name of the dictionary within which the property is unique.
	uom	The unit of measure of the property type.
	parentEnergisticsPropertyKind	The name of the parent property type in the Energistics property dictionary.

◆ PropertyKind() [3/6]

resqml2_0_1::PropertyKind::PropertyKind	(	const std::string &	guid,
		const std::string &	title,
		const std::string &	namingSystem,
		gsoap_resqml2_0_1::resqml20__ResqmlUom	uom,
		eml2 ::PropertyKind *	parentPropType )

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

Exceptions

std::invalid_argument If parentPropType == nullptr.

Parameters

	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.
	namingSystem	The name of the dictionary within which the property is unique.
	uom	The unit of measure of the property type.
[in,out]	parentPropType	The local parent property type in the EPC document.

◆ PropertyKind() [4/6]

resqml2_0_1::PropertyKind::PropertyKind	(	common ::DataObjectRepository *	repo,
		const std::string &	guid,
		const std::string &	title,
		const std::string &	namingSystem,
		const std::string &	nonStandardUom,
		gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind	parentEnergisticsPropertyKind )

Creates a local property type which uses a non 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.
	namingSystem	The name of the dictionary within which the property is unique.
	nonStandardUom	The non standard uom of the values.
	parentEnergisticsPropertyKind	The name of the parent property type in the Energistics property dictionary.

◆ PropertyKind() [5/6]

resqml2_0_1::PropertyKind::PropertyKind	(	const std::string &	guid,
		const std::string &	title,
		const std::string &	namingSystem,
		const std::string &	nonStandardUom,
		eml2 ::PropertyKind *	parentPropType )

Creates a local property type which uses a non standard uom which derives from another local property type.

Parameters

	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.
	namingSystem	The name of the dictionary within which the property is unique.
	nonStandardUom	The non standard uom of the values.
[in,out]	parentPropType	The local parent property type in the EPC document.

◆ PropertyKind() [6/6]

resqml2_0_1::PropertyKind::PropertyKind ( gsoap_resqml2_0_1::_resqml20__PropertyKind * fromGsoap )

inline

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

Parameters

[in,out] fromGsoap If non-null, from gsoap.

◆ ~PropertyKind()

resqml2_0_1::PropertyKind::~PropertyKind ( )

default

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

Member Function Documentation

◆ getBaseUomAsString()

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

final

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.

◆ getParentAsString()

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

final

Get the title of the parent property kind

Returns: The title of the parent property kind.

◆ getParentEnergisticsPropertyKind()

gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind resqml2_0_1::PropertyKind::getParentEnergisticsPropertyKind ( ) const

Gets the standard Energistics parent property kind

Exceptions

std::invalid_argument If the parent property kind is not an Energistics one.

Returns: The standard Energistics parent property kind.

◆ getParentPropertyKindDor()

common::DataObjectReference resqml2_0_1::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 resqml2_0_1::PropertyKind::getXmlNamespace ( ) const

inlinefinal

Get the standard XML namespace for serializing this data object.

◆ isAbstract()

bool resqml2_0_1::PropertyKind::isAbstract ( ) const

final

Query if this object is abstract

Returns: True if abstract, false if not.

◆ isChildOf()

bool resqml2_0_1::PropertyKind::isChildOf ( gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind standardPropKind ) const

Is child of the given standard property kind

Parameters

standardPropKind The standard property kind.

Returns: True if child of, false if not.

◆ isParentAnEnergisticsPropertyKind()

bool resqml2_0_1::PropertyKind::isParentAnEnergisticsPropertyKind ( ) const

Indicates if the parent property kind is either from the standard catalog of Energistics or from another local property kind

Returns: True if the parent is a standard Energistics property kind, false if not.

◆ isParentPartial()

bool resqml2_0_1::PropertyKind::isParentPartial ( ) const

final

Query if this object is parent partial

Returns: True if parent partial, false if not.

◆ loadTargetRelationships()

void resqml2_0_1::PropertyKind::loadTargetRelationships ( )

final

Loads target relationships

Friends And Related Symbol Documentation

◆ PropertyKindMapper::addResqmlLocalPropertyKindToEpcDocumentFromApplicationPropertyKindName

resqml2_0_1::PropertyKind * PropertyKindMapper::addResqmlLocalPropertyKindToEpcDocumentFromApplicationPropertyKindName	(	const std::string &	applicationPropertyKindName,
		const std::string &	application )

friend

Adds a resqml local property kind to epc document from application property kind name to 'application'

Parameters

applicationPropertyKindName	Name of the application property kind.
application	The application.

Returns: Null if it fails, else a pointer to a RESQML2_0_1_NS::PropertyKind.

Member Data Documentation

◆ XML_NS

const char* resqml2_0_1::PropertyKind::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/PropertyKind.h

Public Member Functions

Static Public Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ PropertyKind() [1/6]

◆ PropertyKind() [2/6]

◆ PropertyKind() [3/6]

◆ PropertyKind() [4/6]

◆ PropertyKind() [5/6]

◆ PropertyKind() [6/6]

◆ ~PropertyKind()

Member Function Documentation

◆ getBaseUomAsString()

◆ getParentAsString()

◆ getParentEnergisticsPropertyKind()

◆ getParentPropertyKindDor()

◆ getXmlNamespace()

◆ isAbstract()

◆ isChildOf()

◆ isParentAnEnergisticsPropertyKind()

◆ isParentPartial()

◆ loadTargetRelationships()

Friends And Related Symbol Documentation

◆ PropertyKindMapper::addResqmlLocalPropertyKindToEpcDocumentFromApplicationPropertyKindName

Member Data Documentation

◆ XML_NS