Fesapi  0.13.0.0
This project provides C++ classes which allow an easy access in import and export to the Energistics standards.
Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Friends | List of all members
RESQML2_NS::PropertyKind Class Referenceabstract
Inheritance diagram for RESQML2_NS::PropertyKind:
COMMON_NS::AbstractObject RESQML2_0_1_NS::PropertyKind

Public Member Functions

virtual ~PropertyKind ()
 
const std::string & getNamingSystem () const
 
const gsoap_resqml2_0_1::resqml2__ResqmlUom & getUom () const
 
std::string getUomAsString () const
 
std::string getParentAsString () const
 
bool isParentAnEnergisticsPropertyKind () const
 
gsoap_resqml2_0_1::resqml2__ResqmlPropertyKind getParentEnergisticsPropertyKind () const
 
gsoap_resqml2_0_1::eml20__DataObjectReference * getParentLocalPropertyKindDor () const
 
std::string getParentLocalPropertyKindUuid () const
 
std::string getParentLocalPropertyKindTitle () const
 
PropertyKind * getParentLocalPropertyKind () const
 
void setParentPropertyKind (PropertyKind *parentPropertyKind)
 
virtual std::string getXmlTag () const
 
void addProperty (class AbstractProperty *repVal)
 
virtual bool isChildOf (gsoap_resqml2_0_1::resqml2__ResqmlPropertyKind standardPropKind) const =0
 
virtual bool isAbstract () const =0
 
- Public Member Functions inherited from COMMON_NS::AbstractObject
bool isPartial () 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 getVersionString () const
 
void setTitle (const std::string &title)
 
void setEditor (const std::string &editor)
 
void setCreation (const time_t &creation)
 
void setCreation (const tm &creation)
 
void setOriginator (const std::string &originator)
 
void setDescription (const std::string &description)
 
void setLastUpdate (const time_t &lastUpdate)
 
void setLastUpdate (const tm &lastUpdate)
 
void setFormat (const std::string &format)
 
void setDescriptiveKeywords (const std::string &descriptiveKeywords)
 
void setVersionString (const std::string &versionString)
 
void setMetadata (const std::string &title, const std::string &editor, const time_t &creation, const std::string &originator, const std::string &description, const time_t &lastUpdate, const std::string &format, const std::string &descriptiveKeywords)
 
void serializeIntoStream (std::ostream *stream)
 
gsoap_resqml2_0_1::eml20__AbstractCitedDataObject * getGsoapProxy () const
 
soap * getGsoapContext () const
 
int getGsoapType () const
 
gsoap_resqml2_0_1::eml20__DataObjectReference * newResqmlReference () const
 
gsoap_eml2_1::eml21__DataObjectReference * newEmlReference () const
 
gsoap_resqml2_0_1::resqml2__ContactElementReference * newResqmlContactElementReference () const
 
COMMON_NS::EpcDocument * getEpcDocument () const
 
virtual std::string getXmlNamespace () const
 
virtual std::string getResqmlVersion () const
 
virtual std::string getContentType () const
 
virtual std::string getPartNameInEpcDocument () const
 
std::string serializeIntoString ()
 
void addAlias (const std::string &authority, const std::string &title)
 
unsigned int getAliasCount () const
 
std::string getAliasAuthorityAtIndex (const unsigned int &index) const
 
std::string getAliasTitleAtIndex (const unsigned int &index) const
 
const std::vector< RESQML2_NS::Activity * > & getActivitySet () const
 
unsigned int getActivityCount () const
 
RESQML2_NS::Activity * getActivity (const unsigned int &index) const
 
void pushBackExtraMetadata (const std::string &key, const std::string &value)
 
std::tr1::unordered_map< std::string, std::string > getExtraMetadataSet () const
 
std::vector< std::string > getExtraMetadata (const std::string &key) const
 
unsigned int getExtraMetadataCount () const
 
std::string getExtraMetadataKeyAtIndex (const unsigned int &index) const
 
std::string getExtraMetadataStringValueAtIndex (const unsigned int &index) const
 

Static Public Attributes

static const char * XML_TAG = "PropertyKind"
 

