h5geo: H5BaseContainer Class Reference

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

Base class for geo-containers. More...

#include <h5basecontainer.h>

Inheritance diagram for H5BaseContainer:

Public Member Functions
virtual H5BaseObject *	openObject (const std::string &name)=0
	Open geo-object.

virtual H5BaseObject *	openObject (h5gt::Group group)=0
	Open geo-object.

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 h5gt::File	getH5File () const =0
	Get HDF5 file.

virtual std::vector< h5gt::Group >	getObjGroupList (const h5geo::ObjectType &objType, bool recursive)=0
	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)=0
	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)=0
	Get number of geo-objects of specified type within current container.

virtual h5geo::ContainerType	getContainerType ()=0
	Get current container type.

virtual bool	isEqual (H5BaseContainer *other) const =0
	Check if containers are the same.

virtual bool	operator== (const H5BaseContainer &other) const =0
	Check if containers are the same (compares HDF5 files)

virtual bool	operator!= (const H5BaseContainer &other) const =0
	Check if containers are not the same (compares HDF5 files)

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

virtual void	Delete ()=0

Detailed Description

Base class for geo-containers.

Member Function Documentation

◆ getContainerType()

virtual h5geo::ContainerType H5BaseContainer::getContainerType ( )

pure virtual

Get current container type.

Implemented in H5BaseContainerImpl< TBase >, H5BaseContainerImpl< H5MapContainer >, H5BaseContainerImpl< H5SeisContainer >, H5BaseContainerImpl< H5VolContainer >, and H5BaseContainerImpl< H5WellContainer >.

◆ getH5File()

virtual h5gt::File H5BaseContainer::getH5File ( ) const

pure virtual

Get HDF5 file.

Implemented in H5BaseContainerImpl< TBase >, H5BaseContainerImpl< H5MapContainer >, H5BaseContainerImpl< H5SeisContainer >, H5BaseContainerImpl< H5VolContainer >, and H5BaseContainerImpl< H5WellContainer >.

◆ getObjCount()

virtual size_t H5BaseContainer::getObjCount	(	const h5geo::ObjectType &	objType,
		bool	recursive )

pure virtual

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

Implemented in H5BaseContainerImpl< TBase >, H5BaseContainerImpl< H5MapContainer >, H5BaseContainerImpl< H5SeisContainer >, H5BaseContainerImpl< H5VolContainer >, and H5BaseContainerImpl< H5WellContainer >.

◆ getObjGroupList()

virtual std::vector< h5gt::Group > H5BaseContainer::getObjGroupList	(	const h5geo::ObjectType &	objType,
		bool	recursive )

pure virtual

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

Implemented in H5BaseContainerImpl< TBase >, H5BaseContainerImpl< H5MapContainer >, H5BaseContainerImpl< H5SeisContainer >, H5BaseContainerImpl< H5VolContainer >, and H5BaseContainerImpl< H5WellContainer >.

◆ getObjNameList()

virtual std::vector< std::string > H5BaseContainer::getObjNameList	(	const h5geo::ObjectType &	objType,
		bool	recursive )

pure virtual

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

Implemented in H5BaseContainerImpl< TBase >, H5BaseContainerImpl< H5MapContainer >, H5BaseContainerImpl< H5SeisContainer >, H5BaseContainerImpl< H5VolContainer >, and H5BaseContainerImpl< H5WellContainer >.

◆ isEqual()

virtual bool H5BaseContainer::isEqual ( H5BaseContainer * other ) const

pure virtual

Check if containers are the same.

Same as operator ==

Implemented in H5BaseContainerImpl< TBase >, H5BaseContainerImpl< H5MapContainer >, H5BaseContainerImpl< H5SeisContainer >, H5BaseContainerImpl< H5VolContainer >, and H5BaseContainerImpl< H5WellContainer >.

◆ openObject() [1/2]

virtual H5BaseObject * H5BaseContainer::openObject ( const std::string & name )

pure virtual

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.

Implemented in H5BaseContainerImpl< TBase >, H5BaseContainerImpl< H5MapContainer >, H5BaseContainerImpl< H5SeisContainer >, H5BaseContainerImpl< H5VolContainer >, and H5BaseContainerImpl< H5WellContainer >.

◆ openObject() [2/2]

virtual H5BaseObject * H5BaseContainer::openObject ( h5gt::Group group )

pure virtual

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.

Implemented in H5BaseContainerImpl< TBase >, H5BaseContainerImpl< H5MapContainer >, H5BaseContainerImpl< H5SeisContainer >, H5BaseContainerImpl< H5VolContainer >, and H5BaseContainerImpl< H5WellContainer >.

◆ openPoints() [1/2]

virtual H5BasePoints * H5BaseContainer::openPoints ( const std::string & name )

pure virtual

Open H5BasePoints derived points.

Implemented in H5BaseContainerImpl< TBase >, H5BaseContainerImpl< H5MapContainer >, H5BaseContainerImpl< H5SeisContainer >, H5BaseContainerImpl< H5VolContainer >, and H5BaseContainerImpl< H5WellContainer >.

◆ openPoints() [2/2]

virtual H5BasePoints * H5BaseContainer::openPoints ( h5gt::Group group )

pure virtual

Open H5BasePoints derived points.

Implemented in H5BaseContainerImpl< TBase >, H5BaseContainerImpl< H5MapContainer >, H5BaseContainerImpl< H5SeisContainer >, H5BaseContainerImpl< H5VolContainer >, and H5BaseContainerImpl< H5WellContainer >.

◆ operator!=()

virtual bool H5BaseContainer::operator!= ( const H5BaseContainer & other ) const

pure virtual

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

Implemented in H5BaseContainerImpl< TBase >, H5BaseContainerImpl< H5MapContainer >, H5BaseContainerImpl< H5SeisContainer >, H5BaseContainerImpl< H5VolContainer >, and H5BaseContainerImpl< H5WellContainer >.

◆ operator==()

virtual bool H5BaseContainer::operator== ( const H5BaseContainer & other ) const

pure virtual

Check if containers are the same (compares HDF5 files)

Implemented in H5BaseContainerImpl< TBase >, H5BaseContainerImpl< H5MapContainer >, H5BaseContainerImpl< H5SeisContainer >, H5BaseContainerImpl< H5VolContainer >, and H5BaseContainerImpl< H5WellContainer >.

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

/github/workspace/include/h5geo/h5basecontainer.h