h5geo 0.4.0
C++17 and python API to work with geo-data (seismic, wells, maps, other in process) based on HDF5. Aimed at geoscientists and developers.
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
H5BaseObjectImpl< TBase > Class Template Reference
Inheritance diagram for H5BaseObjectImpl< TBase >:
H5BaseImpl< H5BaseObject > H5BaseObject H5Base

Public Member Functions

virtual H5BasePoints * openPoints (const std::string &name) override
 Open H5BasePoints derived points.
 
virtual H5BasePoints * openPoints (h5gt::Group group) override
 Open H5BasePoints derived points.
 
virtual H5Horizon * openHorizon (const std::string &name) override
 
virtual H5Horizon * openHorizon (h5gt::Group group) override
 
virtual H5Points1 * createPoints1 (std::string &name, H5PointsParam &p, h5geo::CreationType createFlag) override
 
virtual H5Points1 * createPoints1 (h5gt::Group group, H5PointsParam &p, h5geo::CreationType createFlag) override
 
virtual H5Points2 * createPoints2 (std::string &name, H5PointsParam &p, h5geo::CreationType createFlag) override
 
virtual H5Points2 * createPoints2 (h5gt::Group group, H5PointsParam &p, h5geo::CreationType createFlag) override
 
virtual H5Points3 * createPoints3 (std::string &name, H5PointsParam &p, h5geo::CreationType createFlag) override
 
virtual H5Points3 * createPoints3 (h5gt::Group group, H5PointsParam &p, h5geo::CreationType createFlag) override
 
virtual H5Points4 * createPoints4 (std::string &name, H5PointsParam &p, h5geo::CreationType createFlag) override
 
virtual H5Points4 * createPoints4 (h5gt::Group group, H5PointsParam &p, h5geo::CreationType createFlag) override
 
virtual H5Horizon * createHorizon (std::string &name, H5HorizonParam &p, h5geo::CreationType createFlag) override
 
virtual H5Horizon * createHorizon (h5gt::Group group, H5HorizonParam &p, h5geo::CreationType createFlag) override
 
virtual H5Base * clone () override
 
virtual bool setSpatialReference (const std::string &str) override
 Set spatial reference for current geo-object using authName:code form.
 
virtual bool setSpatialReference (const std::string &authName, const std::string &code) override
 Set spatial reference for current geo-object.
 
virtual bool setLengthUnits (const std::string &str) override
 Set length units for the current geo-object.
 
virtual bool setTemporalUnits (const std::string &str) override
 Set temporal units for the current geo-object.
 
virtual bool setAngularUnits (const std::string &str) override
 Set angular units for the current geo-object.
 
virtual bool setDataUnits (const std::string &str) override
 Set data units for the current geo-object.
 
virtual bool setNullValue (double val) override
 Set NULL value for the current geo-object.
 
virtual std::string getSpatialReference () override
 Get spatial reference for current geo-object.
 
virtual std::string getLengthUnits () override
 Get length units for the current geo-object.
 
virtual std::string getTemporalUnits () override
 Get temporal units for the current geo-object.
 
virtual std::string getAngularUnits () override
 Get angular units for the current geo-object.
 
virtual std::string getDataUnits () override
 Get data units for the current geo-object.
 
virtual double getNullValue () override
 Get NULL value for the current geo-object.
 
virtual h5gt::File getH5File () const override
 Get HDF5 file.
 
virtual h5gt::Group getObjG () const override
 Get HDF5 Group.
 
virtual std::string getName () const override
 Get geo-object's name without path.
 
virtual std::string getFullName () const override
 Get geo-object's name with full path to that object.
 
virtual std::vector< h5gt::Group > getObjGroupList (const h5geo::ObjectType &objType, bool recursive) override
 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) override
 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) override
 Get number of geo-objects of specified type within current geo-object.
 
virtual bool isEqual (H5BaseObject *other) const override
 Check if geo-objects are the same.
 
virtual bool operator== (const H5BaseObject &other) const override
 Check if geo-objects are the same (compares HDF5 Groups)
 
virtual bool operator!= (const H5BaseObject &other) const override
 Check if geo-objects are not the same (compares HDF5 Groups)
 
H5Base * clone ()
 
H5Base * clone ()
 
H5Base * clone ()
 
