Question on Property Kind Classification in RESQML

[Pamrapalip1026]

Hi Philippe,

I hope you’re doing well!

In RESQML, there are three standard property kinds:

1. Continuous
2. Discrete
3. Categorical

I want to determine programmatically which standard property kind (Continuous, Discrete, or Categorical) a given property kind (e.g., X) belongs to. For example, density should be identified as a child of Continuous.

Looking forward to your thoughts.

[philippeVerney]

Hi @Pamrapalip1026
I am doing well and hope the same about you.

First of all, you need a DataObjectRepository created with the resource directory where the property kinds are defined such as the "ressources" directory of the fesapi project
It is necessary in order to load all information about property kinds.

fesapi/src/common/DataObjectRepository.h

Line 189 in 8ad484b

DLL_IMPORT_OR_EXPORT explicit DataObjectRepository(const std::string& resourceDirectory);

Then, you have two different property kinds in RESQML:

• an enum of standard property kind ( the one you look to be mostly interested in)
• a class property kind for more exotic property kinds

If you want to check an enum of standard property kind:

• Get the property kind mapper of your DataObjectRepository

  fesapi/src/common/DataObjectRepository.h

  Line 3608 in 8ad484b

  DLL_IMPORT_OR_EXPORT RESQML2_0_1_NS::PropertyKindMapper* getPropertyKindMapper() const { return propertyKindMapper.get(); }

• Call the isChildOf from your PropertyKindMapper

  fesapi/src/resqml2_0_1/PropertyKindMapper.h

  Line 128 in 8ad484b

  DLL_IMPORT_OR_EXPORT bool isChildOf(gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind child, gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind parent) const;

If you want to check a class property kind instance:

• Just directly call isChildOf from this instance

  fesapi/src/resqml2_0_1/PropertyKind.h

  Line 133 in 8ad484b

  DLL_IMPORT_OR_EXPORT bool isChildOf(gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind standardPropKind) const;

Finally, FESAPI already provides some methods to validate a property according to its kind. It is even automatically done at epc deserialization time if your DataObjectRepository has been created with a correct resource directory. The called mehod is

fesapi/src/resqml2/AbstractProperty.h

Lines 399 to 404 in 8ad484b

	/**
	* Checks if the associated property kind is allowed for this property.
	*
	* @returns True if it is allowed, false if it is not.
	*/
	bool validate();

which calls in cascade one of this method

fesapi/src/resqml2/AbstractProperty.h

Lines 381 to 397 in 8ad484b

	/**
	* Checks if it is allowed to associate a given property kind to this property.
	*
	* @param [in] pk The local property kind to check.
	*
	* @returns True if it is allowed, false if it is not.
	*/
	virtual bool validatePropertyKindAssociation(EML2_NS::PropertyKind* pk) = 0;
	/**
	* Checks if it is allowed to associate a given standard Energistics property kind to this property.
	*
	* @param pk The standard Energistics property kind to check.
	*
	* @returns True if it is allowed, false if it is not.
	*/
	virtual bool validatePropertyKindAssociation(gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind pk) = 0;