My Project
Public Member Functions | Protected Member Functions | Friends | List of all members
common::AbstractHdfProxy Class Referenceabstract
Inheritance diagram for common::AbstractHdfProxy:
common::EpcExternalPartReference common::AbstractObject common::HdfProxy prodml2_0::HdfProxy resqml2_0_1::HdfProxy

Public Member Functions

virtual void open ()=0
 
virtual bool isOpened () const =0
 
virtual void close ()=0
 
virtual int getHdfDatatypeInDataset (const std::string &datasetName) const =0
 
virtual int getHdfDatatypeClassInDataset (const std::string &datasetName) const =0
 
virtual 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)=0
 
virtual unsigned int getDimensionCount (const std::string &datasetName)=0
 
virtual signed long long getElementCount (const std::string &datasetName)=0
 
virtual void setCompressionLevel (const unsigned int &newCompressionLevel)=0
 
virtual void writeArrayNdOfFloatValues (const std::string &groupName, const std::string &name, float *floatValues, unsigned long long *numValuesInEachDimension, const unsigned int &numDimensions)=0
 
virtual void writeArrayNdOfDoubleValues (const std::string &groupName, const std::string &name, double *dblValues, unsigned long long *numValuesInEachDimension, const unsigned int &numDimensions)=0
 
virtual void writeArrayNdOfCharValues (const std::string &groupName, const std::string &name, char *intValues, unsigned long long *numValuesInEachDimension, const unsigned int &numDimensions)=0
 
virtual void writeArrayNdOfIntValues (const std::string &groupName, const std::string &name, int *intValues, unsigned long long *numValuesInEachDimension, const unsigned int &numDimensions)=0
 
virtual void writeArrayNdOfGSoapULong64Values (const std::string &groupName, const std::string &name, ULONG64 *ulong64Values, unsigned long long *numValuesInEachDimension, const unsigned int &numDimensions)=0
 
virtual void writeArrayNd (const std::string &groupName, const std::string &name, const int &datatype, void *values, unsigned long long *numValuesInEachDimension, const unsigned int &numDimensions)=0
 
virtual void createArrayNd (const std::string &groupName, const std::string &name, const int &datatype, unsigned long long *numValuesInEachDimension, const unsigned int &numDimensions)=0
 
virtual 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)=0
 
virtual void writeGroupAttributes (const std::string &groupName, const std::vector< std::string > &attributeNames, const std::vector< std::string > &values)=0
 
virtual void writeGroupAttribute (const std::string &groupName, const std::string &attributeName, const std::vector< std::string > &values)=0
 
virtual void writeGroupAttributes (const std::string &groupName, const std::vector< std::string > &attributeNames, const std::vector< double > &values)=0
 
virtual void writeGroupAttributes (const std::string &groupName, const std::vector< std::string > &attributeNames, const std::vector< int > &values)=0
 
virtual void writeDatasetAttributes (const std::string &datasetName, const std::vector< std::string > &attributeNames, const std::vector< std::string > &values)=0
 
virtual void writeDatasetAttribute (const std::string &datasetName, const std::string &attributeName, const std::vector< std::string > &values)=0
 
virtual void writeDatasetAttributes (const std::string &datasetName, const std::vector< std::string > &attributeNames, const std::vector< double > &values)=0
 
virtual void writeDatasetAttributes (const std::string &datasetName, const std::vector< std::string > &attributeNames, const std::vector< int > &values)=0
 
virtual std::string readStringAttribute (const std::string &obj_name, const std::string &attr_name) const =0
 
virtual std::vector< std::string > readStringArrayAttribute (const std::string &obj_name, const std::string &attr_name) const =0
 
virtual double readDoubleAttribute (const std::string &obj_name, const std::string &attr_name) const =0
 
virtual LONG64 readLongAttribute (const std::string &obj_name, const std::string &attr_name) const =0
 
virtual void readArrayNdOfDoubleValues (const std::string &datasetName, double *values)=0
 