H5Base * clone ()
 
H5Base * clone ()
 
H5Base * clone ()
 
H5Base * clone ()
 
H5Base * clone ()
 
H5Base * clone ()
 
H5Base * clone ()
 
H5Base * clone ()
 
H5Base * clone ()
 
H5Base * clone ()
 
H5Base * clone ()
 
- Public Member Functions inherited from H5BaseImpl< H5BaseObject >
virtual void Delete () override
 

Protected Member Functions

 H5BaseObjectImpl (const h5gt::Group &group)
 
std::optional< h5gt::Group > getParentG (const h5geo::ObjectType &objType)
 getParent Search for parent of type ObjectType for the objG
 
virtual std::optional< h5gt::Group > getGroupOpt (h5gt::Group &parent, const std::string &groupName) const
 
virtual std::optional< h5gt::DataSet > getDatasetOpt (const h5gt::Group &parent, const std::string &datasetName) const
 
- Protected Member Functions inherited from H5BaseImpl< H5BaseObject >
virtual std::vector< h5gt::Group > getChildGroupList (h5gt::Group &group, const h5geo::ObjectType &objType, bool recursive=false)
 
virtual std::vector< std::string > getChildNameList (h5gt::Group &group, const h5geo::ObjectType &objType, const std::string &referencePath, bool recursive=false)
 referencePath to get relative path from it (set to empty to get full path)
 
virtual size_t getChildCount (h5gt::Group &group, const h5geo::ObjectType &objType, bool recursive=false)
 
std::optional< h5gt::Group > createObject (std::string &objName, h5gt::File parentFile, const h5geo::ObjectType &objType, void *p, h5geo::CreationType createFlag)
 createObject Creates new object. If CREATE_UNDER_NEW_NAME then objName will be chaged to be unique in its parent file.
 
std::optional< h5gt::Group > createObject (std::string &objName, h5gt::Group parentGroup, const h5geo::ObjectType &objType, void *p, h5geo::CreationType createFlag)
 createObject Creates new object. If CREATE_UNDER_NEW_NAME then objName will be chaged to be unique in its parent group.
 
std::optional< h5gt::Group > createObject (h5gt::Group objG, const h5geo::ObjectType &objType, void *p, h5geo::CreationType createFlag)
 
bool isSuccessor (const h5gt::Group &parentG, const h5gt::Group &childG)
 isSuccessor checks whether childG is successor of parentG
 
bool isSuccessor (const std::string &parent, const std::string &child)
 isSuccessor works only with absolute path!
 

Protected Attributes

h5gt::Group objG
 

Friends

H5BaseObject * h5geo::openBaseObject (h5gt::Group group)
 

Additional Inherited Members

- Static Protected Member Functions inherited from H5BaseImpl< H5BaseObject >
static std::optional< h5gt::File > createContainer (std::string &fileName, const h5geo::ContainerType &containerType, h5geo::CreationType createFlag)
 
static std::optional< h5gt::File > createContainer (h5gt::File h5File, const h5geo::ContainerType &containerType, h5geo::CreationType createFlag)
 

Member Function Documentation

◆ clone() [1/15]

H5Base * H5BaseObjectImpl< H5BaseObject >::clone ( )
virtual

Must be manually deleted and must be reimplemented in H5BaseObjectImpl<T> and H5BaseContainerImpl<T>

Reimplemented from H5BaseImpl< H5BaseObject >.

◆ clone() [2/15]

H5Base * H5BaseObjectImpl< H5Map >::clone ( )
virtual

Must be manually deleted and must be reimplemented in H5BaseObjectImpl<T> and H5BaseContainerImpl<T>

Reimplemented from H5BaseImpl< H5BaseObject >.

◆ clone() [3/15]

H5Base * H5BaseObjectImpl< H5Seis >::clone ( )
virtual

Must be manually deleted and must be reimplemented in H5BaseObjectImpl<T> and H5BaseContainerImpl<T>

Reimplemented from H5BaseImpl< H5BaseObject >.

◆ clone() [4/15]

H5Base * H5BaseObjectImpl< H5Vol >::clone ( )
virtual

Must be manually deleted and must be reimplemented in H5BaseObjectImpl<T> and H5BaseContainerImpl<T>

Reimplemented from H5BaseImpl< H5BaseObject >.

