#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 (common::DataObjectRepository repo, const std::string &guid, const std::string &title, const std::string &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
time_t	getDeprecationDate () const
tm	getDeprecationDateAsTimeStructure () const
void	setDeprecationDate (time_t deprecationDate)
void	setDeprecationDate (const tm &lastUpdate)
void	loadTargetRelationships () final
std::string	getXmlNamespace () const final
Public Member Functions inherited from eml2::PropertyKind
std::string	getNamingSystem () const
PropertyKind *	getParentPropertyKind () const
void	setParentPropertyKind (PropertyKind *parentPropertyKind)
virtual std::string	getXmlTag () const final
Public Member Functions inherited from common::AbstractObject
bool	isPartial () const
virtual bool	isTopLevelElement () const
std::string	getUuid () const
std::string	getTitle () const
std::string	getEditor () const
time_t	getCreation () const
tm	getCreationAsTimeStructure () const
std::string	getOriginator () const
std::string	getDescription () const
time_t	getLastUpdate () const
tm	getLastUpdateAsTimeStructure () const
std::string	getFormat () const
std::string	getDescriptiveKeywords () const
std::string	getVersion () const
void	setTitle (const std::string &title)
void	setEditor (const std::string &editor)
void	setCreation (time_t creation)
void	setCreation (const tm &creation)
void	setOriginator (const std::string &originator)
void	setDescription (const std::string &description)
void	setLastUpdate (time_t lastUpdate)
void	setLastUpdate (const tm &lastUpdate)
void	setDescriptiveKeywords (const std::string &descriptiveKeywords)
void	setVersion (const std::string &version)
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)
void	serializeIntoStream (std::ostream *stream)
gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *	getEml20GsoapProxy () const
void	setGsoapProxy (gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *gsoapProxy)
gsoap_eml2_3::eml23__AbstractObject *	getEml23GsoapProxy () const
void	setGsoapProxy (gsoap_eml2_3::eml23__AbstractObject *gsoapProxy)
soap *	getGsoapContext () const
int	getGsoapType () const
gsoap_resqml2_0_1::eml20__DataObjectReference *	newResqmlReference () const
gsoap_eml2_3::eml23__DataObjectReference *	newEml23Reference () const
gsoap_resqml2_0_1::resqml20__ContactElementReference *	newContactElementReference2_0_1 () const
gsoap_eml2_3::resqml22__ContactElement *	newContactElementReference2_2 () const
common::DataObjectRepository *	getRepository () const
virtual std::string	getXmlNamespaceVersion () const
virtual std::string	getContentType () const
virtual std::string	getQualifiedType () const
virtual std::string	getPartNameInEpcDocument () const
std::string	serializeIntoString ()
void	addAlias (const std::string &authority, const std::string &title)
uint64_t	getAliasCount () const
std::string	getAliasAuthorityAtIndex (uint64_t index) const
std::string	getAliasTitleAtIndex (uint64_t index) const
std::vector< eml2::Activity * >	getActivitySet () const
uint64_t	getActivityCount () const
eml2::Activity *	getActivity (uint64_t index) const
void	pushBackExtraMetadata (const std::string &key, const std::string &value)
std::unordered_map< std::string, std::string >	getExtraMetadataSet () const
std::vector< std::string >	getExtraMetadata (const std::string &key) const
uint64_t	getExtraMetadataCount () const
std::string	getExtraMetadataKeyAtIndex (uint64_t index) const
std::string	getExtraMetadataStringValueAtIndex (uint64_t index) const
std::string	buildEtp12Uri () const
void	setUriSource (const std::string &uriSource)
const std::string &	getUriSource () const
std::string	getEpcSourceFolder () const
void	changeToPartialObject ()

Static Public Attributes
static constexpr char const *	XML_NS = "eml23"
Static Public Attributes inherited from eml2::PropertyKind
static constexpr char const *	XML_TAG = "PropertyKind"

