Inheritance diagram for H5MapImpl:

Public Member Functions
virtual bool	writeData (Eigen::Ref< Eigen::MatrixXd > M, const std::string &dataUnits="") override
	Write data to DataSet.

virtual Eigen::MatrixXd	getData (const std::string &dataUnits="") override
	Read data from DataSet.

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

virtual bool	setOrigin (Eigen::Ref< Eigen::Vector2d > v, const std::string &lengthUnits="", bool doCoordTransform=false) override
	Set coordinates of upper-left matrix corner.

virtual bool	setPoint1 (Eigen::Ref< Eigen::Vector2d > v, const std::string &lengthUnits="", bool doCoordTransform=false) override
	Set coordinates of upper-right matrix corner.

virtual bool	setPoint2 (Eigen::Ref< Eigen::Vector2d > v, const std::string &lengthUnits="", bool doCoordTransform=false) override
	Set coordinates of bottom-left matrix corner.

virtual std::optional< h5gt::Group >	addAttributeMap (H5Map *map, std::string name="") override
	Add attribute map.

virtual std::optional< h5gt::Group >	addInternalAttributeMap (H5Map *map, std::string name="") override
	Add internal attribute map.

virtual std::optional< h5gt::Group >	addExternalAttributeMap (H5Map *map, std::string name="") override
	Add internal attribute map.

virtual bool	removeAttributeMap (const std::string &name) override
	Remove attribute map.

virtual H5Map *	openAttributeMap (const std::string &name) override
	Open attribute map.

virtual std::vector< h5gt::Group >	getAttributeMapGroupList () override
	Find and return vector of attribute maps Groups within current map.

virtual std::vector< std::string >	getAttributeMapNameList () override
	Find and return vector of attribute maps names within current map.

virtual size_t	getAttributeMapCount () override
	Get number of atribute maps within current map.

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

virtual Eigen::VectorXd	getOrigin (const std::string &lengthUnits="", bool doCoordTransform=false) override
	Get coordinates of upper-left matrix corner.

virtual Eigen::VectorXd	getPoint1 (const std::string &lengthUnits="", bool doCoordTransform=false) override
	Get coordinates of upper-right matrix corner.

virtual Eigen::VectorXd	getPoint2 (const std::string &lengthUnits="", bool doCoordTransform=false) override
	Get coordinates of bottom-left matrix corner.

virtual size_t	getNX () override
	Get number of Eigen column-major matrix columns.

virtual size_t	getNY () override
	Get number of Eigen column-major matrix rows.

virtual H5MapParam	getParam () override
	Get parameters that were used to create current map.

virtual H5MapContainer *	openMapContainer () const override
	Open H5MapContainer where current map resides.

virtual std::optional< h5gt::DataSet >	getMapD () const override
	Get current map's DataSet.

Public Member Functions inherited from H5BaseObjectImpl< H5Map >
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

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 ()

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)

Public Member Functions inherited from H5BaseImpl< H5Map >
virtual void	Delete () override

Protected Member Functions
	H5MapImpl (const h5gt::Group &group)

Protected Member Functions inherited from H5BaseObjectImpl< H5Map >
	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< H5Map >
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!

Friends
class	H5MapContainerImpl

class	H5BaseObjectImpl< H5Map >

H5Map *	h5geo::openMap (h5gt::Group group)

Additional Inherited Members
Static Protected Member Functions inherited from H5BaseImpl< H5Map >
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)

Protected Attributes inherited from H5BaseObjectImpl< H5Map >
h5gt::Group	objG

Member Function Documentation

◆ addAttributeMap()

std::optional< h5gt::Group > H5MapImpl::addAttributeMap	(	H5Map *	map,
		std::string	name = "" )

overridevirtual

Add attribute map.

Check if current map and attribute map reside in the same hdf5 container or not (create 'Internal' or 'External' attribute map).
The nX and nY must be equal.
Attribute map is a regular H5Map but resides within parent map.

Parameters

map	map to be used as attribute
name	name for an attribute map

Returns: Group of newly created attribute map

Implements H5Map.

◆ addExternalAttributeMap()

std::optional< h5gt::Group > H5MapImpl::addExternalAttributeMap	(	H5Map *	map,
		std::string	name = "" )

overridevirtual

Add internal attribute map.

Both map and attribute map reside in different HDF5 containers.
Created attribute map is simply HDF5 EXTERNAL link.

Parameters

map	map to be used as attribute
name	name for an attribute map

Returns: Group of newly created attribute map

Implements H5Map.

◆ addInternalAttributeMap()

std::optional< h5gt::Group > H5MapImpl::addInternalAttributeMap	(	H5Map *	map,
		std::string	name = "" )

overridevirtual

Add internal attribute map.

Both map and attribute map reside in the same HDF5 container.
Created attribute map is simply HDF5 SOFT link.

Parameters

map	map to be used as attribute
name	name for an attribute map

Returns: Group of newly created attribute map