virtual void readArrayNdOfDoubleValues (const std::string &datasetName, double *values, unsigned long long *numValuesInEachDimension, unsigned long long *offsetInEachDimension, const unsigned int &numDimensions)=0
 
virtual void readArrayNdOfFloatValues (const std::string &datasetName, float *values)=0
 
virtual void readArrayNdOfFloatValues (const std::string &datasetName, float *values, unsigned long long *numValuesInEachDimension, unsigned long long *offsetInEachDimension, const unsigned int &numDimensions)=0
 
virtual void readArrayNdOfGSoapLong64Values (const std::string &datasetName, LONG64 *values)=0
 
virtual void readArrayNdOfGSoapULong64Values (const std::string &datasetName, ULONG64 *values)=0
 
virtual void readArrayNdOfLongValues (const std::string &datasetName, long *values)=0
 
virtual void readArrayNdOfLongValues (const std::string &datasetName, long *values, unsigned long long *numValuesInEachDimension, unsigned long long *offsetInEachDimension, const unsigned int &numDimensions)=0
 
virtual void readArrayNdOfULongValues (const std::string &datasetName, unsigned long *values)=0
 
virtual void readArrayNdOfIntValues (const std::string &datasetName, int *values)=0
 
virtual void readArrayNdOfIntValues (const std::string &datasetName, int *values, unsigned long long *numValuesInEachDimension, unsigned long long *offsetInEachDimension, const unsigned int &numDimensions)=0
 
virtual void readArrayNdOfUIntValues (const std::string &datasetName, unsigned int *values)=0
 
virtual void readArrayNdOfShortValues (const std::string &datasetName, short *values)=0
 
virtual void readArrayNdOfUShortValues (const std::string &datasetName, unsigned short *values)=0
 
virtual void readArrayNdOfCharValues (const std::string &datasetName, char *values)=0
 
virtual void readArrayNdOfUCharValues (const std::string &datasetName, unsigned char *values)=0
 
virtual std::vector< unsigned long long > readArrayDimensions (const std::string &datasetName)=0
 
virtual bool exist (const std::string &absolutePathInHdfFile) const =0
 
- Public Member Functions inherited from common::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::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::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::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::Activity * > & getActivitySet () const
 
unsigned int getActivityCount () const
 
resqml2::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
 

Protected Member Functions

 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::EpcExternalPartReference
std::vector< epc::RelationshipgetAllEpcRelationships () const
 
void importRelationshipSetFromEpc (common::EpcDocument *epcDoc)
 
- Protected Member Functions inherited from common::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 ()
 

Friends

void resqml2::AbstractRepresentation::setHdfProxy (common::AbstractHdfProxy *proxy)
 
void resqml2::AbstractProperty::setHdfProxy (common::AbstractHdfProxy *proxy)
 
void prodml2_0::DasAcquisition::setHdfProxy (common::AbstractHdfProxy *proxy)
 

Additional Inherited Members

- Static Public Attributes inherited from common::EpcExternalPartReference
static const char * XML_TAG = "EpcExternalPartReference"
 
- Protected Types inherited from common::AbstractObject
enum  EmlVersion { TWO_DOT_ZERO = 0, TWO_DOT_ONE = 1 }
 
- Static Protected Member Functions inherited from common::AbstractObject
static void addActivityToResqmlObject (resqml2::Activity *activity, AbstractObject *resqmlObject)
 
- Protected Attributes inherited from common::EpcExternalPartReference
std::vector< resqml2::AbstractRepresentation * > representationSourceObject
 
std::vector< resqml2::AbstractProperty * > propertySourceObject
 All the representations that use this external reference.
 
std::vector< prodml2_0::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::AbstractObject
gsoap_resqml2_0_1::eml20__AbstractCitedDataObject * gsoapProxy2_0_1
 
gsoap_eml2_1::eml21__AbstractObject * gsoapProxy2_1
 
common::EpcDocumentepcDocument
 
std::vector< resqml2::Activity * > activitySet
 