◆ clone() [5/15]

H5Base * H5BaseObjectImpl< H5Well >::clone ( )
virtual

Must be manually deleted and must be reimplemented in H5BaseObjectImpl<T> and H5BaseContainerImpl<T>

Reimplemented from H5BaseImpl< H5BaseObject >.

◆ clone() [6/15]

H5Base * H5BaseObjectImpl< H5DevCurve >::clone ( )
virtual

Must be manually deleted and must be reimplemented in H5BaseObjectImpl<T> and H5BaseContainerImpl<T>

Reimplemented from H5BaseImpl< H5BaseObject >.

◆ clone() [7/15]

H5Base * H5BaseObjectImpl< H5LogCurve >::clone ( )
virtual

Must be manually deleted and must be reimplemented in H5BaseObjectImpl<T> and H5BaseContainerImpl<T>

Reimplemented from H5BaseImpl< H5BaseObject >.

◆ clone() [8/15]

H5Base * H5BaseObjectImpl< H5BasePoints >::clone ( )
virtual

Must be manually deleted and must be reimplemented in H5BaseObjectImpl<T> and H5BaseContainerImpl<T>

Reimplemented from H5BaseImpl< H5BaseObject >.

◆ clone() [9/15]

H5Base * H5BaseObjectImpl< H5Points1 >::clone ( )
virtual

Must be manually deleted and must be reimplemented in H5BaseObjectImpl<T> and H5BaseContainerImpl<T>

Reimplemented from H5BaseImpl< H5BaseObject >.

◆ clone() [10/15]

H5Base * H5BaseObjectImpl< H5Points2 >::clone ( )
virtual

Must be manually deleted and must be reimplemented in H5BaseObjectImpl<T> and H5BaseContainerImpl<T>

Reimplemented from H5BaseImpl< H5BaseObject >.

◆ clone() [11/15]

H5Base * H5BaseObjectImpl< H5Points3 >::clone ( )
virtual

Must be manually deleted and must be reimplemented in H5BaseObjectImpl<T> and H5BaseContainerImpl<T>

Reimplemented from H5BaseImpl< H5BaseObject >.

◆ clone() [12/15]

H5Base * H5BaseObjectImpl< H5Points4 >::clone ( )
virtual

Must be manually deleted and must be reimplemented in H5BaseObjectImpl<T> and H5BaseContainerImpl<T>

Reimplemented from H5BaseImpl< H5BaseObject >.

◆ clone() [13/15]

H5Base * H5BaseObjectImpl< H5WellTops >::clone ( )
virtual

Must be manually deleted and must be reimplemented in H5BaseObjectImpl<T> and H5BaseContainerImpl<T>

Reimplemented from H5BaseImpl< H5BaseObject >.

◆ clone() [14/15]

H5Base * H5BaseObjectImpl< H5Horizon >::clone ( )
virtual

Must be manually deleted and must be reimplemented in H5BaseObjectImpl<T> and H5BaseContainerImpl<T>

Reimplemented from H5BaseImpl< H5BaseObject >.

◆ clone() [15/15]

template<typename TBase = H5BaseObject>
virtual H5Base * H5BaseObjectImpl< TBase >::clone ( )
overridevirtual

Must be manually deleted and must be reimplemented in H5BaseObjectImpl<T> and H5BaseContainerImpl<T>

Reimplemented from H5BaseImpl< H5BaseObject >.

◆ createHorizon() [1/2]

template<typename TBase >
H5Horizon * H5BaseObjectImpl< TBase >::createHorizon ( h5gt::Group group,
H5HorizonParam & p,
h5geo::CreationType createFlag )
overridevirtual

Implements H5BaseObject.

◆ createHorizon() [2/2]

template<typename TBase >
H5Horizon * H5BaseObjectImpl< TBase >::createHorizon ( std::string & name,
H5HorizonParam & p,
h5geo::CreationType createFlag )
overridevirtual

Implements H5BaseObject.

◆ createPoints1() [1/2]

template<typename TBase >
H5Points1 * H5BaseObjectImpl< TBase >::createPoints1 ( h5gt::Group group,
H5PointsParam & p,
h5geo::CreationType createFlag )
overridevirtual

Implements H5BaseObject.

