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
H5BaseContainerImpl< TBase > Class Template Reference
Inheritance diagram for H5BaseContainerImpl< TBase >:
H5BaseImpl< H5BaseContainer > H5BaseContainer H5Base

Public Member Functions

virtual H5Base * clone () override
 
virtual H5BaseObject * openObject (const std::string &name) override
 Open geo-object.
 
virtual H5BaseObject * openObject (h5gt::Group group) override
 Open geo-object.
 
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 h5gt::File getH5File () const override
 Get HDF5 file.
 
virtual std::vector< h5gt::Group > getObjGroupList (const h5geo::ObjectType &objType, bool recursive) override
 Find all geo-objects of specified type within current container 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 container 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 container.
 
virtual h5geo::ContainerType getContainerType () override
 Get current container type.
 
virtual bool isEqual (H5BaseContainer *other) const override
 Does the same as operator '=='.
 
virtual bool operator== (const H5BaseContainer &other) const override
 Check if containers are the same (compares HDF5 files)
 
virtual bool operator!= (const H5BaseContainer &other) const override
 Check if containers are not the same (compares HDF5 files)
 
H5Base * clone ()
 
H5Base * clone ()
 
H5Base * clone ()
 
H5Base * clone ()
 
H5Base * clone ()
 
- Public Member Functions inherited from H5BaseImpl< H5BaseContainer >
virtual void Delete () override
 

Protected Member Functions

 H5BaseContainerImpl (const h5gt::File &h5File)
 
- Protected Member Functions inherited from H5BaseImpl< H5BaseContainer >
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::File h5File
 

Friends

H5BaseContainer * h5geo::openBaseContainer (h5gt::File h5File)
 
H5BaseContainer * h5geo::openBaseContainerByName (const std::string &fileName)
 
H5BaseContainer * h5geo::openContainer (h5gt::File h5File)
 

Additional Inherited Members

- Static Protected Member Functions inherited from H5BaseImpl< H5BaseContainer >
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/6]

H5Base * H5BaseContainerImpl< H5BaseContainer >::clone ( )
virtual

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

Reimplemented from H5BaseImpl< H5BaseContainer >.

◆ clone() [2/6]

H5Base * H5BaseContainerImpl< H5MapContainer >::clone ( )
virtual

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

Reimplemented from H5BaseImpl< H5BaseContainer >.

◆ clone() [3/6]

H5Base * H5BaseContainerImpl< H5SeisContainer >::clone ( )
virtual

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

Reimplemented from H5BaseImpl< H5BaseContainer >.

◆ clone() [4/6]

H5Base * H5BaseContainerImpl< H5VolContainer >::clone ( )
virtual

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

Reimplemented from H5BaseImpl< H5BaseContainer >.

◆ clone() [5/6]

H5Base * H5BaseContainerImpl< H5WellContainer >::clone ( )
virtual

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

Reimplemented from H5BaseImpl< H5BaseContainer >.

◆ clone() [6/6]

template<typename TBase = H5BaseContainer>
virtual H5Base * H5BaseContainerImpl< TBase >::clone ( )
overridevirtual

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

Reimplemented from H5BaseImpl< H5BaseContainer >.

◆ createHorizon() [1/2]

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

Implements H5BaseContainer.

◆ createHorizon() [2/2]

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

Implements H5BaseContainer.

◆ createPoints1() [1/2]

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

Implements H5BaseContainer.

◆ createPoints1() [2/2]

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

Implements H5BaseContainer.

◆ createPoints2() [1/2]

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

Implements H5BaseContainer.

◆ createPoints2() [2/2]

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

Implements H5BaseContainer.

◆ createPoints3() [1/2]

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

Implements H5BaseContainer.

◆ createPoints3() [2/2]

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

Implements H5BaseContainer.

◆ createPoints4() [1/2]

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

Implements H5BaseContainer.

◆ createPoints4() [2/2]

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

Implements H5BaseContainer.

◆ getContainerType()

template<typename TBase >
h5geo::ContainerType H5BaseContainerImpl< TBase >::getContainerType ( )
overridevirtual

Get current container type.

Implements H5BaseContainer.

◆ getH5File()

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

Get HDF5 file.

Implements H5BaseContainer.

◆ getObjCount()

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

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

Implements H5BaseContainer.

◆ getObjGroupList()

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

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

Implements H5BaseContainer.

◆ getObjNameList()

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

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

Implements H5BaseContainer.

◆ isEqual()

template<typename TBase >
bool H5BaseContainerImpl< TBase >::isEqual ( H5BaseContainer * other) const
overridevirtual

Does the same as operator '=='.

Implements H5BaseContainer.

◆ openHorizon() [1/2]

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

Implements H5BaseContainer.

◆ openHorizon() [2/2]

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

Implements H5BaseContainer.

◆ openObject() [1/2]

template<typename TBase >
H5BaseObject * H5BaseContainerImpl< TBase >::openObject ( const std::string & name)
overridevirtual

Open geo-object.

Check if HDF5 object belongs to any H5BaseObject derived type and create appropriate object.
Use dynamic_cast<> to cast it to the correct type.

Implements H5BaseContainer.

◆ openObject() [2/2]

template<typename TBase >
H5BaseObject * H5BaseContainerImpl< TBase >::openObject ( h5gt::Group group)
overridevirtual

Open geo-object.

Check if HDF5 object belongs to any H5BaseObject derived type and create appropriate object.
Use dynamic_cast<> to cast it to the correct type.

Implements H5BaseContainer.

◆ openPoints() [1/2]

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

Open H5BasePoints derived points.

Implements H5BaseContainer.

◆ openPoints() [2/2]

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

Open H5BasePoints derived points.

Implements H5BaseContainer.

◆ operator!=()

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

Check if containers are not the same (compares HDF5 files)

Implements H5BaseContainer.

◆ operator==()

template<typename TBase >
bool H5BaseContainerImpl< TBase >::operator== ( const H5BaseContainer & other) const
overridevirtual

Check if containers are the same (compares HDF5 files)

Implements H5BaseContainer.

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