TSDuck Version 3.29-2595 (TSDuck - The MPEG Transport Stream Toolkit)
io.tsduck.Report Class Referenceabstract

Base class for TSDuck report classes. More...

Inheritance diagram for io.tsduck.Report:
Collaboration diagram for io.tsduck.Report:

Public Member Functions

void debug (String message)
 Log a messages at debug level. More...
 
abstract void delete ()
 Explicitly free the underlying C++ object. More...
 
void error (String message)
 Log a messages at error level. More...
 
void info (String message)
 Log a messages at info level. More...
 
native void log (int severity, String message)
 Log a message to the report. More...
 
native void setMaxSeverity (int severity)
 Set the maximum severity of the report. More...
 
void verbose (String message)
 Log a messages at verbose level. More...
 
void warning (String message)
 Log a messages at warning level. More...
 

Static Public Member Functions

static native String header (int severity)
 Formatted line prefix header for a severity. More...
 

Static Public Attributes

static final int Debug = 1
 First debug level.
 
static final int Error = -3
 Regular error.
 
static final int Fatal = -5
 Fatal error, typically aborts the application.
 
static final int Info = -1
 Information message.
 
static final int Severe = -4
 Severe error.
 
static final int Verbose = 0
 Verbose information.
 
static final int Warning = -2
 Warning message.
 

Protected Attributes

long nativeObject = 0
 The address of the underlying C++ object. More...
 

Detailed Description

Base class for TSDuck report classes.

Member Function Documentation

◆ setMaxSeverity()

native void io.tsduck.Report.setMaxSeverity ( int  severity)

Set the maximum severity of the report.

Parameters
severitySeverity level.

◆ log()

native void io.tsduck.Report.log ( int  severity,
String  message 
)

Log a message to the report.

Parameters
severitySeverity level of the message.
messageMessage to report.

◆ error()

void io.tsduck.Report.error ( String  message)
inline

Log a messages at error level.

Parameters
messageMessage to report.

◆ warning()

void io.tsduck.Report.warning ( String  message)
inline

Log a messages at warning level.

Parameters
messageMessage to report.

◆ info()

void io.tsduck.Report.info ( String  message)
inline

Log a messages at info level.

Parameters
messageMessage to report.

◆ verbose()

void io.tsduck.Report.verbose ( String  message)
inline

Log a messages at verbose level.

Parameters
messageMessage to report.

◆ debug()

void io.tsduck.Report.debug ( String  message)
inline

Log a messages at debug level.

Parameters
messageMessage to report.

◆ header()

static native String io.tsduck.Report.header ( int  severity)
static

Formatted line prefix header for a severity.

Parameters
severitySeverity value.
Returns
A string to prepend to messages. Empty for Info and Verbose levels.

◆ delete()

abstract void io.tsduck.NativeObject.delete ( )
abstractinherited

Explicitly free the underlying C++ object.

After this call, the object becomes unusable. Most usages are unpredictable but most likely will do nothing.

Reimplemented in io.tsduck.TSProcessor, io.tsduck.SystemMonitor, io.tsduck.SectionFile, io.tsduck.NullReport, io.tsduck.InputSwitcher, io.tsduck.ErrReport, io.tsduck.DuckContext, io.tsduck.AsyncReport, io.tsduck.AbstractSyncReport, io.tsduck.AbstractPluginEventHandler, and io.tsduck.AbstractAsyncReport.

Member Data Documentation

◆ nativeObject

long io.tsduck.NativeObject.nativeObject = 0
protectedinherited

The address of the underlying C++ object.

It is normally accessed by native methods only.


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