Isis 3 Programmer Reference
Public Member Functions | Public Attributes | List of all members
Isis::JP2Error Class Reference
High Level Cube I/O

Kakadu error messaging class. More...

#include <JP2Error.h>

Collaboration diagram for Isis::JP2Error:
Collaboration graph

Public Member Functions

void put_text (const char *message)
 <Save text from a Kakadu produced error
 
void add_text (const std::string &message)
 Write Kakadu error messages using ISIS methods.
 
void flush (bool end_of_message=false)
 Used to store accumulated Kakadu error messages.
 

Public Attributes

std::string Message
 

Detailed Description

Kakadu error messaging class.

This class is used to register a Kakadu error handler. It is necessary to register the routines put_text, add_text, and flush with the Kakadu error handler in order for the Kakadu error messages to get reported to the user.

Author
2009-12-18 Janet Barrett
History

2009-12-18 Janet Barrett - Original version.

2017-08-21 Tyler Wilson, Ian Humphrey, Summer Stapleton - Added support for new kakadu libraries. References #4809.

Definition at line 38 of file JP2Error.h.

Member Function Documentation

◆ add_text()

void Isis::JP2Error::add_text ( const std::string & message)

Write Kakadu error messages using ISIS methods.

Register add_text routine with Kakadu error and warning handling facility.

This routine places newline character between successive Kakadu produced error messages.

Definition at line 41 of file JP2Error.cpp.

◆ flush()

void Isis::JP2Error::flush ( bool end_of_message = false)

Used to store accumulated Kakadu error messages.

Register flush routine with Kakadu error and warning handling facility.

This routine writes Kakadu error messages out using ISIS preferred method.

Definition at line 52 of file JP2Error.cpp.

References Isis::IException::User.

◆ put_text()

void Isis::JP2Error::put_text ( const char * message)

<Save text from a Kakadu produced error

This class is necessary to catch the error messages produced by Kakadu so that they can be output using ISIS methods.

Place newline character between successive Kakadu produced error messages

If these routines are not registered with the Kakadu error handling facility, then the Kakadu errors will be lost and not reported to the user. Register put_text routine with Kakadu error and warning handling facility. This routine saves the text from a Kakadu produced error message.

Definition at line 31 of file JP2Error.cpp.

Member Data Documentation

◆ Message

std::string Isis::JP2Error::Message

Definition at line 51 of file JP2Error.h.

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