Implements H5Map.

◆ getAttributeMapCount()

size_t H5MapImpl::getAttributeMapCount ( )

overridevirtual

Get number of atribute maps within current map.

Implements H5Map.

◆ getAttributeMapGroupList()

std::vector< h5gt::Group > H5MapImpl::getAttributeMapGroupList ( )

overridevirtual

Find and return vector of attribute maps Groups within current map.

Implements H5Map.

◆ getAttributeMapNameList()

std::vector< std::string > H5MapImpl::getAttributeMapNameList ( )

overridevirtual

Find and return vector of attribute maps names within current map.

Implements H5Map.

◆ getData()

Eigen::MatrixXd H5MapImpl::getData ( const std::string & dataUnits = "" )

overridevirtual

Read data from DataSet.

Implements H5Map.

◆ getDomain()

h5geo::Domain H5MapImpl::getDomain ( )

overridevirtual

Get domain (TVD, TVDSS, TWT, OWT)

Implements H5Map.

◆ getMapD()

std::optional< h5gt::DataSet > H5MapImpl::getMapD ( ) const

overridevirtual

Get current map's DataSet.

Implements H5Map.

◆ getNX()

size_t H5MapImpl::getNX ( )

overridevirtual

Get number of Eigen column-major matrix columns.

Implements H5Map.

◆ getNY()

size_t H5MapImpl::getNY ( )

overridevirtual

Get number of Eigen column-major matrix rows.

Implements H5Map.

◆ getOrigin()

Eigen::VectorXd H5MapImpl::getOrigin	(	const std::string &	lengthUnits = "",
		bool	doCoordTransform = false )

overridevirtual

Get coordinates of upper-left matrix corner.

Implements H5Map.

◆ getParam()

H5MapParam H5MapImpl::getParam ( )

overridevirtual

Get parameters that were used to create current map.

Implements H5Map.

◆ getPoint1()

Eigen::VectorXd H5MapImpl::getPoint1	(	const std::string &	lengthUnits = "",
		bool	doCoordTransform = false )

overridevirtual

Get coordinates of upper-right matrix corner.

Implements H5Map.

◆ getPoint2()

Eigen::VectorXd H5MapImpl::getPoint2	(	const std::string &	lengthUnits = "",
		bool	doCoordTransform = false )

overridevirtual

Get coordinates of bottom-left matrix corner.

Implements H5Map.

◆ openAttributeMap()

H5Map * H5MapImpl::openAttributeMap ( const std::string & name )

overridevirtual

Open attribute map.

Implements H5Map.

◆ openMapContainer()

H5MapContainer * H5MapImpl::openMapContainer ( ) const

overridevirtual

Open H5MapContainer where current map resides.

Implements H5Map.

◆ removeAttributeMap()

bool H5MapImpl::removeAttributeMap ( const std::string & name )

overridevirtual

Remove attribute map.

Implements H5Map.

◆ setDomain()

bool H5MapImpl::setDomain ( const h5geo::Domain & domain )

overridevirtual

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

Implements H5Map.

◆ setOrigin()

bool H5MapImpl::setOrigin	(	Eigen::Ref< Eigen::Vector2d >	v,
		const std::string &	lengthUnits = "",
		bool	doCoordTransform = false )

overridevirtual

Set coordinates of upper-left matrix corner.

Implements H5Map.

◆ setPoint1()

bool H5MapImpl::setPoint1	(	Eigen::Ref< Eigen::Vector2d >	v,
		const std::string &	lengthUnits = "",
		bool	doCoordTransform = false )

overridevirtual

Set coordinates of upper-right matrix corner.

Implements H5Map.

◆ setPoint2()

bool H5MapImpl::setPoint2	(	Eigen::Ref< Eigen::Vector2d >	v,
		const std::string &	lengthUnits = "",
		bool	doCoordTransform = false )

overridevirtual

Set coordinates of bottom-left matrix corner.

Implements H5Map.

◆ writeData()

bool H5MapImpl::writeData	(	Eigen::Ref< Eigen::MatrixXd >	M,
		const std::string &	dataUnits = "" )

overridevirtual

Write data to DataSet.

Implements H5Map.

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

/github/workspace/include/h5geo/private/h5mapimpl.h
/github/workspace/src/h5geo/h5mapimpl.cpp

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Member Function Documentation

◆ addAttributeMap()

◆ addExternalAttributeMap()

◆ addInternalAttributeMap()

◆ getAttributeMapCount()

◆ getAttributeMapGroupList()

◆ getAttributeMapNameList()

◆ getData()

◆ getDomain()

◆ getMapD()

◆ getNX()

◆ getNY()

◆ getOrigin()

◆ getParam()

◆ getPoint1()

◆ getPoint2()

◆ openAttributeMap()

◆ openMapContainer()

◆ removeAttributeMap()

◆ setDomain()

◆ setOrigin()

◆ setPoint1()

◆ setPoint2()

◆ writeData()