Property kinds carry the semantics of property values. They are used to identify if the values are, for example, representing porosity, length, stress tensor, etc. Energistics provides a list of standard property kind that represent the basis for the commonly used properties in the E&P subsurface workflow.
More...
#include <PropertyKind.h>
|
| static constexpr char const * | XML_TAG = "PropertyKind" |
| |
Property kinds carry the semantics of property values. They are used to identify if the values are, for example, representing porosity, length, stress tensor, etc. Energistics provides a list of standard property kind that represent the basis for the commonly used properties in the E&P subsurface workflow.
◆ ~PropertyKind()
| virtual eml2::PropertyKind::~PropertyKind |
( |
| ) |
|
|
virtualdefault |
Destructor does nothing since the memory is managed by the gSOAP context
◆ getBaseUomAsString()
| virtual std::string eml2::PropertyKind::getBaseUomAsString |
( |
| ) |
const |
|
pure virtual |
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.
◆ getNamingSystem()
| std::string eml2::PropertyKind::getNamingSystem |
( |
| ) |
const |
Gets (in read only mode) the naming system of this property type. It is the name of the dictionary within which the property is unique. This also defines the name of the controlling authority. It is an URN of the form urn:x-resqml:domainOrEmail:dictionaryName
- Returns
- The naming system.
◆ getParentAsString()
| virtual std::string eml2::PropertyKind::getParentAsString |
( |
| ) |
const |
|
pure virtual |
Get the title of the parent property kind
- Returns
- The title of the parent property kind.
◆ getParentPropertyKind()
| PropertyKind * eml2::PropertyKind::getParentPropertyKind |
( |
| ) |
const |
Gets 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 parent local property kind.
◆ getParentPropertyKindDor()
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.
◆ isAbstract()
| virtual bool eml2::PropertyKind::isAbstract |
( |
| ) |
const |
|
pure virtual |
Checks if this property kind is abstract or not
- Returns
- True if abstract, false if not.
◆ isParentPartial()
| virtual bool eml2::PropertyKind::isParentPartial |
( |
| ) |
const |
|
pure virtual |
Checks if this property kind is partial or if one of its parent is partial.
- Returns
- True if this property kind or one of its parent is partial, false if not.
◆ setParentPropertyKind()
| void eml2::PropertyKind::setParentPropertyKind |
( |
PropertyKind * | parentPropertyKind | ) |
|
Sets the parent property kind of this property kind
- Exceptions
-
| std::invalid_argument | If parentPropertyKind is null. |
- Parameters
-
| [in] | parentPropertyKind | The parent property kind to set to this property kind. |
◆ XML_TAG
| constexpr char const* eml2::PropertyKind::XML_TAG = "PropertyKind" |
|
staticconstexpr |
The standard XML tag without 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/PropertyKind.h
