My Project
|
Public Types | |
enum | hdfDatatypeEnum { UNKNOWN = 0, DOUBLE = 1, FLOAT = 2, LONG = 3, ULONG = 4, INT = 5, UINT = 6, SHORT = 7, USHORT = 8, CHAR = 9, UCHAR = 10 } |
Public Member Functions | |
AbstractValuesProperty (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject) | |
AbstractValuesProperty () | |
AbstractValuesProperty (gsoap_resqml2_0_1::resqml2__AbstractValuesProperty *fromGsoap) | |
virtual | ~AbstractValuesProperty () |
unsigned int | getPatchCount () const |
AbstractValuesProperty::hdfDatatypeEnum | getValuesHdfDatatype () const |
virtual std::string | pushBackRefToExistingDataset (common::AbstractHdfProxy *hdfProxy, const std::string &datasetName="", const long &nullValue=(std::numeric_limits< long >::max)())=0 |
long | getLongValuesOfPatch (const unsigned int &patchIndex, long *values) |
long | getNullValueOfPatch (const unsigned int &patchIndex) |
unsigned long | getULongValuesOfPatch (const unsigned int &patchIndex, unsigned long *values) |
int | getIntValuesOfPatch (const unsigned int &patchIndex, int *values) |
int | getIntValuesOfPatch (const unsigned int &patchIndex, int *values, unsigned long long *numValuesInEachDimension, unsigned long long *offsetInEachDimension, const unsigned int &numArrayDimensions) |
void | getIntValuesOf3dPatch (const unsigned int &patchIndex, int *values, const unsigned int &valueCountInFastestDim, const unsigned int &valueCountInMiddleDim, const unsigned int &valueCountInSlowestDim, const unsigned int &offsetInFastestDim, const unsigned int &offsetInMiddleDim, const unsigned int &offsetInSlowestDim) |
unsigned int | getUIntValuesOfPatch (const unsigned int &patchIndex, unsigned int *values) |
short | getShortValuesOfPatch (const unsigned int &patchIndex, short *values) |
unsigned short | getUShortValuesOfPatch (const unsigned int &patchIndex, unsigned short *values) |
char | getCharValuesOfPatch (const unsigned int &patchIndex, char *values) |
unsigned char | getUCharValuesOfPatch (const unsigned int &patchIndex, unsigned char *values) |
unsigned int | getValuesCountOfPatch (const unsigned int &patchIndex) |
unsigned int | getValuesCountOfDimensionOfPatch (const unsigned int &dimIndex, const unsigned int &patchIndex) |
unsigned int | getDimensionsCountOfPatch (const unsigned int &patchIndex) |
void | pushBackFacet (const gsoap_resqml2_0_1::resqml2__Facet &facet, const std::string &facetValue) |
unsigned int | getFacetCount () const |
gsoap_resqml2_0_1::resqml2__Facet | getFacet (const unsigned int &index) const |
std::string | getFacetValue (const unsigned int &index) const |
void | createLongHdf5ArrayOfValues (unsigned long long *numValues, const unsigned int &numArrayDimensions, common::AbstractHdfProxy *proxy) |
void | createLongHdf5Array3dOfValues (const unsigned int &valueCountInFastestDim, const unsigned int &valueCountInMiddleDim, const unsigned int &valueCountInSlowestDim, common::AbstractHdfProxy *proxy) |
void | pushBackLongHdf5SlabArray3dOfValues (long *values, const unsigned int &valueCountInFastestDim, const unsigned int &valueCountInMiddleDim, const unsigned int &valueCountInSlowestDim, const unsigned int &offsetInFastestDim, const unsigned int &offsetInMiddleDim, const unsigned int &offsetInSlowestDim, common::AbstractHdfProxy *proxy) |
void | pushBackLongHdf5SlabArrayOfValues (long *values, unsigned long long *numValues, unsigned long long *offsetValues, const unsigned int &numArrayDimensions, common::AbstractHdfProxy *proxy) |
void | getLongValuesOfPatch (const unsigned int &patchIndex, long *values, unsigned long long *numValuesInEachDimension, unsigned long long *offsetInEachDimension, const unsigned int &numArrayDimensions) |
void | getLongValuesOf3dPatch (const unsigned int &patchIndex, long *values, const unsigned int &valueCountInFastestDim, const unsigned int &valueCountInMiddleDim, const unsigned int &valueCountInSlowestDim, const unsigned int &offsetInFastestDim, const unsigned int &offsetInMiddleDim, const unsigned int &offsetInSlowestDim) |
Public Member Functions inherited from resqml2::AbstractProperty | |
AbstractProperty (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject) | |
AbstractProperty () | |
AbstractProperty (gsoap_resqml2_0_1::resqml2__AbstractProperty *fromGsoap) | |
virtual | ~AbstractProperty () |
void | setRepresentation (class AbstractRepresentation *rep) |
gsoap_resqml2_0_1::eml20__DataObjectReference * | getRepresentationDor () const |
class AbstractRepresentation * | getRepresentation () const |
std::string | getRepresentationUuid () const |
std::string | getRepresentationTitle () const |
std::string | getRepresentationContentType () const |
void | setTimeSeries (class TimeSeries *ts) |
TimeSeries * | getTimeSeries () const |
gsoap_resqml2_0_1::eml20__DataObjectReference * | getTimeSeriesDor () const |
std::string | getTimeSeriesUuid () const |
std::string | getTimeSeriesTitle () const |
void | setTimeIndex (const unsigned int &timeIndex, class TimeSeries *ts) |
void | setTimeStep (const unsigned int &timeStep) |
time_t | getTimestamp () const |
unsigned int | getTimeIndex () const |
void | setHdfProxy (common::AbstractHdfProxy *proxy) |
common::AbstractHdfProxy * | getHdfProxy () const |
std::string | getHdfProxyUuid () const |
unsigned int | getElementCountPerValue () const |
gsoap_resqml2_0_1::resqml2__IndexableElements | getAttachmentKind () const |
bool | isAssociatedToOneStandardEnergisticsPropertyKind () const |
std::string | getPropertyKindDescription () const |
std::string | getPropertyKindAsString () const |
std::string | getPropertyKindParentAsString () const |
gsoap_resqml2_0_1::resqml2__ResqmlPropertyKind | getEnergisticsPropertyKind () const |
void | setLocalPropertyKind (class PropertyKind *propKind) |
gsoap_resqml2_0_1::eml20__DataObjectReference * | getLocalPropertyKindDor () const |
std::string | getLocalPropertyKindUuid () const |
std::string | getLocalPropertyKindTitle () const |
class PropertyKind * | getLocalPropertyKind () const |
virtual bool | validatePropertyKindAssociation (class PropertyKind *pk)=0 |
virtual bool | validatePropertyKindAssociation (const gsoap_resqml2_0_1::resqml2__ResqmlPropertyKind &pk)=0 |
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::EpcDocument * | getEpcDocument () const |
virtual std::string | getXmlNamespace () const |
virtual std::string | getXmlTag () const =0 |
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::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 |
Protected Member Functions | |
std::string | getPathInHdfFileOfPatch (const unsigned int &patchIndex, LONG64 &nullValue) const |
std::string | pushBackRefToExistingIntegerDataset (common::AbstractHdfProxy *hdfProxy, const std::string &datasetName="", const long &nullValue=(std::numeric_limits< long >::max)()) |
Protected Member Functions inherited from resqml2::AbstractProperty | |
void | setXmlRepresentation (class AbstractRepresentation *rep) |
void | setXmlTimeSeries (TimeSeries *ts) |
void | setXmlLocalPropertyKind (class PropertyKind *propKind) |
virtual std::vector< epc::Relationship > | getAllEpcRelationships () const |
virtual 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 () |
Additional Inherited Members | |
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 resqml2::AbstractProperty | |
class AbstractLocal3dCrs * | local3dCrs |
Protected Attributes inherited from common::AbstractObject | |
gsoap_resqml2_0_1::eml20__AbstractCitedDataObject * | gsoapProxy2_0_1 |
gsoap_eml2_1::eml21__AbstractObject * | gsoapProxy2_1 |
common::EpcDocument * | epcDocument |
std::vector< resqml2::Activity * > | activitySet |
bool | updateXml |
|
inline |
Only to be used in partial transfer context
|
inline |
Default constructor Set the relationship with an AbstractRepresentation and a local property type.
|
inline |
Creates an instance of this class by wrapping a gsoap instance.
|
inlinevirtual |
Destructor does nothing since the memory is managed by the gsoap context.
void AbstractValuesProperty::createLongHdf5Array3dOfValues | ( | const unsigned int & | valueCountInFastestDim, |
const unsigned int & | valueCountInMiddleDim, | ||
const unsigned int & | valueCountInSlowestDim, | ||
common::AbstractHdfProxy * | proxy | ||
) |
Create a 3d array of explicit Long values to the property values.
valueCountInFastestDim | The number of values to write in the fastest dimension (mainly I dimension). |
valueCountInMiddleDim | The number of values to write in the middle dimension (mainly J dimension). |
valueCountInSlowestDim | The number of values to write in the slowest dimension (mainly K dimension). |
proxy | The HDF proxy where to write the property values. It must be already opened for writing and won't be closed in this method. |
void AbstractValuesProperty::createLongHdf5ArrayOfValues | ( | unsigned long long * | numValues, |
const unsigned int & | numArrayDimensions, | ||
common::AbstractHdfProxy * | proxy | ||
) |
Create an array (potentially multi dimensions) of explicit long values to the property values. No values are written to this array yet.
numValues | The number of property values ordered by dimension of the array to write. |
numArrayDimensions | The number of dimensions of the array to write. |
proxy | The HDF proxy where to write the property values. It must be already opened for writing and won't be closed in this method. |
char AbstractValuesProperty::getCharValuesOfPatch | ( | const unsigned int & | patchIndex, |
char * | values | ||
) |
Get all the values of the instance which are supposed to be char ones. Not for continuous property values.
unsigned int AbstractValuesProperty::getDimensionsCountOfPatch | ( | const unsigned int & | patchIndex | ) |
Get the count of dimension of the underlying HDF5 dataset of this property.
patchIndex | The index of the patch we want to know the dimensions in this property. |
gsoap_resqml2_0_1::resqml2__Facet AbstractValuesProperty::getFacet | ( | const unsigned int & | index | ) | const |
Get the facet at a particular index of the facet collection of this instance
unsigned int AbstractValuesProperty::getFacetCount | ( | ) | const |
Get the count of facet of this instance
std::string AbstractValuesProperty::getFacetValue | ( | const unsigned int & | index | ) | const |
Get the facet value at a particular index of the facet collection of this instance.
void AbstractValuesProperty::getIntValuesOf3dPatch | ( | const unsigned int & | patchIndex, |
int * | values, | ||
const unsigned int & | valueCountInFastestDim, | ||
const unsigned int & | valueCountInMiddleDim, | ||
const unsigned int & | valueCountInSlowestDim, | ||
const unsigned int & | offsetInFastestDim, | ||
const unsigned int & | offsetInMiddleDim, | ||
const unsigned int & | offsetInSlowestDim | ||
) |
Get all the values of the instance which are supposed to be int ones.
patchIndex | Patch index. |
values | The array (pointer) of values must be preallocated. |
valueCountInFastestDim | The number of values to write in the fastest dimension (mainly I dimension). |
valueCountInMiddleDim | The number of values to write in the middle dimension (mainly J dimension). |
valueCountInSlowestDim | The number of values to write in the slowest dimension (mainly K dimension). |
offsetInFastestDim | The offset to write in the fastest dimension (mainly I dimension). |
offsetInMiddleDim | The offset value to write in the middle dimension (mainly J dimension). |
offsetInSlowestDim | The offset value to write in the slowest dimension (mainly K dimension). |
int AbstractValuesProperty::getIntValuesOfPatch | ( | const unsigned int & | patchIndex, |
int * | values | ||
) |
Get all the values of the instance which are supposed to be int ones. Not for continuous property values.
int AbstractValuesProperty::getIntValuesOfPatch | ( | const unsigned int & | patchIndex, |
int * | values, | ||
unsigned long long * | numValuesInEachDimension, | ||
unsigned long long * | offsetInEachDimension, | ||
const unsigned int & | numArrayDimensions | ||
) |
Get some of the values of a particular patch of the instance which are supposed to be int ones. This method makes use of HDF5 hyperslabbing.
patchIndex | The index of the patch we want the values from. |
values | The array (pointer) of values must be preallocated. |
numValuesInEachDimension | The number of property values ordered by dimension of the array to write. |
offsetInEachDimension | The offset values ordered by dimension of the array to write. |
numArrayDimensions | The number of dimensions of the HDF5 array to read. |
void AbstractValuesProperty::getLongValuesOf3dPatch | ( | const unsigned int & | patchIndex, |
long * | values, | ||
const unsigned int & | valueCountInFastestDim, | ||
const unsigned int & | valueCountInMiddleDim, | ||
const unsigned int & | valueCountInSlowestDim, | ||
const unsigned int & | offsetInFastestDim, | ||
const unsigned int & | offsetInMiddleDim, | ||
const unsigned int & | offsetInSlowestDim | ||
) |
Get all the values of the instance which are supposed to be long ones.
patchIndex | Patch index. |
values | The array (pointer) of values must be preallocated. |
valueCountInFastestDim | The number of values to write in the fastest dimension (mainly I dimension). |
valueCountInMiddleDim | The number of values to write in the middle dimension (mainly J dimension). |
valueCountInSlowestDim | The number of values to write in the slowest dimension (mainly K dimension). |
offsetInFastestDim | The offset to write in the fastest dimension (mainly I dimension). |
offsetInMiddleDim | The offset value to write in the middle dimension (mainly J dimension). |
offsetInSlowestDim | The offset value to write in the slowest dimension (mainly K dimension). |
long AbstractValuesProperty::getLongValuesOfPatch | ( | const unsigned int & | patchIndex, |
long * | values | ||
) |
Get all the values of the instance which are supposed to be long ones. Not for continuous property values.
void resqml2::AbstractValuesProperty::getLongValuesOfPatch | ( | const unsigned int & | patchIndex, |
long * | values, | ||
unsigned long long * | numValuesInEachDimension, | ||
unsigned long long * | offsetInEachDimension, | ||
const unsigned int & | numArrayDimensions | ||
) |
Get all the values of the instance which are supposed to be long ones.
patchIndex | Patch index. |
values | The array (pointer) of values which must be preallocated. |
numValues | The number of property values ordered by dimension of the array to write. |
offsetValues | The offset values ordered by dimension of the array to write. |
numArrayDimensions | The number of dimensions of the array to write. |
long AbstractValuesProperty::getNullValueOfPatch | ( | const unsigned int & | patchIndex | ) |
Get the null value of the instance which are supposed to be integer ones. Not for continuous property values.
unsigned int AbstractValuesProperty::getPatchCount | ( | ) | const |
Get the number of patches in this values property. It should be the same count as the patch count of the associated representation.
|
protected |
Get the path in the hdf file of the dataset which contains the property values of a particular patch.
patchIndex | The corresponding patch index of the dataset to get. |
nullValue | If possible, this function will set this parameter to the Resqml null value of the dataset. If not, it will return long.min |
short AbstractValuesProperty::getShortValuesOfPatch | ( | const unsigned int & | patchIndex, |
short * | values | ||
) |
Get all the values of the instance which are supposed to be short ones. Not for continuous property values.
unsigned char AbstractValuesProperty::getUCharValuesOfPatch | ( | const unsigned int & | patchIndex, |
unsigned char * | values | ||
) |
Get all the values of the instance which are supposed to be unsigned char ones. Not for continuous property values.
unsigned int AbstractValuesProperty::getUIntValuesOfPatch | ( | const unsigned int & | patchIndex, |
unsigned int * | values | ||
) |
Get all the values of the instance which are supposed to be unsigned int ones. Not for continuous property values.
unsigned long AbstractValuesProperty::getULongValuesOfPatch | ( | const unsigned int & | patchIndex, |
unsigned long * | values | ||
) |
Get all the values of the instance which are supposed to be unsigned long ones. Not for continuous property values.
unsigned short AbstractValuesProperty::getUShortValuesOfPatch | ( | const unsigned int & | patchIndex, |
unsigned short * | values | ||
) |
Get all the values of the instance which are supposed to be unsigned short ones. Not for continuous property values.
unsigned int AbstractValuesProperty::getValuesCountOfDimensionOfPatch | ( | const unsigned int & | dimIndex, |
const unsigned int & | patchIndex | ||
) |
Get the count of values on a specific dimension of the underlying HDF5 dataset of this property.
dimIndex | The index of the dimension we want to know the values count in this property. |
patchIndex | The index of the patch we want to know the values count in this property. |
unsigned int AbstractValuesProperty::getValuesCountOfPatch | ( | const unsigned int & | patchIndex | ) |
Get the count of all values contained into the underlying HDF5 dataset of this property for a particular patch.
AbstractValuesProperty::hdfDatatypeEnum AbstractValuesProperty::getValuesHdfDatatype | ( | ) | const |
Get the values datatype in the HDF dataset
void AbstractValuesProperty::pushBackFacet | ( | const gsoap_resqml2_0_1::resqml2__Facet & | facet, |
const std::string & | facetValue | ||
) |
Pushes back a new facet to this intance
void AbstractValuesProperty::pushBackLongHdf5SlabArray3dOfValues | ( | long * | values, |
const unsigned int & | valueCountInFastestDim, | ||
const unsigned int & | valueCountInMiddleDim, | ||
const unsigned int & | valueCountInSlowestDim, | ||
const unsigned int & | offsetInFastestDim, | ||
const unsigned int & | offsetInMiddleDim, | ||
const unsigned int & | offsetInSlowestDim, | ||
common::AbstractHdfProxy * | proxy | ||
) |
Add a 3d array of explicit Long values to the property values.
values | All the property values to set ordered according the topology of the representation it is based on. |
valueCountInFastestDim | The number of values to write in the fastest dimension (mainly I dimension). |
valueCountInMiddleDim | The number of values to write in the middle dimension (mainly J dimension). |
valueCountInSlowestDim | The number of values to write in the slowest dimension (mainly K dimension). |
offsetInFastestDim | The offset to write in the fastest dimension (mainly I dimension). |
offsetInMiddleDim | The offset value to write in the middle dimension (mainly J dimension). |
offsetInSlowestDim | The offset value to write in the slowest dimension (mainly K dimension). |
proxy | The HDF proxy where to write the property values. It must be already opened for writing and won't be closed in this method. |
void AbstractValuesProperty::pushBackLongHdf5SlabArrayOfValues | ( | long * | values, |
unsigned long long * | numValues, | ||
unsigned long long * | offsetValues, | ||
const unsigned int & | numArrayDimensions, | ||
common::AbstractHdfProxy * | proxy | ||
) |
Add an array (potentially multi dimensions) of explicit long values to the property values. This method is to be used along with createLongHdf5ArrayOfValues.
values | All the property values to set ordered according the topology of the representation it is based on. |
numValues | The number of property values ordered by dimension of the array to write. |
offsetValues | The offset values ordered by dimension of the array to write. |
numArrayDimensions | The number of dimensions of the array to write. |
proxy | The HDF proxy where to write the property values. It must be already opened for writing and won't be closed in this method. |
|
pure virtual |
Push back a new patch of values for this property where the values have not to be written in the HDF file. The reason can be that the values already exist in an external file (only HDF5 for now) or that the writing of the values in the external file is defered in time.
hdfProxy | The HDF5 proxy where the values are already or will be stored. |
datasetName | If not provided during the method call, the dataset will be named the same as the dataset naming convention of the fesapi :"/RESQML/" + prop->uuid + "/values_patch" + patchIndex; |
nullValue | Only relevant for integer hdf5 datasets. Indeed, Resqml (and fesapi) forces null value for floating point to be NaN value. |
Implemented in resqml2_0_1::ContinuousProperty, resqml2_0_1::DiscreteProperty, resqml2_0_1::CategoricalProperty, and resqml2_0_1::CommentProperty.
|
protected |
Push back a new patch of integer values for this property where the values have not to be written in the HDF file. The reason can be that the values already exist in an external file (only HDF5 for now) or that the writing of the values in the external file is defered in time.
hdfProxy | The HDF5 proxy where the values are already or will be stored. |
datasetName | If not provided during the method call, the dataset will be named the same as the dataset naming convention of the fesapi :"/RESQML/" + prop->uuid + "/values_patch" + patchIndex; |
nullValue | Only relevant for integer hdf5 datasets. Indeed, Resqml (and fesapi) forces null value for floating point ot be NaN value. |