Base class for Points. More...

#include <h5basepoints.h>

Inheritance diagram for H5BasePoints:

Public Member Functions
virtual bool	setNPoints (size_t n)=0
	Resize HDF5 DataSet.

virtual bool	setDomain (const h5geo::Domain &domain)=0
	Set domain for the points (`TVD`, `TVDSS`, `TWT`, `OWT`)

virtual H5BaseContainer *	openContainer () const =0
	Open container where current points resides.

virtual size_t	getNPoints ()=0
	Return number of points.

virtual h5geo::Domain	getDomain ()=0
	Get domain (`TVD`, `TVDSS`, `TWT`, `OWT`)

virtual H5PointsParam	getParam ()=0
	Get parameters that were used to create current points.

virtual std::optional< h5gt::DataSet >	getPointsD () const =0
	Get current points DataSet.

Public Member Functions inherited from H5BaseObject
virtual H5BasePoints *	openPoints (const std::string &name)=0
	Open H5BasePoints derived points.

virtual H5BasePoints *	openPoints (h5gt::Group group)=0
	Open H5BasePoints derived points.

virtual H5Horizon *	openHorizon (const std::string &name)=0

virtual H5Horizon *	openHorizon (h5gt::Group group)=0

virtual H5Points1 *	createPoints1 (std::string &name, H5PointsParam &p, h5geo::CreationType createFlag)=0

virtual H5Points1 *	createPoints1 (h5gt::Group group, H5PointsParam &p, h5geo::CreationType createFlag)=0

virtual H5Points2 *	createPoints2 (std::string &name, H5PointsParam &p, h5geo::CreationType createFlag)=0

virtual H5Points2 *	createPoints2 (h5gt::Group group, H5PointsParam &p, h5geo::CreationType createFlag)=0

virtual H5Points3 *	createPoints3 (std::string &name, H5PointsParam &p, h5geo::CreationType createFlag)=0

virtual H5Points3 *	createPoints3 (h5gt::Group group, H5PointsParam &p, h5geo::CreationType createFlag)=0

virtual H5Points4 *	createPoints4 (std::string &name, H5PointsParam &p, h5geo::CreationType createFlag)=0

virtual H5Points4 *	createPoints4 (h5gt::Group group, H5PointsParam &p, h5geo::CreationType createFlag)=0

virtual H5Horizon *	createHorizon (std::string &name, H5HorizonParam &p, h5geo::CreationType createFlag)=0

virtual H5Horizon *	createHorizon (h5gt::Group group, H5HorizonParam &p, h5geo::CreationType createFlag)=0

virtual bool	setSpatialReference (const std::string &str)=0
	Set spatial reference for current geo-object using `authName:code` form.

virtual bool	setSpatialReference (const std::string &authName, const std::string &code)=0
	Set spatial reference for current geo-object.

virtual bool	setLengthUnits (const std::string &str)=0
	Set length units for the current geo-object.

virtual bool	setTemporalUnits (const std::string &str)=0
	Set temporal units for the current geo-object.

virtual bool	setAngularUnits (const std::string &str)=0
	Set angular units for the current geo-object.

virtual bool	setDataUnits (const std::string &str)=0
	Set data units for the current geo-object.

virtual bool	setNullValue (double val)=0
	Set NULL value for the current geo-object.

virtual std::string	getSpatialReference ()=0
	Get spatial reference for current geo-object.

virtual std::string	getLengthUnits ()=0
	Get length units for the current geo-object.

virtual std::string	getTemporalUnits ()=0
	Get temporal units for the current geo-object.

virtual std::string	getAngularUnits ()=0
	Get angular units for the current geo-object.

virtual std::string	getDataUnits ()=0
	Get data units for the current geo-object.

virtual double	getNullValue ()=0
	Get NULL value for the current geo-object.

virtual h5gt::File	getH5File () const =0
	Get HDF5 file.

virtual h5gt::Group	getObjG () const =0
	Get HDF5 Group.

virtual std::string	getName () const =0
	Get geo-object's name without path.

virtual std::string	getFullName () const =0
	Get geo-object's name with full path to that object.

virtual std::vector< h5gt::Group >	getObjGroupList (const h5geo::ObjectType &objType, bool recursive)=0
	Find all geo-objects of specified type within current geo-object and return them as vector of Groups.

virtual std::vector< std::string >	getObjNameList (const h5geo::ObjectType &objType, bool recursive)=0
	Find all geo-objects of specified type within current geo-object and return them as vector of names.