bool updateXml
 

Constructor & Destructor Documentation

AbstractHdfProxy::AbstractHdfProxy ( const std::string &  packageDirAbsolutePath,
const std::string &  externalFilePath 
)
protected
Parameters
soapContextThe soap context where the underlying gsoap proxy is going to be created.

Member Function Documentation

virtual void common::AbstractHdfProxy::close ( )
pure virtual

Close the file

Implemented in common::HdfProxy.

virtual void common::AbstractHdfProxy::createArrayNd ( const std::string &  groupName,
const std::string &  name,
const int &  datatype,
unsigned long long *  numValuesInEachDimension,
const unsigned int &  numDimensions 
)
pure virtual

Create an array (potentially with multi dimensions) of a specific datatype into the HDF file. Values are not yet written to this array.

Parameters
groupNameThe name of the group where to create the array of double values. This name must not contain '/' character and must be directly contained in RESQML group.
nameThe name of the array (potentially with multi dimensions) of a specific datatype hdf dataset. It must not exist.
datatypeThe specific datatype of the values to write.
numValuesInEachDimensionNumber of values in each dimension of the array to write. They are ordered from fastest index to slowest index.
numDimensionsThe number of the dimensions of the array to write.

Implemented in common::HdfProxy.

virtual bool common::AbstractHdfProxy::exist ( const std::string &  absolutePathInHdfFile) const
pure virtual

Check wether an absolute path exists in the hdf file or not.

Implemented in common::HdfProxy.

virtual unsigned int common::AbstractHdfProxy::getDimensionCount ( const std::string &  datasetName)
pure virtual

Get the number of dimensions in an HDF dataset of the proxy.

Parameters
datasetNameThe absolute name of the dataset we want to get the number of dimensions.

Implemented in common::HdfProxy.

virtual signed long long common::AbstractHdfProxy::getElementCount ( const std::string &  datasetName)
pure virtual

Get the number of elements in an HDF dataset of the proxy. The number of elements is get from all dimensions.

Parameters
datasetNameThe absolute name of the dataset we want to get the number of elements.

Implemented in common::HdfProxy.

virtual int common::AbstractHdfProxy::getHdfDatatypeClassInDataset ( const std::string &  datasetName) const
pure virtual

Get the used datatype class in a dataset To compare with H5T_INTEGER, H5T_FLOAT , H5T_STRING , etc...

Implemented in common::HdfProxy.

virtual int common::AbstractHdfProxy::getHdfDatatypeInDataset ( const std::string &  datasetName) const
pure virtual

Get the used (native) datatype in a dataset To compare with H5T_NATIVE_INT, H5T_NATIVE_UINT, H5T_NATIVE_FLOAT, etc...

Implemented in common::HdfProxy.

void AbstractHdfProxy::initGsoapProxy ( soap *  soapContext,
const std::string &  guid,
const std::string &  title,
const EmlVersion &  emlVersion 
)
protected

Instantiate and initialize the gsoap proxy v2.0.1. This method is defined in order to be used in derived class without having to link to generated gsoap files.

virtual bool common::AbstractHdfProxy::isOpened ( ) const
pure virtual

Check if the Hdf file is open or not

Implemented in common::HdfProxy.

virtual void common::AbstractHdfProxy::open ( )
pure virtual

Open the file for reading and writing. The read/write access are determined by the EPC document configuration.

Implemented in common::HdfProxy.

virtual std::vector<unsigned long long> common::AbstractHdfProxy::readArrayDimensions ( const std::string &  datasetName)
pure virtual

Read the dimensions of an array stored in a specific dataset

Parameters
datasetNameThe absolute dataset name where to read the array dimensions

Implemented in common::HdfProxy.

virtual void common::AbstractHdfProxy::readArrayNdOfCharValues ( const std::string &  datasetName,
char *  values 
)
pure virtual

Read an array Nd of char values stored in a specific dataset.

Parameters
datasetNameThe absolute dataset name where to read the values
valuesThe values must be pre-allocated.