◆ createPoints1() [2/2]

template<typename TBase >
H5Points1 * H5BaseObjectImpl< TBase >::createPoints1 ( std::string & name,
H5PointsParam & p,
h5geo::CreationType createFlag )
overridevirtual

Implements H5BaseObject.

◆ createPoints2() [1/2]

template<typename TBase >
H5Points2 * H5BaseObjectImpl< TBase >::createPoints2 ( h5gt::Group group,
H5PointsParam & p,
h5geo::CreationType createFlag )
overridevirtual

Implements H5BaseObject.

◆ createPoints2() [2/2]

template<typename TBase >
H5Points2 * H5BaseObjectImpl< TBase >::createPoints2 ( std::string & name,
H5PointsParam & p,
h5geo::CreationType createFlag )
overridevirtual

Implements H5BaseObject.

◆ createPoints3() [1/2]

template<typename TBase >
H5Points3 * H5BaseObjectImpl< TBase >::createPoints3 ( h5gt::Group group,
H5PointsParam & p,
h5geo::CreationType createFlag )
overridevirtual

Implements H5BaseObject.

◆ createPoints3() [2/2]

template<typename TBase >
H5Points3 * H5BaseObjectImpl< TBase >::createPoints3 ( std::string & name,
H5PointsParam & p,
h5geo::CreationType createFlag )
overridevirtual

Implements H5BaseObject.

◆ createPoints4() [1/2]

template<typename TBase >
H5Points4 * H5BaseObjectImpl< TBase >::createPoints4 ( h5gt::Group group,
H5PointsParam & p,
h5geo::CreationType createFlag )
overridevirtual

Implements H5BaseObject.

◆ createPoints4() [2/2]

template<typename TBase >
H5Points4 * H5BaseObjectImpl< TBase >::createPoints4 ( std::string & name,
H5PointsParam & p,
h5geo::CreationType createFlag )
overridevirtual

Implements H5BaseObject.

◆ getAngularUnits()

template<typename TBase >
std::string H5BaseObjectImpl< TBase >::getAngularUnits ( )
overridevirtual

Get angular units for the current geo-object.

Implements H5BaseObject.

◆ getDataUnits()

template<typename TBase >
std::string H5BaseObjectImpl< TBase >::getDataUnits ( )
overridevirtual

Get data units for the current geo-object.

Implements H5BaseObject.

◆ getFullName()

template<typename TBase >
std::string H5BaseObjectImpl< TBase >::getFullName ( ) const
overridevirtual

Get geo-object's name with full path to that object.

Implements H5BaseObject.

◆ getH5File()

template<typename TBase >
h5gt::File H5BaseObjectImpl< TBase >::getH5File ( ) const
overridevirtual

Get HDF5 file.

Implements H5BaseObject.

◆ getLengthUnits()

template<typename TBase >
std::string H5BaseObjectImpl< TBase >::getLengthUnits ( )
overridevirtual

Get length units for the current geo-object.

Implements H5BaseObject.

◆ getName()

template<typename TBase >
std::string H5BaseObjectImpl< TBase >::getName ( ) const
overridevirtual

Get geo-object's name without path.

Implements H5BaseObject.

◆ getNullValue()

template<typename TBase >
double H5BaseObjectImpl< TBase >::getNullValue ( )
overridevirtual

Get NULL value for the current geo-object.

Implements H5BaseObject.

◆ getObjCount()

template<typename TBase >
size_t H5BaseObjectImpl< TBase >::getObjCount ( const h5geo::ObjectType & objType,
bool recursive )
overridevirtual

Get number of geo-objects of specified type within current geo-object.

Implements H5BaseObject.

◆ getObjG()

template<typename TBase >
h5gt::Group H5BaseObjectImpl< TBase >::getObjG ( ) const
overridevirtual

Get HDF5 Group.

Implements H5BaseObject.

◆ getObjGroupList()

template<typename TBase >
std::vector< h5gt::Group > H5BaseObjectImpl< TBase >::getObjGroupList ( const h5geo::ObjectType & objType,
bool recursive )
overridevirtual

Find all geo-objects of specified type within current geo-object and return them as vector of Groups.

Implements H5BaseObject.

◆ getObjNameList()