virtual size_t	getObjCount (const h5geo::ObjectType &objType, bool recursive)=0
	Get number of geo-objects of specified type within current geo-object.

virtual bool	isEqual (H5BaseObject *other) const =0
	Check if geo-objects are the same.

virtual bool	operator== (const H5BaseObject &other) const =0
	Check if geo-objects are the same (compares HDF5 Groups)

virtual bool	operator!= (const H5BaseObject &other) const =0
	Check if geo-objects are not the same (compares HDF5 Groups)

Public Member Functions inherited from H5Base
virtual H5Base *	clone ()=0

virtual void	Delete ()=0

Detailed Description

Base class for Points.

Points are objects that store data in the form: XYZ, VAL and name.
H5Points1 consists of X and name.
H5Points2 consists of X, VAL and name etc.
Maximal length of name is defined by H5GEO_CHAR_ARRAY_SIZE macro passed to cmake as CACHE var.

Member Function Documentation

◆ getDomain()

virtual h5geo::Domain H5BasePoints::getDomain ( )

pure virtual

Get domain (TVD, TVDSS, TWT, OWT)

Implemented in H5BasePointsImpl< TBase >, H5BasePointsImpl< H5Points1 >, H5BasePointsImpl< H5Points2 >, H5BasePointsImpl< H5Points3 >, H5BasePointsImpl< H5Points4 >, and H5BasePointsImpl< H5WellTops >.

◆ getNPoints()

virtual size_t H5BasePoints::getNPoints ( )

pure virtual

Return number of points.

Implemented in H5BasePointsImpl< TBase >, H5BasePointsImpl< H5Points1 >, H5BasePointsImpl< H5Points2 >, H5BasePointsImpl< H5Points3 >, H5BasePointsImpl< H5Points4 >, and H5BasePointsImpl< H5WellTops >.

◆ getParam()

virtual H5PointsParam H5BasePoints::getParam ( )

pure virtual

Get parameters that were used to create current points.

Implemented in H5BasePointsImpl< TBase >, H5BasePointsImpl< H5Points1 >, H5BasePointsImpl< H5Points2 >, H5BasePointsImpl< H5Points3 >, H5BasePointsImpl< H5Points4 >, and H5BasePointsImpl< H5WellTops >.

◆ getPointsD()

virtual std::optional< h5gt::DataSet > H5BasePoints::getPointsD ( ) const

pure virtual

Get current points DataSet.

Implemented in H5BasePointsImpl< TBase >, H5BasePointsImpl< H5Points1 >, H5BasePointsImpl< H5Points2 >, H5BasePointsImpl< H5Points3 >, H5BasePointsImpl< H5Points4 >, and H5BasePointsImpl< H5WellTops >.

◆ openContainer()

virtual H5BaseContainer * H5BasePoints::openContainer ( ) const

pure virtual

Open container where current points resides.

Implemented in H5BasePointsImpl< TBase >, H5BasePointsImpl< H5Points1 >, H5BasePointsImpl< H5Points2 >, H5BasePointsImpl< H5Points3 >, H5BasePointsImpl< H5Points4 >, and H5BasePointsImpl< H5WellTops >.

◆ setDomain()

virtual bool H5BasePoints::setDomain ( const h5geo::Domain & domain )

pure virtual

Set domain for the points (TVD, TVDSS, TWT, OWT)

Implemented in H5BasePointsImpl< TBase >, H5BasePointsImpl< H5Points1 >, H5BasePointsImpl< H5Points2 >, H5BasePointsImpl< H5Points3 >, H5BasePointsImpl< H5Points4 >, and H5BasePointsImpl< H5WellTops >.

◆ setNPoints()

virtual bool H5BasePoints::setNPoints ( size_t n )

pure virtual

Resize HDF5 DataSet.

Implemented in H5BasePointsImpl< TBase >, H5BasePointsImpl< H5Points1 >, H5BasePointsImpl< H5Points2 >, H5BasePointsImpl< H5Points3 >, H5BasePointsImpl< H5Points4 >, and H5BasePointsImpl< H5WellTops >.

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

/github/workspace/include/h5geo/h5basepoints.h

Public Member Functions

Detailed Description

Member Function Documentation

◆ getDomain()

◆ getNPoints()

◆ getParam()

◆ getPointsD()

◆ openContainer()

◆ setDomain()

◆ setNPoints()