Implemented in common::HdfProxy.

virtual void common::AbstractHdfProxy::readArrayNdOfDoubleValues ( const std::string &  datasetName,
double *  values 
)
pure virtual

Read an array Nd of double values stored in a specific dataset

Parameters
datasetNameThe absolute dataset name where to read the values
valuesThe values must be pre-allocated.

Implemented in common::HdfProxy.

virtual void common::AbstractHdfProxy::readArrayNdOfDoubleValues ( const std::string &  datasetName,
double *  values,
unsigned long long *  numValuesInEachDimension,
unsigned long long *  offsetInEachDimension,
const unsigned int &  numDimensions 
)
pure virtual

Find the array associated with datasetName and read from it.

Parameters
datasetNameThe name of the array (potentially with multi dimensions).
values1d array output of double values ordered firstly by fastest direction.
numValuesInEachDimensionNumber of values in each dimension of the array to read. They are ordered from fastest index to slowest index.
offsetValuesInEachDimensionOffset values in each dimension of the array to read. They are ordered from fastest index to slowest index.
numDimensionsThe number of the dimensions of the array to read.

Implemented in common::HdfProxy.

virtual void common::AbstractHdfProxy::readArrayNdOfFloatValues ( const std::string &  datasetName,
float *  values 
)
pure virtual

Read an array Nd of float values stored in a specific dataset.

Parameters
datasetNameThe absolute dataset name where to read the values
valuesThe values must be pre-allocated.

Implemented in common::HdfProxy.

virtual void common::AbstractHdfProxy::readArrayNdOfFloatValues ( const std::string &  datasetName,
float *  values,
unsigned long long *  numValuesInEachDimension,
unsigned long long *  offsetInEachDimension,
const unsigned int &  numDimensions 
)
pure virtual

Find the array associated with datasetName and read from it.

Parameters
datasetNameThe name of the array (potentially with multi dimensions).
values1d array output of float values ordered firstly by fastest direction.
numValuesInEachDimensionNumber of values in each dimension of the array to read. They are ordered from fastest index to slowest index.
offsetValuesInEachDimensionOffset values in each dimension of the array to read. They are ordered from fastest index to slowest index.
numDimensionsThe number of the dimensions of the array to read.

Implemented in common::HdfProxy.

virtual void common::AbstractHdfProxy::readArrayNdOfGSoapLong64Values ( const std::string &  datasetName,
LONG64 *  values 
)
pure virtual

TODO : check all possible size of LONG64 on all different platforms

Implemented in common::HdfProxy.

virtual void common::AbstractHdfProxy::readArrayNdOfGSoapULong64Values ( const std::string &  datasetName,
ULONG64 *  values 
)
pure virtual

TODO : check all possible size of ULONG64 on all different platforms

Implemented in common::HdfProxy.

virtual void common::AbstractHdfProxy::readArrayNdOfIntValues ( const std::string &  datasetName,
int *  values 
)
pure virtual

Read an array Nd of int values stored in a specific dataset.

Parameters
datasetNameThe absolute dataset name where to read the values
valuesThe values must be pre-allocated.

Implemented in common::HdfProxy.

virtual void common::AbstractHdfProxy::readArrayNdOfIntValues ( const std::string &  datasetName,
int *  values,
unsigned long long *  numValuesInEachDimension,
unsigned long long *  offsetInEachDimension,
const unsigned int &  numDimensions 
)
pure virtual

Find the array associated with datasetName and read from it.

Parameters
datasetNameThe name of the array (potentially with multi dimensions).
values1d array output of int values ordered firstly by fastest direction.
numValuesInEachDimensionNumber of values in each dimension of the array to read. They are ordered from fastest index to slowest index.
offsetValuesInEachDimensionOffset values in each dimension of the array to read. They are ordered from fastest index to slowest index.
numDimensionsThe number of the dimensions of the array to read.

Implemented in common::HdfProxy.

