OdimH5 objects factory.
More...
#include <radarlib/odimh5v20_factory.hpp>
OdimH5 objects factory.
OdimH5 objects should not be directly created with "new" operator.
OdimH5 objects should be created using the a factory.
This factory allow users to create generic OdimH5 object or PVOL objects (PolarVolume::) conformed to OdimH5 v2.0 specifications.
- See also
- OdimObject | PolarVolume
- Examples
- dump_object.cpp, image-visitor.cpp, odimh5scanner.cpp, pvolsplitter.cpp, and visitor.cpp.
◆ create()
OdimObject * OdimH5v20::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
-
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 * OdimH5v20::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
-
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
- Examples
- dump_object.cpp, image-visitor.cpp, and visitor.cpp.
◆ open() [2/2]
OdimObject * OdimH5v20::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
-
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 * OdimH5v20::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
-
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 * OdimH5v20::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
-
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 * OdimH5v20::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
-
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 * OdimH5v20::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
-
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 * OdimH5v20::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
-
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
- Examples
- pvolsplitter.cpp.
◆ openPolarVolume() [2/2]
PolarVolume * OdimH5v20::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
-
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 * OdimH5v20::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
-
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 * OdimH5v20::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
-
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 * OdimH5v20::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
-
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 * OdimH5v20::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
-
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 * OdimH5v20::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
-
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 * OdimH5v20::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
-
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()
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.0 objects
- See also
- ObjectDumper
- Examples
- dump_object.cpp.
The documentation for this class was generated from the following files: