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

Public Member Functions

 HdfProxy (soap *soapContext, const std::string &guid, const std::string &title, const std::string &packageDirAbsolutePath, const std::string &externalFilePath)
 
 HdfProxy (gsoap_resqml2_0_1::_eml20__EpcExternalPartReference *fromGsoap, const std::string &packageDirAbsolutePath, const std::string &externalFilePath)
 
std::string getXmlNamespace () const
 
- Public Member Functions inherited from COMMON_NS::HdfProxy
 ~HdfProxy ()
 
void open ()
 
bool isOpened () const
 
void close ()
 
int getHdfDatatypeInDataset (const std::string &groupName) const
 
int getHdfDatatypeClassInDataset (const std::string &datasetName) const
 
void writeItemizedListOfList (const std::string &groupName, const std::string &name, const int &cumulativeLengthDatatype, void *cumulativeLength, const unsigned long long &cumulativeLengthSize, const int &elementsDatatype, void *elements, const unsigned long long &elementsSize)
 
unsigned int getDimensionCount (const std::string &datasetName)
 
signed long long getElementCount (const std::string &datasetName)
 
void setCompressionLevel (const unsigned int &newCompressionLevel)
 
void writeArrayNdOfFloatValues (const std::string &groupName, const std::string &name, float *floatValues, unsigned long long *numValuesInEachDimension, const unsigned int &numDimensions)
 
void writeArrayNdOfDoubleValues (const std::string &groupName, const std::string &name, double *dblValues, unsigned long long *numValuesInEachDimension, const unsigned int &numDimensions)
 
void writeArrayNdOfCharValues (const std::string &groupName, const std::string &name, char *intValues, unsigned long long *numValuesInEachDimension, const unsigned int &numDimensions)
 
void writeArrayNdOfIntValues (const std::string &groupName, const std::string &name, int *intValues, unsigned long long *numValuesInEachDimension, const unsigned int &numDimensions)
 
void writeArrayNdOfGSoapULong64Values (const std::string &groupName, const std::string &name, ULONG64 *ulong64Values, unsigned long long *numValuesInEachDimension, const unsigned int &numDimensions)
 
void writeArrayNd (const std::string &groupName, const std::string &name, const int &datatype, void *values, unsigned long long *numValuesInEachDimension, const unsigned int &numDimensions)
 
void createArrayNd (const std::string &groupName, const std::string &name, const int &datatype, unsigned long long *numValuesInEachDimension, const unsigned int &numDimensions)
 
void writeArrayNdSlab (const std::string &groupName, const std::string &name, const int &datatype, void *values, unsigned long long *numValuesInEachDimension, unsigned long long *offsetValuesInEachDimension, const unsigned int &numDimensions)
 
void writeGroupAttributes (const std::string &groupName, const std::vector< std::string > &attributeNames, const std::vector< std::string > &values)
 
void writeGroupAttribute (const std::string &groupName, const std::string &attributeName, const std::vector< std::string > &values)
 
void writeGroupAttributes (const std::string &groupName, const std::vector< std::string > &attributeNames, const std::vector< double > &values)
 
void writeGroupAttributes (const std::string &groupName, const std::vector< std::string > &attributeNames, const std::vector< int > &values)
 
void writeDatasetAttributes (const std::string &datasetName, const std::vector< std::string > &attributeNames, const std::vector< std::string > &values)
 
void writeDatasetAttribute (const std::string &datasetName, const std::string &attributeName, const std::vector< std::string > &values)
 
void writeDatasetAttributes (const std::string &datasetName, const std::vector< std::string > &attributeNames, const std::vector< double > &values)
 
void writeDatasetAttributes (const std::string &datasetName, const std::vector< std::string > &attributeNames, const std::vector< int > &values)
 
std::string readStringAttribute (const std::string &obj_name, const std::string &attr_name) const
 
std::vector< std::string > readStringArrayAttribute (const std::string &obj_name, const std::string &attr_name) const
 
double readDoubleAttribute (const std::string &obj_name, const std::string &attr_name) const
 
LONG64 readLongAttribute (const std::string &obj_name, const std::string &attr_name) const
 
void readArrayNdOfDoubleValues (const std::string &datasetName, double *values)
 
void readArrayNdOfDoubleValues (const std::string &datasetName, double *values, unsigned long long *numValuesInEachDimension, unsigned long long *offsetInEachDimension, const unsigned int &numDimensions)
 
void readArrayNdOfDoubleValues (const std::string &datasetName, double *values, unsigned long long *blockCountPerDimension, unsigned long long *offsetInEachDimension, unsigned long long *strideInEachDimension, unsigned long long *blockSizeInEachDimension, const unsigned int &numDimensions)
 
void readArrayNdOfDoubleValues (int dataset, int filespace, void *values, unsigned long long slabSize)
 
void readArrayNdOfFloatValues (const std::string &datasetName, float *values)
 
void readArrayNdOfFloatValues (const std::string &datasetName, float *values, unsigned long long *numValuesInEachDimension, unsigned long long *offsetInEachDimension, const unsigned int &numDimensions)
 
void readArrayNdOfGSoapLong64Values (const std::string &datasetName, LONG64 *values)
 
void readArrayNdOfGSoapULong64Values (const std::string &datasetName, ULONG64 *values)
 