virtual void common::AbstractHdfProxy::readArrayNdOfLongValues ( const std::string &  datasetName,
long *  values 
)
pure virtual

Read an array Nd of long values stored in a specific dataset.

Parameters
datasetNameThe absolute dataset name where to read the values
valuesThe values must be pre-allocated.

Implemented in common::HdfProxy.

virtual void common::AbstractHdfProxy::readArrayNdOfLongValues ( const std::string &  datasetName,
long *  values,
unsigned long long *  numValuesInEachDimension,
unsigned long long *  offsetInEachDimension,
const unsigned int &  numDimensions 
)
pure virtual

Find the array associated with datasetName and read from it.

Parameters
datasetNameThe name of the array (potentially with multi dimensions).
values1d array output of long values ordered firstly by fastest direction.
numValuesInEachDimensionNumber of values in each dimension of the array to read. They are ordered from fastest index to slowest index.
offsetValuesInEachDimensionOffset values in each dimension of the array to read. They are ordered from fastest index to slowest index.
numDimensionsThe number of the dimensions of the array to read.

Implemented in common::HdfProxy.

virtual void common::AbstractHdfProxy::readArrayNdOfShortValues ( const std::string &  datasetName,
short *  values 
)
pure virtual

Read an array Nd of short values stored in a specific dataset Don"t forget to delete the allocated pointer when no more necessary.

Parameters
datasetNameThe absolute dataset name where to read the values
valuesThe values must be pre-allocated.

Implemented in common::HdfProxy.

virtual void common::AbstractHdfProxy::readArrayNdOfUCharValues ( const std::string &  datasetName,
unsigned char *  values 
)
pure virtual

Read an array Nd of unsigned char values stored in a specific dataset.

Parameters
datasetNameThe absolute dataset name where to read the values

Implemented in common::HdfProxy.

virtual void common::AbstractHdfProxy::readArrayNdOfUIntValues ( const std::string &  datasetName,
unsigned int *  values 
)
pure virtual

Read an array Nd of unsigned int values stored in a specific dataset Don"t forget to delete the allocated pointer when no more necessary.

Parameters
datasetNameThe absolute dataset name where to read the values

Implemented in common::HdfProxy.

virtual void common::AbstractHdfProxy::readArrayNdOfULongValues ( const std::string &  datasetName,
unsigned long *  values 
)
pure virtual

Read an array Nd of unsigned long values stored in a specific dataset.

Parameters
datasetNameThe absolute dataset name where to read the values
valuesThe values must be pre-allocated.

Implemented in common::HdfProxy.

virtual void common::AbstractHdfProxy::readArrayNdOfUShortValues ( const std::string &  datasetName,
unsigned short *  values 
)
pure virtual

Read an array Nd of unsigned short values stored in a specific dataset.

Parameters
datasetNameThe absolute dataset name where to read the values
valuesThe values must be pre-allocated.

Implemented in common::HdfProxy.

virtual double common::AbstractHdfProxy::readDoubleAttribute ( const std::string &  obj_name,
const std::string &  attr_name 
) const
pure virtual

Read a double which is stored as an HDF attribute in a file, group or dataset

Parameters
obj_nameuse '.' if the attribute to read is on the file otherwise the full path

Implemented in common::HdfProxy.

virtual LONG64 common::AbstractHdfProxy::readLongAttribute ( const std::string &  obj_name,
const std::string &  attr_name 
) const
pure virtual

Read a long which is stored as an HDF attribute in a file, group or dataset

Parameters
obj_nameuse '.' if the attribute to read is on the file otherwise the full path

Implemented in common::HdfProxy.

virtual std::string common::AbstractHdfProxy::readStringAttribute ( const std::string &  obj_name,
const std::string &  attr_name 
) const
pure virtual

Read a string which is stored as an HDF attribute in a file, group or dataset

Parameters
obj_nameuse '.' if the attribute to read is on the file otherwise the full path

Implemented in common::HdfProxy.

virtual void common::AbstractHdfProxy::setCompressionLevel ( const unsigned int &  newCompressionLevel)
pure virtual

