My Project
Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
resqml2::EpcExternalPartReference Class Reference
Inheritance diagram for resqml2::EpcExternalPartReference:
resqml2::AbstractObject resqml2::AbstractHdfProxy resqml2::HdfProxy resqml2_0_1::HdfProxy

Public Member Functions

 EpcExternalPartReference (const std::string &packageDirAbsolutePath, const std::string &externalFilePath)
 
 EpcExternalPartReference (gsoap_resqml2_0_1::_eml__EpcExternalPartReference *fromGsoap, const std::string &packageDirAbsolutePath, const std::string &externalFilePath)
 
 ~EpcExternalPartReference ()
 
virtual std::string getXmlTag () const
 
- Public Member Functions inherited from resqml2::AbstractObject
bool isPartial () const
 
std::string getUuid () const
 
std::string getTitle () const
 
std::string getEditor () const
 
time_t getCreation () const
 
std::string getOriginator () const
 
std::string getDescription () const
 
time_t getLastUpdate () const
 
std::string getFormat () const
 
std::string getDescriptiveKeywords () const
 
void setTitle (const std::string &title)
 
void setEditor (const std::string &editor)
 
void setCreation (const time_t &creation)
 
void setOriginator (const std::string &originator)
 
void setDescription (const std::string &description)
 
void setLastUpdate (const time_t &lastUpdate)
 
void setFormat (const std::string &format)
 
void setDescriptiveKeywords (const std::string &descriptiveKeywords)
 
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::eml__AbstractCitedDataObject * getGsoapProxy () const
 
soap * getGsoapContext () const
 
int getGsoapType () const
 
gsoap_resqml2_0_1::eml__DataObjectReference * newResqmlReference () const
 
gsoap_resqml2_0_1::resqml2__ContactElementReference * newResqmlContactElementReference () const
 
common::EpcDocumentgetEpcDocument () const
 
virtual std::string getXmlNamespace () const
 
virtual std::string getResqmlVersion () const
 
std::string getContentType () const
 
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::Activity * > & getActivitySet () const
 
void addOrSetExtraMetadata (const std::string &key, const std::string &value)
 
std::tr1::unordered_map< std::string, std::string > getExtraMetadataSet () const
 
std::string getExtraMetadata (const std::string &key)
 
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::EpcDocument *epcDoc)
 
- Protected Member Functions inherited from resqml2::AbstractObject
 AbstractObject (common::EpcDocument *epcDoc, gsoap_resqml2_0_1::eml__DataObjectReference *partialObject)
 Indicate whether methods update the XML (gSoap) or only the C++ classes of the API. More...
 
 AbstractObject (gsoap_resqml2_0_1::eml__AbstractCitedDataObject *proxy=nullptr)
 
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)
 

Protected Attributes

std::vector< class AbstractRepresentation * > representationSourceObject
 
std::vector< class AbstractProperty * > propertySourceObject
 All the representations that use this external reference.
 
std::string packageDirectoryAbsolutePath
 All the properties that use this external reference.
 
std::string relativeFilePath
 The directory where the EPC document is stored.
 
- Protected Attributes inherited from resqml2::AbstractObject
gsoap_resqml2_0_1::eml__AbstractCitedDataObject * gsoapProxy2_0_1
 
common::EpcDocumentepcDocument
 
std::vector< resqml2::Activity * > activitySet
 
bool updateXml
 

Additional Inherited Members

- Static Protected Member Functions inherited from resqml2::AbstractObject
static void addActivityToResqmlObject (resqml2::Activity *activity, AbstractObject *resqmlObject)
 

Constructor & Destructor Documentation

resqml2::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
resqml2::EpcExternalPartReference::EpcExternalPartReference ( gsoap_resqml2_0_1::_eml__EpcExternalPartReference *  fromGsoap,
const std::string &  packageDirAbsolutePath,
const std::string &  externalFilePath 
)
inline

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

resqml2::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 resqml2::AbstractObject.

string EpcExternalPartReference::getXmlTag ( ) const
virtual

Get the XML tag for the XML serialization of this instance

Implements resqml2::AbstractObject.

void resqml2::EpcExternalPartReference::importRelationshipSetFromEpc ( common::EpcDocument epcDoc)
inlineprotectedvirtual

Does nothing since external reference has not forward relationships at all

Implements resqml2::AbstractObject.


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