Additional Inherited Members
Public Types inherited from common::AbstractObject
enum class	numericalDatatypeEnum { UNKNOWN = 0 , DOUBLE = 1 , FLOAT = 2 , INT64 = 3 , UINT64 = 4 , INT32 = 5 , UINT32 = 6 , INT16 = 7 , UINT16 = 8 , INT8 = 9 , UINT8 = 10 }
Static Public Member Functions inherited from common::AbstractObject
static void	setFormat (const std::string &vendor, const std::string &applicationName, const std::string &applicationVersionNumber)

Detailed Description

A property kind.

Constructor & Destructor Documentation

◆ PropertyKind() [1/4]

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/4]

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) Indicates 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/4]

eml2_3::PropertyKind::PropertyKind	(	common::DataObjectRepository *	repo,
		const std::string &	guid,
		const std::string &	title,
		const std::string &	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 or another dictionary.
	isAbstract	(Optional) Indicates 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() [4/4]

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

virtualdefault

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

Reimplemented from eml2::PropertyKind.

Member Function Documentation

◆ getBaseUomAsString()

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

finalvirtual

Please do not use: not implemented yet.

Implements eml2::PropertyKind.

◆ getDeprecationDate()

time_t eml2_3::PropertyKind::getDeprecationDate ( ) const

Gets the date and time at which this property dictionary entry must no longer be used. Files generated before this date would have used this entry so it is left here for reference.

Exceptions

std::invalid_argument If this instance is actually a partial object.

Returns: deprecationDate The deprecation date and time of this data object.

◆ getDeprecationDateAsTimeStructure()

tm eml2_3::PropertyKind::getDeprecationDateAsTimeStructure ( ) const

Same as getDeprecationDate(). Please use this method if you want to read some dates out of the range of time_t

Exceptions

std::invalid_argument If this instance is actually a partial object.

Returns: The deprecation date and time of the data object.

◆ getParentAsString()

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

finalvirtual

Get the title of the parent property kind

Returns: The title of the parent property kind.

Implements eml2::PropertyKind.

◆ getParentPropertyKindDor()

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

finalvirtual

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.

Implements eml2::PropertyKind.

◆ getXmlNamespace()

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

inlinefinalvirtual

Get the standard XML namespace for serializing this data object.

Implements common::AbstractObject.

◆ isAbstract()

bool eml2_3::PropertyKind::isAbstract ( ) const

virtual

Query if this object is abstract

Returns: True if abstract, false if not.

Implements eml2::PropertyKind.

◆ isParentPartial()

bool eml2_3::PropertyKind::isParentPartial ( ) const

virtual

Query if this object is parent partial

Returns: True if parent partial, false if not.

Implements eml2::PropertyKind.

◆ loadTargetRelationships()

void eml2_3::PropertyKind::loadTargetRelationships ( )

finalvirtual

Loads target relationships

Implements common::AbstractObject.

◆ setDeprecationDate() [1/2]

void eml2_3::PropertyKind::setDeprecationDate ( const tm & lastUpdate )

Same as setDeprecationDate(). Please use this method if you want to read some dates out of the range of time_t

Parameters

lastUpdate The deprecation date and time to set to this data object.

◆ setDeprecationDate() [2/2]

void eml2_3::PropertyKind::setDeprecationDate ( time_t deprecationDate )

Sets the date and time at which this property dictionary entry must no longer be used. Files generated before this date would have used this entry so it is left here for reference.

Exceptions

std::invalid_argument If this instance is actually a partial object.

Parameters

deprecationDate The deprecation date and time to set to this data object.

Member Data Documentation

◆ XML_NS

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/phili/dev/fesapi/fesapi-2.13.0.0/src/eml2_3/PropertyKind.h

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PropertyKind() [1/4]

◆ PropertyKind() [2/4]

◆ PropertyKind() [3/4]

◆ PropertyKind() [4/4]

◆ ~PropertyKind()

Member Function Documentation

◆ getBaseUomAsString()

◆ getDeprecationDate()

◆ getDeprecationDateAsTimeStructure()

◆ getParentAsString()

◆ getParentPropertyKindDor()

◆ getXmlNamespace()

◆ isAbstract()

◆ isParentPartial()

◆ loadTargetRelationships()

◆ setDeprecationDate() [1/2]

◆ setDeprecationDate() [2/2]

Member Data Documentation

◆ XML_NS