Fesapi  2.0.0.0
This project provides C++ classes which allow an easy access in import and export to the Energistics standards.
Public Member Functions | List of all members
resqml2_0_1::PropertyKindMapper Class Referencefinal

#include <PropertyKindMapper.h>

Public Member Functions

 PropertyKindMapper (common::DataObjectRepository *repository)
 
 ~PropertyKindMapper ()=default
 
std::string loadMappingFilesFromDirectory (const std::string &directory)
 
std::string getApplicationPropertyKindNameFromResqmlStandardPropertyKindName (gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind resqmlStandardPropertyKindName, const std::string &application) const
 Get the name of a resqml standard property kind into a particular application. More...
 
gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind getResqmlStandardPropertyKindNameFromApplicationPropertyKindName (const std::string &applicationPropertyKindName, const std::string &application) const
 Gets resqml standard property kind name from application property kind name. More...
 
std::string getApplicationPropertyKindNameFromResqmlLocalPropertyKindUuid (const std::string &resqmlLocalPropertyKindUuid, const std::string &application) const
 Gets application property kind name from resqml local property kind uuid. More...
 
std::string getResqmlLocalPropertyKindUuidFromApplicationPropertyKindName (const std::string &applicationPropertyKindName, const std::string &application) const
 
class PropertyKindaddResqmlLocalPropertyKindToEpcDocumentFromApplicationPropertyKindName (const std::string &applicationPropertyKindName, const std::string &application)
 
gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind getPropertyKindParentOfResqmlStandardPropertyKindName (gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind resqmlStandardPropertyKindName) const
 
std::string getDescriptionOfResqmlStandardPropertyKindName (gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind resqmlStandardPropertyKindName) const
 
bool isChildOf (gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind child, gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind parent) const
 
bool isAbstract (gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind resqmlStandardPropertyKindName) const
 

Detailed Description

A property kind mapper.

Constructor & Destructor Documentation

◆ PropertyKindMapper()

resqml2_0_1::PropertyKindMapper::PropertyKindMapper ( common::DataObjectRepository repository)
inline

Constructor

Parameters
[in,out]repositoryIf non-null, the repository.

◆ ~PropertyKindMapper()

resqml2_0_1::PropertyKindMapper::~PropertyKindMapper ( )
default

Destructor

Member Function Documentation

◆ addResqmlLocalPropertyKindToEpcDocumentFromApplicationPropertyKindName()

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

Add a resqml local property type into the EPC document given in constructor if not already present in EPC document. This addition will also add all needed resqml local property type parent into the EPC document.

◆ getApplicationPropertyKindNameFromResqmlLocalPropertyKindUuid()

std::string resqml2_0_1::PropertyKindMapper::getApplicationPropertyKindNameFromResqmlLocalPropertyKindUuid ( const std::string &  resqmlLocalPropertyKindUuid,
const std::string &  application 
) const

Gets application property kind name from resqml local property kind uuid.

Parameters
resqmlLocalPropertyKindUuidThe resqml local property kind uuid.
applicationThe name of the application.
Returns
empty string if not found.

◆ getApplicationPropertyKindNameFromResqmlStandardPropertyKindName()

std::string resqml2_0_1::PropertyKindMapper::getApplicationPropertyKindNameFromResqmlStandardPropertyKindName ( gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind  resqmlStandardPropertyKindName,
const std::string &  application 
) const

Get the name of a resqml standard property kind into a particular application.

Parameters
resqmlStandardPropertyKindNameThe enumerated resqml standard property kind name.
applicationThe name of the application.
Returns
The property kind name in the particular application. Or an empty string if not found.

◆ getDescriptionOfResqmlStandardPropertyKindName()

std::string resqml2_0_1::PropertyKindMapper::getDescriptionOfResqmlStandardPropertyKindName ( gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind  resqmlStandardPropertyKindName) const

Get the description of a Resqml Standard PropertyKind.

Parameters
resqmlStandardPropertyKindNameName of the resqml standard property kind.
Returns
The description of resqml standard property kind name.

◆ getPropertyKindParentOfResqmlStandardPropertyKindName()

gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind resqml2_0_1::PropertyKindMapper::getPropertyKindParentOfResqmlStandardPropertyKindName ( gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind  resqmlStandardPropertyKindName) const

Get the title of the parent of a Resqml Standard PropertyKind.

Parameters
resqmlStandardPropertyKindNameName of the resqml standard property kind.
Returns
The property kind parent of resqml standard property kind name.

◆ getResqmlLocalPropertyKindUuidFromApplicationPropertyKindName()

std::string resqml2_0_1::PropertyKindMapper::getResqmlLocalPropertyKindUuidFromApplicationPropertyKindName ( const std::string &  applicationPropertyKindName,
const std::string &  application 
) const

Gets resqml local property kind uuid from application property kind name

Parameters
applicationPropertyKindNameName of the application property kind.
applicationThe application.
Returns
empty string if not found.

◆ getResqmlStandardPropertyKindNameFromApplicationPropertyKindName()

gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind resqml2_0_1::PropertyKindMapper::getResqmlStandardPropertyKindNameFromApplicationPropertyKindName ( const std::string &  applicationPropertyKindName,
const std::string &  application 
) const

Gets resqml standard property kind name from application property kind name.

Parameters
applicationPropertyKindNameName of the application property kind.
applicationThe name of the application.
Returns
The abstract Resqml root property name if no resqml standard property name have been found for this particular application property kind name.

◆ isAbstract()

bool resqml2_0_1::PropertyKindMapper::isAbstract ( gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind  resqmlStandardPropertyKindName) const

Check if a resqml property kind is an abstract one or not.

Parameters
resqmlStandardPropertyKindNameThe resqml property kind to test.
Returns
True if abstract, false if not.

◆ isChildOf()

bool resqml2_0_1::PropertyKindMapper::isChildOf ( gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind  child,
gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind  parent 
) const

Check if a resqml property kind is a child of another one.

Parameters
childThe resqml property kind which is supposed to be the child.
parentThe resqml property kind which is supposed to be the parent.
Returns
True if child of, false if not.

◆ loadMappingFilesFromDirectory()

std::string resqml2_0_1::PropertyKindMapper::loadMappingFilesFromDirectory ( const std::string &  directory)

Load in maps all the config files present in a particular directory. Config files are all xml files (extension must be .xml). One of this xml file must be named PropertyKindMapping.xml. PropertyKindMapping.xml is the only file to make the mapping with the standard property types. All others xml files must be local property kinds mapping.

Parameters
directoryThe directory must not end with any slash.
Returns
The mapping files from directory.

The documentation for this class was generated from the following file: