#include <radarlib/odimh5v21_factory.hpp>

Public Member Functions
virtual OdimObject *	create (const std::string &path)
	Create a new generic OdimH5 object and the associated file.
virtual OdimObject *	open (const std::string &path)
	Get a OdimH5 object from an existing file.
virtual OdimObject *	open (const std::string &path, int h5flags)
	Get a OdimH5 object from an existing file.
virtual PolarVolume *	createPolarVolume (const std::string &path)
	Create a new OdimH5 PVOL object and the associated file.
virtual ImageObject *	createImageObject (const std::string &path)
	Create a new OdimH5 IMAGE object and the associated file.
virtual CompObject *	createCompObject (const std::string &path)
	Create a new OdimH5 COMP object and the associated file.
virtual XsecObject *	createXsecObject (const std::string &path)
	Create a new OdimH5 XSEC object and the associated file.
virtual PolarVolume *	openPolarVolume (const std::string &path)
	Get a OdimH5 PVOL object from an existing file.
virtual PolarVolume *	openPolarVolume (const std::string &path, int h5flags)
	Get a OdimH5 PVOL object from an existing file.
virtual ImageObject *	openImageObject (const std::string &path)
	Get a OdimH5 IMAGE object from an existing file.
virtual ImageObject *	openImageObject (const std::string &path, int h5flags)
	Get a OdimH5 IMAGE object from an existing file.
virtual CompObject *	openCompObject (const std::string &path)
	Get a OdimH5 COMP object from an existing file.
virtual CompObject *	openCompObject (const std::string &path, int h5flags)
	Get a OdimH5 COMP object from an existing file.
virtual XsecObject *	openXsecObject (const std::string &path)
	Get a OdimH5 XSEC object from an existing file.
virtual XsecObject *	openXsecObject (const std::string &path, int h5flags)
	Get a OdimH5 XSEC object from an existing file.
virtual OdimObjectDumper *	getDumper ()
	Create a dumper for OdimH5 objects.

Detailed Description

    \brief OdimH5 objects factory

    \n OdimH5 objects should not be directly created with "new" operator.
    \n OdimH5 objects should be created using the a factory.
    \n This factory allow users to create generic OdimH5 object or PVOL objects (PolarVolume::) conformed to OdimH5 v2.1 specifications.

Note: if the environment variable RADARLIB_SKIP_CHECK_VERSION is equals to "yes", then this class ignores the version of the ODIM file.

    \see OdimObject | PolarVolume

Member Function Documentation

◆ create()

OdimObject * OdimH5v21::OdimFactory::create ( const std::string & path )

virtual

Create a new generic OdimH5 object and the associated file.

Parameters

path	the file path where the object will be stored

Returns: Returns the created OdimObject

Exceptions

OdimH5HDF5LibException Throwed when a HDF5 Exception occurs

Create a generic OdimH5 object and the associated file.
If the file already exists, it will be recreated.
The file will be opened for input and output operations.
In oder to create a specific OdimH5 object use the other methods of the factory

See also: OdimObject | createPolarVolume | createImageObject | createCompObject | createXsecObject

◆ open() [1/2]

OdimObject * OdimH5v21::OdimFactory::open ( const std::string & path )

virtual

Get a OdimH5 object from an existing file.

Parameters

path	the file path where the object will is stored

Returns: Returns the OdimObject stored in the file

Exceptions

OdimH5FormatException	Throwed when the HDF5 file is not a OdimH5 file
OdimH5HDF5LibException	Throwed when a HDF5 exception occurs

Get a OdimH5 object stored in an existing file.
The file will be opened for input and output operations.
If the OdimH5 object is an object supported by the factory, a specialized object will be created.

See also: openPolarVolume

◆ open() [2/2]

OdimObject * OdimH5v21::OdimFactory::open	(	const std::string &	path,
		int	h5flags )

virtual

Get a OdimH5 object from an existing file.

Parameters

path	the file path where the object will is stored
h5flags	the HDF5 I/O flags used to open the file

Returns: Returns the OdimObject stored in the file

Exceptions

OdimH5FormatException	Throwed when the HDF5 file is not a OdimH5 file
OdimH5HDF5LibException	Throwed when a HDF5 exception occurs

Get a OdimH5 object stored in an existing file
The file will be opened with the I/O options indicated
If the OdimH5 object is an object supported by the factory, a specialized object will be created.

