ifw-odp 5.0.0
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | List of all members
ifw::odp::Error Class Reference

This class handle the errors produced by the calling of image processing routines. More...

#include <error.hpp>

Inheritance diagram for ifw::odp::Error:
ifw::odp::Array ifw::odp::Image ifw::odp::ImageCube ifw::odp::ImageExtensions ifw::odp::ImageProperties ifw::odp::ImageStatistics ifw::odp::Mask ifw::odp::Matrix ifw::odp::Recipe

Public Member Functions

 Error ()
 Class constructor.
 
virtual ~Error ()
 Class destructor.
 
void ResetCplError ()
 Reset CPL error and internal error flag.
 
bool CheckCplError () const
 Check if there is an error in CPL.
 

Protected Member Functions

std::string GetErrorMsg () const
 Get CPL error message.
 

Detailed Description

This class handle the errors produced by the calling of image processing routines.

Error - class that handles CPL errors.

Each CPL error will trigger a standard C++ runtime exception.

This class should be used as parent for classes where there will be an interface with CPL routines. This class also takes care of initializing and cleaning up CPL calling the corresponding CPL functions.

Constructor & Destructor Documentation

◆ Error()

ifw::odp::Error::Error ( )
explicit

Class constructor.

Returns
none

Initialize CPL core library. This is done only for the creation of the first object of this type.

◆ ~Error()

ifw::odp::Error::~Error ( )
virtual

Class destructor.

Returns
none

Stop internal CPL subsystems for the last object destroyed.

Member Function Documentation

◆ CheckCplError()

bool ifw::odp::Error::CheckCplError ( ) const

Check if there is an error in CPL.

Returns
TRUE in case CPL return error code different from zero.

◆ GetErrorMsg()

std::string ifw::odp::Error::GetErrorMsg ( ) const
protected

Get CPL error message.

Returns
Error message in a std::string object.

◆ ResetCplError()

void ifw::odp::Error::ResetCplError ( )

Reset CPL error and internal error flag.

Returns
none

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