TSDuck v3.46-4965
MPEG Transport Stream Toolkit
Loading...
Searching...
No Matches
tsduck.Report Class Reference

Base class for TSDuck report classes. More...

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

Public Member Functions

 __init__ (self)
 Constructor for subclasses.
 debug (self, message)
 Log a messages at debug level.
 delete (self)
 Explicitly free the underlying C++ object.
 error (self, message)
 Log a messages at error level.
 info (self, message)
 Log a messages at info level.
 log (self, severity, message)
 Log a message to the report.
 setMaxSeverity (self, severity)
 Set the maximum severity of the report.
 verbose (self, message)
 Log a messages at verbose level.
 warning (self, message)
 Log a messages at warning level.

Static Public Member Functions

 header (severity)
 Formatted line prefix header for a severity.

Static Public Attributes

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

Protected Member Functions

 _getNative (self)
 Get the native object.
 _setNative (self, obj)
 Set the native object.

Detailed Description

Base class for TSDuck report classes.

Member Function Documentation

◆ header()

tsduck.Report.header ( 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.

◆ setMaxSeverity()

tsduck.Report.setMaxSeverity ( self,
severity )

Set the maximum severity of the report.

Parameters
severitySeverity level.
Returns
None.

◆ log()

tsduck.Report.log ( self,
severity,
message )

Log a message to the report.

Parameters
severitySeverity level of the message.
messageMessage to report.
Returns
None.

◆ error()

tsduck.Report.error ( self,
message )

Log a messages at error level.

Parameters
messageMessage to report.
Returns
None.

◆ warning()

tsduck.Report.warning ( self,
message )

Log a messages at warning level.

Parameters
messageMessage to report.
Returns
None.

◆ info()

tsduck.Report.info ( self,
message )

Log a messages at info level.

Parameters
messageMessage to report.
Returns
None.

◆ verbose()

tsduck.Report.verbose ( self,
message )

Log a messages at verbose level.

Parameters
messageMessage to report.
Returns
None.

◆ debug()

tsduck.Report.debug ( self,
message )

Log a messages at debug level.

Parameters
messageMessage to report.
Returns
None.

◆ delete()

tsduck.NativeObject.delete ( self)
inherited

Explicitly free the underlying C++ object.

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

Returns
None.

Reimplemented in tsduck.AbstractPluginEventHandler, tsduck.AsyncReport, tsduck.DuckContext, tsduck.InputSwitcher, tsduck.SectionFile, tsduck.SystemMonitor, and tsduck.TSProcessor.

◆ _setNative()

tsduck.NativeObject._setNative ( self,
obj )
protectedinherited

Set the native object.

This is typically done by subclass constructors.

Parameters
objAddress of the C++ native object to store.

◆ _getNative()

tsduck.NativeObject._getNative ( self)
protectedinherited

Get the native object.

This is typically used by subclasses.

Returns
Address of the C++ native object.

The documentation for this class was generated from the following file:
  • tsduck.py