See also: openPolarVolume | openImageObject | openCompObject | openXsecObject

◆ createPolarVolume()

PolarVolume * OdimH5v21::OdimFactory::createPolarVolume ( const std::string & path )

virtual

Create a new OdimH5 PVOL object and the associated file.

Parameters

path	the file path where the object will be stored

Returns: Returns the created PolarVolume object

Exceptions

OdimH5HDF5LibException Throwed when a HDF5 exception occurs

Create a OdimH5 PVOL object and the associated file.
If the file already exists, it will be recreated.
The file will be opened for input and output operations.

See also: PolarVolume | openPolarVolume

◆ createImageObject()

ImageObject * OdimH5v21::OdimFactory::createImageObject ( const std::string & path )

virtual

Create a new OdimH5 IMAGE object and the associated file.

Parameters

path	the file path where the object will be stored

Returns: Returns the created ImageObject object

Exceptions

OdimH5HDF5LibException Throwed when a HDF5 exception occurs

Create a OdimH5 IMAGE object and the associated file.
If the file already exists, it will be recreated.
The file will be opened for input and output operations.

See also: ImageObject | openImageObject

◆ createCompObject()

CompObject * OdimH5v21::OdimFactory::createCompObject ( const std::string & path )

virtual

Create a new OdimH5 COMP object and the associated file.

Parameters

path	the file path where the object will be stored

Returns: Returns the created CompObject object

Exceptions

OdimH5HDF5LibException Throwed when a HDF5 exception occurs

Create a OdimH5 COMP object and the associated file.
If the file already exists, it will be recreated.
The file will be opened for input and output operations.

See also: CompObject | openCompObject

◆ createXsecObject()

XsecObject * OdimH5v21::OdimFactory::createXsecObject ( const std::string & path )

virtual

Create a new OdimH5 XSEC object and the associated file.

Parameters

path	the file path where the object will be stored

Returns: Returns the created XsecObject object

Exceptions

OdimH5HDF5LibException Throwed when a HDF5 exception occurs

Create a OdimH5 XSEC object and the associated file.
If the file already exists, it will be recreated.
The file will be opened for input and output operations.

See also: XsecObject | openXsecObject

◆ openPolarVolume() [1/2]

PolarVolume * OdimH5v21::OdimFactory::openPolarVolume ( const std::string & path )

virtual

Get a OdimH5 PVOL object from an existing file.

Parameters

path	the file path where the object is stored

Returns: Returns the PolarVolume that represents the OdimH5 PVOL

Exceptions

OdimH5FormatException	Throwed when the HDF5 file is not a OdimH5 file
OdimH5HDF5LibException	Throwed when a HDF5 exception occurs

Get a OdimH5 PVOL object stored in an existing file
If the file does not contains a OdimH5 PVOL object an exception will occur
The file will be opened input and output operations

See also: openPolarVolume

◆ openPolarVolume() [2/2]

PolarVolume * OdimH5v21::OdimFactory::openPolarVolume	(	const std::string &	path,
		int	h5flags )

virtual

Get a OdimH5 PVOL object from an existing file.

Parameters

path	the file path where the object is stored
h5flags	the HDF5 I/O flags used to open the file

Returns: Returns the PolarVolume that represents the OdimH5 PVOL

Exceptions

OdimH5FormatException	Throwed when the HDF5 file is not a OdimH5 file
OdimH5HDF5LibException	Throwed when a HDF5 exception occurs

Get a OdimH5 PVOL object stored in an existing file
If the file does not contains a OdimH5 PVOL object an exception will occur
The file will be opened with the I/O options indicated

See also: openPolarVolume

◆ openImageObject() [1/2]

ImageObject * OdimH5v21::OdimFactory::openImageObject ( const std::string & path )

virtual

Get a OdimH5 IMAGE object from an existing file.

Parameters

path	the file path where the object is stored

Returns: Returns the ImageObject that represents the OdimH5 IMAGE

Exceptions

OdimH5FormatException	Throwed when the HDF5 file is not a OdimH5 file
OdimH5HDF5LibException	Throwed when a HDF5 exception occurs

Get a OdimH5 ImageObject object stored in an existing file
If the file does not contains a OdimH5 IMAGE object an exception will occur
The file will be opened input and output operations

See also: openImageObject

◆ openImageObject() [2/2]

ImageObject * OdimH5v21::OdimFactory::openImageObject	(	const std::string &	path,
		int	h5flags )