template<typename TBase >
std::vector< std::string > H5BaseObjectImpl< TBase >::getObjNameList ( const h5geo::ObjectType & objType,
bool recursive )
overridevirtual

Find all geo-objects of specified type within current geo-object and return them as vector of names.

Implements H5BaseObject.

◆ getParentG()

template<typename TBase >
std::optional< h5gt::Group > H5BaseObjectImpl< TBase >::getParentG ( const h5geo::ObjectType & objType)
protected

getParent Search for parent of type ObjectType for the objG

Parameters
objType
Returns

◆ getSpatialReference()

template<typename TBase >
std::string H5BaseObjectImpl< TBase >::getSpatialReference ( )
overridevirtual

Get spatial reference for current geo-object.

Implements H5BaseObject.

◆ getTemporalUnits()

template<typename TBase >
std::string H5BaseObjectImpl< TBase >::getTemporalUnits ( )
overridevirtual

Get temporal units for the current geo-object.

Implements H5BaseObject.

◆ isEqual()

template<typename TBase >
bool H5BaseObjectImpl< TBase >::isEqual ( H5BaseObject * other) const
overridevirtual

Check if geo-objects are the same.

Same as operator ==

Implements H5BaseObject.

◆ openHorizon() [1/2]

template<typename TBase >
H5Horizon * H5BaseObjectImpl< TBase >::openHorizon ( const std::string & name)
overridevirtual

Implements H5BaseObject.

◆ openHorizon() [2/2]

template<typename TBase >
H5Horizon * H5BaseObjectImpl< TBase >::openHorizon ( h5gt::Group group)
overridevirtual

Implements H5BaseObject.

◆ openPoints() [1/2]

template<typename TBase >
H5BasePoints * H5BaseObjectImpl< TBase >::openPoints ( const std::string & name)
overridevirtual

Open H5BasePoints derived points.

Implements H5BaseObject.

◆ openPoints() [2/2]

template<typename TBase >
H5BasePoints * H5BaseObjectImpl< TBase >::openPoints ( h5gt::Group group)
overridevirtual

Open H5BasePoints derived points.

Implements H5BaseObject.

◆ operator!=()

template<typename TBase >
bool H5BaseObjectImpl< TBase >::operator!= ( const H5BaseObject & other) const
overridevirtual

Check if geo-objects are not the same (compares HDF5 Groups)

Implements H5BaseObject.

◆ operator==()

template<typename TBase >
bool H5BaseObjectImpl< TBase >::operator== ( const H5BaseObject & other) const
overridevirtual

Check if geo-objects are the same (compares HDF5 Groups)

Implements H5BaseObject.

◆ setAngularUnits()

template<typename TBase >
bool H5BaseObjectImpl< TBase >::setAngularUnits ( const std::string & str)
overridevirtual

Set angular units for the current geo-object.

Implements H5BaseObject.

◆ setDataUnits()

template<typename TBase >
bool H5BaseObjectImpl< TBase >::setDataUnits ( const std::string & str)
overridevirtual

Set data units for the current geo-object.

Implements H5BaseObject.

◆ setLengthUnits()

template<typename TBase >
bool H5BaseObjectImpl< TBase >::setLengthUnits ( const std::string & str)
overridevirtual

Set length units for the current geo-object.

Implements H5BaseObject.

◆ setNullValue()

template<typename TBase >
bool H5BaseObjectImpl< TBase >::setNullValue ( double val)
overridevirtual

Set NULL value for the current geo-object.

Implements H5BaseObject.

◆ setSpatialReference() [1/2]

template<typename TBase >
bool H5BaseObjectImpl< TBase >::setSpatialReference ( const std::string & authName,
const std::string & code )
overridevirtual

Set spatial reference for current geo-object.

Implements H5BaseObject.

◆ setSpatialReference() [2/2]

template<typename TBase >
bool H5BaseObjectImpl< TBase >::setSpatialReference ( const std::string & str)
overridevirtual

Set spatial reference for current geo-object using authName:code form.

Implements H5BaseObject.

◆ setTemporalUnits()

template<typename TBase >
bool H5BaseObjectImpl< TBase >::setTemporalUnits ( const std::string & str)
overridevirtual

Set temporal units for the current geo-object.

Implements H5BaseObject.

The documentation for this class was generated from the following files:
Generated by doxygen 1.11.0