Set the new compression level which will be used for all data to be written

Parameters
compressionLevelLower compression levels are faster but result in less compression. Range [0..9] is allowed.

Implemented in common::HdfProxy.

virtual void common::AbstractHdfProxy::writeArrayNd ( const std::string &  groupName,
const std::string &  name,
const int &  datatype,
void *  values,
unsigned long long *  numValuesInEachDimension,
const unsigned int &  numDimensions 
)
pure virtual

Write an array (potentially with multi dimensions) of a specific datatype into the HDF file by means of a single dataset.

Parameters
groupNameThe name of the group where to create the array of values. This name must not contain '/' character and must be directly contained in RESQML group.
nameThe name of the array (potentially with multi dimensions) of a specific datatype hdf dataset. It must not already exist.
datatypeThe specific datatype of the valeus to write.
values1d array of specific datatype ordered firstly by fastest direction.
numValuesInEachDimensionNumber of values in each dimension of the array to write. They are ordered from fastest index to slowest index.
numDimensionsThe number of the dimensions of the array to write

Implemented in common::HdfProxy.

virtual void common::AbstractHdfProxy::writeArrayNdOfCharValues ( const std::string &  groupName,
const std::string &  name,
char *  intValues,
unsigned long long *  numValuesInEachDimension,
const unsigned int &  numDimensions 
)
pure virtual

Write an array (potentially with multi dimensions) of char values into the HDF file by means of a single dataset.

Parameters
groupNameThe name of the group where to create the array of int values. This name must not contain '/' character and must be directly contained in RESQML group.
nameThe name of the array of int values hdf dataset. It must not already exist.
intValues1d array of char values ordered firstly by fastest direction.
numValuesInEachDimensionNumber of values in each dimension of the array to write. They are ordered from fastest index to slowest index.
numDimensionsThe number of the dimensions of the array to write

Implemented in common::HdfProxy.

virtual void common::AbstractHdfProxy::writeArrayNdOfDoubleValues ( const std::string &  groupName,
const std::string &  name,
double *  dblValues,
unsigned long long *  numValuesInEachDimension,
const unsigned int &  numDimensions 
)
pure virtual

Write an array (potentially with multi dimensions) of double values into the HDF file by means of a single dataset.

Parameters
groupNameThe name of the group where to create the array of double values. This name must not contain '/' character and must be directly contained in RESQML group.
nameThe name of the array of double values hdf dataset. It must not already exist.
dblValues1d array of double values ordered firstly by fastest direction.
numValuesInEachDimensionNumber of values in each dimension of the array to write. They are ordered from fastest index to slowest index.
numDimensionsThe number of the dimensions of the array to write

Implemented in common::HdfProxy.

virtual void common::AbstractHdfProxy::writeArrayNdOfGSoapULong64Values ( const std::string &  groupName,
const std::string &  name,
ULONG64 *  ulong64Values,
unsigned long long *  numValuesInEachDimension,
const unsigned int &  numDimensions 
)
pure virtual

Write an array (potentially with multi dimensions) of gSoap unsigned long 64 values into the HDF file by means of a single dataset.

Parameters
groupNameThe name of the group where to create the array of int values. This name must not contain '/' character and must be directly contained in RESQML group.
nameThe name of the array of gSoap unsigned long 64 values hdf dataset. It must not already exist.
ulong64Values1d array of gSoap unsigned long 64 values ordered firstly by fastest direction.
numValuesInEachDimensionNumber of values in each dimension of the array to write. They are ordered from fastest index to slowest index.
numDimensionsThe number of the dimensions of the array to write

Implemented in common::HdfProxy.

virtual void common::AbstractHdfProxy::writeArrayNdOfIntValues ( const std::string &  groupName,
const std::string &  name,
int *  intValues,
unsigned long long *  numValuesInEachDimension,
const unsigned int &  numDimensions 
)
pure virtual

Write an array (potentially with multi dimensions) of int values into the HDF file by means of a single dataset.