virtual

Get a OdimH5 IMAGE object from an existing file.

Parameters

path	the file path where the object is stored
h5flags	the HDF5 I/O flags used to open the file

Returns: Returns the ImageObject that represents the OdimH5 IMAGE

Exceptions

OdimH5FormatException	Throwed when the HDF5 file is not a OdimH5 file
OdimH5HDF5LibException	Throwed when a HDF5 exception occurs

Get a OdimH5 ImageObject object stored in an existing file
If the file does not contains a OdimH5 IMAGE object an exception will occur
The file will be opened with the I/O options indicated

See also: openImageObject

◆ openCompObject() [1/2]

CompObject * OdimH5v21::OdimFactory::openCompObject ( const std::string & path )

virtual

Get a OdimH5 COMP object from an existing file.

Parameters

path	the file path where the object is stored

Returns: Returns the CompObject that represents the OdimH5 COMP

Exceptions

OdimH5FormatException	Throwed when the HDF5 file is not a OdimH5 file
OdimH5HDF5LibException	Throwed when a HDF5 exception occurs

Get a OdimH5 CompObject object stored in an existing file
If the file does not contains a OdimH5 COMP object an exception will occur
The file will be opened input and output operations

See also: openCompObject

◆ openCompObject() [2/2]

CompObject * OdimH5v21::OdimFactory::openCompObject	(	const std::string &	path,
		int	h5flags )

virtual

Get a OdimH5 COMP object from an existing file.

Parameters

path	the file path where the object is stored
h5flags	the HDF5 I/O flags used to open the file

Returns: Returns the CompObject that represents the OdimH5 COMP

Exceptions

OdimH5FormatException	Throwed when the HDF5 file is not a OdimH5 file
OdimH5HDF5LibException	Throwed when a HDF5 exception occurs

Get a OdimH5 CompObject object stored in an existing file
If the file does not contains a OdimH5 COMP object an exception will occur
The file will be opened with the I/O options indicated

See also: openCompObject

◆ openXsecObject() [1/2]

XsecObject * OdimH5v21::OdimFactory::openXsecObject ( const std::string & path )

virtual

Get a OdimH5 XSEC object from an existing file.

Parameters

path	the file path where the object is stored

Returns: Returns the XsecObject that represents the OdimH5 XSEC

Exceptions

OdimH5FormatException	Throwed when the HDF5 file is not a OdimH5 file
OdimH5HDF5LibException	Throwed when a HDF5 exception occurs

Get a OdimH5 XsecObject object stored in an existing file
If the file does not contains a OdimH5 XSEC object an exception will occur
The file will be opened input and output operations

See also: openXsecObject

◆ openXsecObject() [2/2]

XsecObject * OdimH5v21::OdimFactory::openXsecObject	(	const std::string &	path,
		int	h5flags )

virtual

Get a OdimH5 XSEC object from an existing file.

Parameters

path	the file path where the object is stored
h5flags	the HDF5 I/O flags used to open the file

Returns: Returns the XsecObject that represents the OdimH5 XSEC

Exceptions

OdimH5FormatException	Throwed when the HDF5 file is not a OdimH5 file
OdimH5HDF5LibException	Throwed when a HDF5 exception occurs

Get a OdimH5 XsecObject object stored in an existing file
If the file does not contains a OdimH5 XSEC object an exception will occur
The file will be opened with the I/O options indicated

See also: openXsecObject

◆ getDumper()

OdimObjectDumper * OdimH5v21::OdimFactory::getDumper ( )

virtual

Create a dumper for OdimH5 objects.

Returns: Returns an object that can create textual representation of OdimH5 objects

The dumper created can operate on on OdimH5 v2.1 objects

See also: ObjectDumper

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

radarlib/odimh5v21_factory.hpp
radarlib/odimh5v21_factory.cpp

Public Member Functions

Detailed Description

Member Function Documentation

◆ create()

◆ open() [1/2]

◆ open() [2/2]

◆ createPolarVolume()

◆ createImageObject()

◆ createCompObject()

◆ createXsecObject()

◆ openPolarVolume() [1/2]

◆ openPolarVolume() [2/2]

◆ openImageObject() [1/2]

◆ openImageObject() [2/2]

◆ openCompObject() [1/2]

◆ openCompObject() [2/2]

◆ openXsecObject() [1/2]

◆ openXsecObject() [2/2]

◆ getDumper()