Protected Member Functions

 PropertyKind ()
 
 PropertyKind (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
 
 PropertyKind (gsoap_resqml2_0_1::_resqml2__PropertyKind *fromGsoap)
 
virtual void setXmlParentPropertyKind (PropertyKind *parentPropertyKind)=0
 
std::vector< epc::Relationship > getAllEpcRelationships () const
 
void importRelationshipSetFromEpc (COMMON_NS::EpcDocument *epcDoc)
 
- Protected Member Functions inherited from COMMON_NS::AbstractObject
 AbstractObject ()
 Indicate whether methods update the XML (gSoap) or only the C++ classes of the API.
 
 AbstractObject (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
 
 AbstractObject (gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *proxy)
 
 AbstractObject (gsoap_eml2_1::eml21__AbstractObject *proxy)
 
void initMandatoryMetadata ()
 
void setMetadata (const std::string &guid, const std::string &title, const std::string &editor, const time_t &creation, const std::string &originator, const std::string &description, const time_t &lastUpdate, const std::string &format, const std::string &descriptiveKeywords)
 
void cannotBePartial () const
 
void changeToPartialObject ()
 

Protected Attributes

std::vector< class AbstractProperty * > propertySet
 
std::vector< PropertyKind * > childPropertyKind
 
- Protected Attributes inherited from COMMON_NS::AbstractObject
gsoap_resqml2_0_1::eml20__AbstractCitedDataObject * gsoapProxy2_0_1
 
gsoap_eml2_1::eml21__AbstractObject * gsoapProxy2_1
 
COMMON_NS::EpcDocument * epcDocument
 
std::vector< RESQML2_NS::Activity * > activitySet
 
bool updateXml
 

Friends

void AbstractProperty::setLocalPropertyKind (PropertyKind *propKind)
 

Additional Inherited Members

- Protected Types inherited from COMMON_NS::AbstractObject
enum  EmlVersion { TWO_DOT_ZERO = 0, TWO_DOT_ONE = 1 }
 
- Static Protected Member Functions inherited from COMMON_NS::AbstractObject
static void addActivityToResqmlObject (RESQML2_NS::Activity *activity, AbstractObject *resqmlObject)
 

Constructor & Destructor Documentation

RESQML2_NS::PropertyKind::PropertyKind ( )
inlineprotected

Default constructor does nothing

RESQML2_NS::PropertyKind::PropertyKind ( gsoap_resqml2_0_1::eml20__DataObjectReference *  partialObject)
inlineprotected

Only to be used in partial transfer context

RESQML2_NS::PropertyKind::PropertyKind ( gsoap_resqml2_0_1::_resqml2__PropertyKind *  fromGsoap)
inlineprotected

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

virtual RESQML2_NS::PropertyKind::~PropertyKind ( )
inlinevirtual

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

Reimplemented in RESQML2_0_1_NS::PropertyKind.

Member Function Documentation

void RESQML2_NS::PropertyKind::addProperty ( class AbstractProperty *  repVal)
inline

Add a representation values object which uses this property type. Does not add the inverse relationship i.e. from the representation values object to this property type.

vector< Relationship > PropertyKind::getAllEpcRelationships ( ) const
protectedvirtual

Return all relationships (backward and forward ones) of the instance using EPC format.

Implements COMMON_NS::AbstractObject.

const std::string & PropertyKind::getNamingSystem ( ) const

Getter (in read only mode) of the naming system of this property type

std::string PropertyKind::getParentAsString ( ) const

Get the title of the parent of this property kind.

gsoap_resqml2_0_1::resqml2__ResqmlPropertyKind PropertyKind::getParentEnergisticsPropertyKind ( ) const

Getter for the energistics property kind which is associated to this intance.

PropertyKind * PropertyKind::getParentLocalPropertyKind ( ) const

Getter for the local property kind which is the parent of this instance. If nullptr is returned then it means this instance is associated to an energistics property kind.

gsoap_resqml2_0_1::eml20__DataObjectReference * PropertyKind::getParentLocalPropertyKindDor ( ) const
Returns
null pointer if no local parent property kind is associated to this property. Otherwise return the data object reference of the associated parent local property kind.
std::string PropertyKind::getParentLocalPropertyKindTitle ( ) const

Get the uuid of the local parent property kind which is associated to this property.

std::string PropertyKind::getParentLocalPropertyKindUuid ( ) const

Get the uuid of the local parent property kind which is associated to this property.

const gsoap_resqml2_0_1::resqml2__ResqmlUom & PropertyKind::getUom ( ) const

Get the unit of measure of the values of this property kind.

std::string PropertyKind::getUomAsString ( ) const

Get the unit of measure of the values of this property kind as a string.

virtual std::string RESQML2_NS::PropertyKind::getXmlTag ( ) const
inlinevirtual

Get the XML tag for the XML serialization of this instance

Implements COMMON_NS::AbstractObject.

void PropertyKind::importRelationshipSetFromEpc ( COMMON_NS::EpcDocument *  epcDoc)
protectedvirtual

Resolve all relationships of the object in an epc document

Implements COMMON_NS::AbstractObject.

virtual bool RESQML2_NS::PropertyKind::isAbstract ( ) const
pure virtual

Check if this property kind is abstract or not.

Implemented in RESQML2_0_1_NS::PropertyKind.

virtual bool RESQML2_NS::PropertyKind::isChildOf ( gsoap_resqml2_0_1::resqml2__ResqmlPropertyKind  standardPropKind) const
pure virtual

Check if this property kind is a child of a particular standard Energistics Property kind.

Implemented in RESQML2_0_1_NS::PropertyKind.

bool PropertyKind::isParentAnEnergisticsPropertyKind ( ) const

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

The documentation for this class was generated from the following files:
Generated by   doxygen 1.8.11