Parameters
groupNameThe name of the group where to create the array of int values. This name must not contain '/' character and must be directly contained in RESQML group.
nameThe name of the array of int values hdf dataset. It must not already exist.
intValues1d array of int values ordered firstly by fastest direction.
numValuesInEachDimensionNumber of values in each dimension of the array to write. They are ordered from fastest index to slowest index.
numDimensionsThe number of the dimensions of the array to write

Implemented in common::HdfProxy.

virtual void common::AbstractHdfProxy::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 
)
pure virtual

Find the array associated with groupName and name and write to it.

Parameters
groupNameThe name of the group associated with the array.
nameThe name of the array (potentially with multi dimensions).
values1d array of specific datatype ordered firstly by fastest direction.
numValuesInEachDimensionNumber of values in each dimension of the array to write. They are ordered from fastest index to slowest index.
offsetValuesInEachDimensionOffset values in each dimension of the array to write. They are ordered from fastest index to slowest index.
numDimensionsThe number of the dimensions of the array to write.

Implemented in common::HdfProxy.

virtual void common::AbstractHdfProxy::writeDatasetAttribute ( const std::string &  datasetName,
const std::string &  attributeName,
const std::vector< std::string > &  values 
)
pure virtual

Write a single attribute which contain an array of strings

Implemented in common::HdfProxy.

virtual void common::AbstractHdfProxy::writeDatasetAttributes ( const std::string &  datasetName,
const std::vector< std::string > &  attributeNames,
const std::vector< std::string > &  values 
)
pure virtual

Write some string attributes into a dataset

Implemented in common::HdfProxy.

virtual void common::AbstractHdfProxy::writeDatasetAttributes ( const std::string &  datasetName,
const std::vector< std::string > &  attributeNames,
const std::vector< double > &  values 
)
pure virtual

Write some double attributes into a dataset

Implemented in common::HdfProxy.

virtual void common::AbstractHdfProxy::writeDatasetAttributes ( const std::string &  datasetName,
const std::vector< std::string > &  attributeNames,
const std::vector< int > &  values 
)
pure virtual

Write some int attributes into a dataset

Implemented in common::HdfProxy.

virtual void common::AbstractHdfProxy::writeGroupAttribute ( const std::string &  groupName,
const std::string &  attributeName,
const std::vector< std::string > &  values 
)
pure virtual

Write a single attribute which contain an array of strings

Implemented in common::HdfProxy.

virtual void common::AbstractHdfProxy::writeGroupAttributes ( const std::string &  groupName,
const std::vector< std::string > &  attributeNames,
const std::vector< std::string > &  values 
)
pure virtual

Write some string attributes into a group

Implemented in common::HdfProxy.

virtual void common::AbstractHdfProxy::writeGroupAttributes ( const std::string &  groupName,
const std::vector< std::string > &  attributeNames,
const std::vector< double > &  values 
)
pure virtual

Write some double attributes into a group

Implemented in common::HdfProxy.

virtual void common::AbstractHdfProxy::writeGroupAttributes ( const std::string &  groupName,
const std::vector< std::string > &  attributeNames,
const std::vector< int > &  values 
)
pure virtual

Write some int attributes into a group

Implemented in common::HdfProxy.

virtual void common::AbstractHdfProxy::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 
)
pure virtual

Write an itemized list of list into the HDF file by means of a single group containing 2 datasets.

Parameters
groupNameThe name of the group where to create the itemized list of list. This name must not contain '/' character and must be directly contained in RESQML group.
nameThe name of the itemized list of list hdf group.
cumulativeLengthDatatypeThe datatype of the cumulative length to write.
cumulativeLength1d array of positive integers containing for each list the sum of all the previous list lengths including the current one
cumulativeLengthSizeSize of the cumulativeLength array.
elementsDatatypeThe datatype of the elements to write.
elements1d array of elements containing the aggregation of individual list content.
elementsSizeSize of the elements array.

Implemented in common::HdfProxy.


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