TSDuck Version 3.29-2562 (TSDuck - The MPEG Transport Stream Toolkit)
tsduck.AbstractSyncReport Class Reference

An abstract Report class which can be derived by applications to get log messages. More...

Inheritance diagram for tsduck.AbstractSyncReport:
Collaboration diagram for tsduck.AbstractSyncReport:

Public Member Functions

def __init__ (self, severity=Report.Info)
 Constructor. More...
 
def debug (self, message)
 Log a messages at debug level. More...
 
def delete (self)
 Explicitly free the underlying C++ object. More...
 
def error (self, message)
 Log a messages at error level. More...
 
def info (self, message)
 Log a messages at info level. More...
 
def log (self, severity, message)
 Log a message to the report. More...
 
def setMaxSeverity (self, severity)
 Set the maximum severity of the report. More...
 
def terminate (self)
 Synchronously terminates the async log thread. More...
 
def verbose (self, message)
 Log a messages at verbose level. More...
 
def warning (self, message)
 Log a messages at warning level. More...
 

Static Public Member Functions

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

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.
 

Detailed Description

An abstract Report class which can be derived by applications to get log messages.

This class synchronously logs messages and is not thread-safe.

Constructor & Destructor Documentation

◆ __init__()

def tsduck.AbstractSyncReport.__init__ (   self,
  severity = Report.Info 
)

Constructor.

Parameters
severityInitial severity.

Member Function Documentation

◆ delete()

def tsduck.AsyncReport.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 from tsduck.NativeObject.

◆ terminate()

def tsduck.AsyncReport.terminate (   self)
inherited

Synchronously terminates the async log thread.

Returns
None.

◆ header()

def tsduck.Report.header (   severity)
staticinherited

Formatted line prefix header for a severity.

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

◆ setMaxSeverity()

def tsduck.Report.setMaxSeverity (   self,
  severity 
)
inherited

Set the maximum severity of the report.

Parameters
severitySeverity level.
Returns
None.

◆ log()

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

Log a message to the report.

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

◆ error()

def tsduck.Report.error (   self,
  message 
)
inherited

Log a messages at error level.

Parameters
messageMessage to report.
Returns
None.

◆ warning()

def tsduck.Report.warning (   self,
  message 
)
inherited

Log a messages at warning level.

Parameters
messageMessage to report.
Returns
None.

◆ info()

def tsduck.Report.info (   self,
  message 
)
inherited

Log a messages at info level.

Parameters
messageMessage to report.
Returns
None.

◆ verbose()

def tsduck.Report.verbose (   self,
  message 
)
inherited

Log a messages at verbose level.

Parameters
messageMessage to report.
Returns
None.

◆ debug()

def tsduck.Report.debug (   self,
  message 
)
inherited

Log a messages at debug level.

Parameters
messageMessage to report.
Returns
None.

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