void readArrayNdOfLongValues (const std::string &datasetName, long *values)
 
void readArrayNdOfLongValues (const std::string &datasetName, long *values, unsigned long long *numValuesInEachDimension, unsigned long long *offsetInEachDimension, const unsigned int &numDimensions)
 
void readArrayNdOfULongValues (const std::string &datasetName, unsigned long *values)
 
void readArrayNdOfIntValues (const std::string &datasetName, int *values)
 
void readArrayNdOfIntValues (const std::string &datasetName, int *values, unsigned long long *numValuesInEachDimension, unsigned long long *offsetInEachDimension, const unsigned int &numDimensions)
 
void readArrayNdOfUIntValues (const std::string &datasetName, unsigned int *values)
 
void readArrayNdOfShortValues (const std::string &datasetName, short *values)
 
void readArrayNdOfUShortValues (const std::string &datasetName, unsigned short *values)
 
void readArrayNdOfCharValues (const std::string &datasetName, char *values)
 
void readArrayNdOfUCharValues (const std::string &datasetName, unsigned char *values)
 
std::vector< unsigned long long > readArrayDimensions (const std::string &datasetName)
 
bool exist (const std::string &absolutePathInHdfFile) const
 
- Public Member Functions inherited from COMMON_NS::EpcExternalPartReference
 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 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
 

Additional Inherited Members

- Static Public Attributes inherited from COMMON_NS::EpcExternalPartReference
static const char * XML_TAG = "EpcExternalPartReference"
 
- Protected Types inherited from COMMON_NS::AbstractObject
enum  EmlVersion { TWO_DOT_ZERO = 0, TWO_DOT_ONE = 1 }
 
- Protected Member Functions inherited from COMMON_NS::HdfProxy
 HdfProxy (gsoap_resqml2_0_1::_eml20__EpcExternalPartReference *fromGsoap, const std::string &packageDirAbsolutePath, const std::string &externalFilePath)
 
 HdfProxy (gsoap_eml2_1::_eml21__EpcExternalPartReference *fromGsoap, const std::string &packageDirAbsolutePath, const std::string &externalFilePath)
 
 HdfProxy (const std::string &packageDirAbsolutePath, const std::string &externalFilePath)
 
void readArrayNdOfValues (const std::string &datasetName, void *values, const int &datatype)
 
void readArrayNdOfValues (const std::string &datasetName, void *values, unsigned long long *numValuesInEachDimension, unsigned long long *offsetInEachDimension, const unsigned int &numDimensions, const int &datatype)
 
void readArrayNdOfValues (const std::string &datasetName, void *values, unsigned long long *blockCountPerDimension, unsigned long long *offsetInEachDimension, unsigned long long *strideInEachDimension, unsigned long long *blockSizeInEachDimension, const unsigned int &numDimensions, const int &datatype)
 
void selectArrayNdOfValues (const std::string &datasetName, unsigned long long *blockCountPerDimension, unsigned long long *offsetInEachDimension, unsigned long long *strideInEachDimension, unsigned long long *blockSizeInEachDimension, const unsigned int &numDimensions, bool newSelection, int &dataset, int &filespace)
 
void readArrayNdOfValues (int dataset, int filespace, void *values, unsigned long long slabSize, const int &datatype)
 
int openOrCreateGroupInRootGroup (const std::string &groupName)
 
- Protected Member Functions inherited from COMMON_NS::AbstractHdfProxy
 AbstractHdfProxy (const std::string &packageDirAbsolutePath, const std::string &externalFilePath)
 
 AbstractHdfProxy (gsoap_resqml2_0_1::_eml20__EpcExternalPartReference *fromGsoap, const std::string &packageDirAbsolutePath, const std::string &externalFilePath)
 
 AbstractHdfProxy (gsoap_eml2_1::_eml21__EpcExternalPartReference *fromGsoap, const std::string &packageDirAbsolutePath, const std::string &externalFilePath)
 
void initGsoapProxy (soap *soapContext, const std::string &guid, const std::string &title, const EmlVersion &emlVersion)
 
- Protected Member Functions inherited from COMMON_NS::EpcExternalPartReference
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 ()
 
- Static Protected Member Functions inherited from COMMON_NS::AbstractObject
static void addActivityToResqmlObject (RESQML2_NS::Activity *activity, AbstractObject *resqmlObject)
 
- Protected Attributes inherited from COMMON_NS::HdfProxy
int hdfFile
 
unsigned int compressionLevel
 
- Protected Attributes inherited from COMMON_NS::EpcExternalPartReference
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
 

Constructor & Destructor Documentation

HdfProxy::HdfProxy ( soap *  soapContext,
const std::string &  guid,
const std::string &  title,
const std::string &  packageDirAbsolutePath,
const std::string &  externalFilePath 
)

Creates an instance of this class in a gsoap context.

Parameters
soapContextThe soap context where the underlying gsoap proxy is going to be created.
guidThe guid of the underlying gsoap proxy to be created.
titleThe title of the underlying gsoap proxy to be created. The directory where the EPC document is stored. Must end with a slash or back-slash The relative file path of the associated HDF file. It is relative to the location of the package

Member Function Documentation

std::string HdfProxy::getXmlNamespace ( ) const
virtual

Get the XML namespace for the tags for the XML serialization of this instance

Reimplemented from COMMON_NS::AbstractObject.


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