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 | List of all members
COMMON_NS::EpcExternalPartReference Class Reference
Inheritance diagram for COMMON_NS::EpcExternalPartReference:
COMMON_NS::AbstractObject COMMON_NS::AbstractHdfProxy COMMON_NS::HdfProxy PRODML2_0_NS::HdfProxy RESQML2_0_1_NS::HdfProxy

Public Member Functions

 EpcExternalPartReference (const std::string &packageDirAbsolutePath, const std::string &externalFilePath)
 
 EpcExternalPartReference (gsoap_resqml2_0_1::_eml20__EpcExternalPartReference *fromGsoap, const std::string &packageDirAbsolutePath, const std::string &externalFilePath)
 
 EpcExternalPartReference (gsoap_eml2_1::_eml21__EpcExternalPartReference *fromGsoap, const std::string &packageDirAbsolutePath, const std::string &externalFilePath)
 
 ~EpcExternalPartReference ()
 
std::string getRelativePath () const
 
virtual std::string getXmlTag () const
 
- 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::EpcDocumentgetEpcDocument () 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::ActivitygetActivity (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 = "EpcExternalPartReference"
 

Protected Member Functions

std::vector< epc::RelationshipgetAllEpcRelationships () 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< RESQML2_NS::AbstractRepresentation * > representationSourceObject
 
std::vector< RESQML2_NS::AbstractProperty * > propertySourceObject
 All the representations that use this external reference.
 
std::vector< PRODML2_0_NS::DasAcquisition * > dasAcquisitionSourceObject
 All the properties that use this external reference.
 
std::string packageDirectoryAbsolutePath
 All the DAS acquisition that use this external reference.
 
std::string relativeFilePath
 The directory where the EPC document is stored.
 
- 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::EpcDocumentepcDocument
 
std::vector< RESQML2_NS::Activity * > activitySet
 
bool updateXml
 

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

COMMON_NS::EpcExternalPartReference::EpcExternalPartReference ( const std::string &  packageDirAbsolutePath,
const std::string &  externalFilePath 
)
Parameters
packageDirAbsolutePathThe directory where the EPC document is stored. Must end with a slash or back-slash
externalFilePathThe relative path regarding packageDirectoryAbsolutePath where the external resource is located
COMMON_NS::EpcExternalPartReference::EpcExternalPartReference ( gsoap_resqml2_0_1::_eml20__EpcExternalPartReference *  fromGsoap,
const std::string &  packageDirAbsolutePath,
const std::string &  externalFilePath 
)
inline

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

COMMON_NS::EpcExternalPartReference::EpcExternalPartReference ( gsoap_eml2_1::_eml21__EpcExternalPartReference *  fromGsoap,
const std::string &  packageDirAbsolutePath,
const std::string &  externalFilePath 
)
inline

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

COMMON_NS::EpcExternalPartReference::~EpcExternalPartReference ( )
inline

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

Member Function Documentation

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

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

Implements COMMON_NS::AbstractObject.

std::string COMMON_NS::EpcExternalPartReference::getRelativePath ( ) const
inline

Get the relative path regarding packageDirectoryAbsolutePath where the external resource is located.

string EpcExternalPartReference::getXmlTag ( ) const
virtual

Get the XML tag for the XML serialization of this instance

Implements COMMON_NS::AbstractObject.

void COMMON_NS::EpcExternalPartReference::importRelationshipSetFromEpc ( COMMON_NS::EpcDocument epcDoc)
inlineprotectedvirtual

Does nothing since external reference has not forward relationships at all

Implements COMMON_NS::AbstractObject.


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