Proxy class for an points property. More...

#include <PointsProperty.h>

Inheritance diagram for resqml2_2::PointsProperty:

Public Member Functions
	PointsProperty (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
	PointsProperty (resqml2::AbstractRepresentation rep, const std::string &guid, const std::string &title, unsigned int dimension, gsoap_eml2_3::eml23__IndexableElement attachmentKind, eml2::AbstractLocal3dCrs localCrs, eml2::PropertyKind *localPropKind)
	PointsProperty (gsoap_eml2_3::_resqml22__PointsProperty *fromGsoap)
	~PointsProperty ()=default
uint64_t	getPatchCount () const final
std::string	pushBackRefToExistingDataset (eml2::AbstractHdfProxy *proxy, const std::string &datasetName="") final
std::string	getXmlNamespace () const final
Public Member Functions inherited from resqml2::PointsProperty
common::AbstractObject::numericalDatatypeEnum	getValuesHdfDatatype () const final
std::vector< uint32_t >	getValuesCountPerDimensionOfPatch (uint64_t patchIndex) const final
uint64_t	getXyzPointCountOfPatch (unsigned int patchIndex) const
uint64_t	getXyzPointCountOfAllPatches () const
void	getXyzPointsOfPatch (unsigned int patchIndex, double *xyzPoints) const
	Gets all the xyz points of a particular patch of this property. xyz points are given in the local CRS.
void	getXyzPointsOfPatchInGlobalCrs (unsigned int patchIndex, double *xyzPoints) const
	Gets all the xyz points of a particular patch of this property. xyz points are given in the global CRS.
void	getXyzPointsOfAllPatches (double *xyzPoints) const
	Gets all the xyz points of all patches of this property. xyz points are given in the local CRS.
void	getXyzPointsOfAllPatchesInGlobalCrs (double *xyzPoints) const
void	pushBackArray1dOfXyzPoints (const double xyzPoints, uint64_t pointCount, eml2::AbstractHdfProxy proxy=nullptr)
	Adds a 1d array of points (in local CRS) to the property.
void	pushBackArray2dOfXyzPoints (const double xyzPoints, uint64_t pointCountInFastestDim, uint64_t pointCountInSlowestDim, eml2::AbstractHdfProxy proxy=nullptr)
	Adds a 2d array of points (in local CRS) to the property.
void	pushBackArray3dOfXyzPoints (const double xyzPoints, uint64_t pointCountInFastestDim, uint64_t pointCountInMiddleDim, uint64_t pointCountInSlowestDim, eml2::AbstractHdfProxy proxy=nullptr)
	Adds a 3d array of points (in local CRS) to the property.
void	pushBackArrayOfXyzPoints (double const xyzPoints, uint64_t const pointCountByDimension, uint32_t numArrayDimensions, eml2::AbstractHdfProxy *proxy=nullptr)
	Adds an nd array of points (in local CRS) to the property.
bool	validatePropertyKindAssociation (eml2::PropertyKind *) final
bool	validatePropertyKindAssociation (gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind) final
std::string	getXmlTag () const final
Public Member Functions inherited from resqml2::AbstractProperty
virtual	~AbstractProperty ()=default
void	setRepresentation (AbstractRepresentation *rep)
common::DataObjectReference	getRepresentationDor () const
AbstractRepresentation *	getRepresentation () const
uint64_t	getElementCountPerValue () const
gsoap_eml2_3::eml23__IndexableElement	getAttachmentKind () const
uint64_t	getValuesCountOfPatch (uint64_t patchIndex) const
uint64_t	getValuesCountOfDimensionOfPatch (uint64_t dimIndex, uint64_t patchIndex) const
uint64_t	getDimensionsCountOfPatch (uint64_t patchIndex) const
std::vector< resqml2_0_1::PropertySet * >	getPropertySets () const
uint64_t	getPropertySetCount () const
resqml2_0_1::PropertySet *	getPropertySet (uint64_t index) const
void	setLocalCrs (eml2::AbstractLocal3dCrs *crs)
eml2::AbstractLocal3dCrs *	getLocalCrs () const
common::DataObjectReference	getLocalCrsDor () const
bool	hasRealizationIndices () const
std::vector< unsigned int >	getRealizationIndices () const
void	setRealizationIndices (int64_t startRealizationIndex, int64_t countRealizationIndices)
void	setRealizationIndices (const std::vector< unsigned int > &realizationIndices, eml2::AbstractHdfProxy *hdfProxy=nullptr)
	Sets the realization indices of this property.
void	setTimeSeries (eml2::TimeSeries *ts)
void	setSingleTimestamp (time_t timestamp, LONG64 yearOffset=0)
time_t	getSingleTimestamp () const
eml2::TimeSeries *	getTimeSeries () const
common::DataObjectReference	getTimeSeriesDor () const
bool	useInterval () const
bool	isAssociatedToOneStandardEnergisticsPropertyKind () const
std::string	getPropertyKindDescription () const
std::string	getPropertyKindAsString () const
std::string	getPropertyKindParentAsString () const
void	setPropertyKind (eml2::PropertyKind *propKind)
common::DataObjectReference	getPropertyKindDor () const
eml2::PropertyKind *	getPropertyKind () const
bool	validate ()
Public Member Functions inherited from common::AbstractObject
bool	isPartial () const
virtual bool	isTopLevelElement () 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	getVersion () const
void	setTitle (const std::string &title)
void	setEditor (const std::string &editor)
void	setCreation (time_t creation)
void	setCreation (const tm &creation)
void	setOriginator (const std::string &originator)
void	setDescription (const std::string &description)
void	setLastUpdate (time_t lastUpdate)
void	setLastUpdate (const tm &lastUpdate)
void	setDescriptiveKeywords (const std::string &descriptiveKeywords)
void	setVersion (const std::string &version)
void	setMetadata (const std::string &title, const std::string &editor, time_t creation, const std::string &originator, const std::string &description, time_t lastUpdate, const std::string &descriptiveKeywords)
void	serializeIntoStream (std::ostream *stream)
gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *	getEml20GsoapProxy () const
void	setGsoapProxy (gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *gsoapProxy)
gsoap_eml2_3::eml23__AbstractObject *	getEml23GsoapProxy () const
void	setGsoapProxy (gsoap_eml2_3::eml23__AbstractObject *gsoapProxy)
soap *	getGsoapContext () const
int	getGsoapType () const
gsoap_resqml2_0_1::eml20__DataObjectReference *	newResqmlReference () const
gsoap_eml2_3::eml23__DataObjectReference *	newEml23Reference () const
gsoap_resqml2_0_1::resqml20__ContactElementReference *	newContactElementReference2_0_1 () const
gsoap_eml2_3::resqml22__ContactElement *	newContactElementReference2_2 () const
common::DataObjectRepository *	getRepository () const
virtual std::string	getXmlNamespaceVersion () const
virtual std::string	getContentType () const
virtual std::string	getQualifiedType () const
virtual std::string	getPartNameInEpcDocument () const
std::string	serializeIntoString ()
void	addAlias (const std::string &authority, const std::string &title)
uint64_t	getAliasCount () const
std::string	getAliasAuthorityAtIndex (uint64_t index) const
std::string	getAliasTitleAtIndex (uint64_t index) const
std::vector< eml2::Activity * >	getActivitySet () const
uint64_t	getActivityCount () const
eml2::Activity *	getActivity (uint64_t index) const
void	pushBackExtraMetadata (const std::string &key, const std::string &value)
std::unordered_map< std::string, std::string >	getExtraMetadataSet () const
std::vector< std::string >	getExtraMetadata (const std::string &key) const
uint64_t	getExtraMetadataCount () const
std::string	getExtraMetadataKeyAtIndex (uint64_t index) const
std::string	getExtraMetadataStringValueAtIndex (uint64_t index) const
std::string	buildEtp12Uri () const
void	setUriSource (const std::string &uriSource)
const std::string &	getUriSource () const
std::string	getEpcSourceFolder () const
void	changeToPartialObject ()

Static Public Attributes
static const char *	XML_NS
Static Public Attributes inherited from resqml2::PointsProperty
static const char *	XML_TAG

Additional Inherited Members
Public Types inherited from common::AbstractObject
enum class	numericalDatatypeEnum { UNKNOWN = 0 , DOUBLE = 1 , FLOAT = 2 , INT64 = 3 , UINT64 = 4 , INT32 = 5 , UINT32 = 6 , INT16 = 7 , UINT16 = 8 , INT8 = 9 , UINT8 = 10 }
Static Public Member Functions inherited from common::AbstractObject
static void	setFormat (const std::string &vendor, const std::string &applicationName, const std::string &applicationVersionNumber)

Detailed Description

Proxy class for an points property.

Constructor & Destructor Documentation

◆ PointsProperty() [1/3]

resqml2_2::PointsProperty::PointsProperty ( gsoap_resqml2_0_1::eml20__DataObjectReference * partialObject )

inline

Only to be used in partial transfer context

Parameters

[in,out] partialObject If non-null, the partial object.

◆ PointsProperty() [2/3]

resqml2_2::PointsProperty::PointsProperty	(	resqml2::AbstractRepresentation *	rep,
		const std::string &	guid,
		const std::string &	title,
		unsigned int	dimension,
		gsoap_eml2_3::eml23__IndexableElement	attachmentKind,
		eml2::AbstractLocal3dCrs *	localCrs,
		eml2::PropertyKind *	localPropKind )

Creates a discrete property which is of a local property kind.

Exceptions

std::invalid_argument If or localPropKind is null.

Parameters

[in]	rep	The representation on which this property is attached to. It cannot be null.
	guid	The guid to set to the property. If empty then a new guid will be generated.
	title	The title to set to the property. If empty then "unknown" title will be set.
	dimension	The dimension of each value of this property. Dimension is 1 for a scalar property.
	attachmentKind	The topological element on which the property values are attached to.
	localCrs	The local CRS where the points are defined.
[in]	localPropKind	The property kind of these property values which must be defined in the EPC document as a local property kind. It cannot be null.

◆ PointsProperty() [3/3]

resqml2_2::PointsProperty::PointsProperty ( gsoap_eml2_3::_resqml22__PointsProperty * fromGsoap )

inline

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

Parameters

[in,out] fromGsoap If non-null, from gsoap.

◆ ~PointsProperty()

resqml2_2::PointsProperty::~PointsProperty ( )

virtualdefault

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

Reimplemented from resqml2::PointsProperty.

Member Function Documentation

◆ getPatchCount()

uint64_t resqml2_2::PointsProperty::getPatchCount ( ) const

finalvirtual

Gets the number of patches in this values property. It should be the same count as the patch count of the associated representation.

Exceptions

std::out_of_range If the patch count is strictly greater than unsigned int max value.

Returns: The patch count.

Implements resqml2::AbstractProperty.

◆ getXmlNamespace()

std::string resqml2_2::PointsProperty::getXmlNamespace ( ) const

inlinefinalvirtual

Get the standard XML namespace for serializing this data object.

Implements common::AbstractObject.

◆ pushBackRefToExistingDataset()

std::string resqml2_2::PointsProperty::pushBackRefToExistingDataset	(	eml2::AbstractHdfProxy *	proxy,
		const std::string &	datasetName = "" )

finalvirtual

Pushes back a reference to an existing (or a "to exist") HDF dataset in a particular HDF proxy. 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 differed in time.

Exceptions

std::invalid_argument If proxy is nullptr and no default HDF proxy is defined in the repository.

Parameters

[in]	proxy	The HDF5 proxy where the values are already or will be stored. If `nullptr`, then a default HDF proxy must be defined in the repository.
	datasetName	(Optional) The HDF5 dataset name where the values are stored. If empty, the dataset will be named the same as the dataset naming convention of fesapi : getHdfGroup() + "/points_patch" + patchIndex

Returns: The name of the referenced HDF5 dataset.

Implements resqml2::PointsProperty.

Member Data Documentation

◆ XML_NS

const char* resqml2_2::PointsProperty::XML_NS

static

The standard XML namespace for serializing this data object.

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

C:/Users/phili/dev/fesapi/fesapi-2.13.0.0/src/resqml2_2/PointsProperty.h

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PointsProperty() [1/3]

◆ PointsProperty() [2/3]

◆ PointsProperty() [3/3]

◆ ~PointsProperty()

Member Function Documentation

◆ getPatchCount()

◆ getXmlNamespace()

◆ pushBackRefToExistingDataset()

Member Data Documentation

◆ XML_NS