TSDuck Version 3.32-2780 (TSDuck - The MPEG Transport Stream Toolkit)
ts::TablesLoggerFilterInterface Class Referenceabstract

An interface which is used to filter sections in TablesLogger. More...

Inheritance diagram for ts::TablesLoggerFilterInterface:

Public Member Functions

virtual ~TablesLoggerFilterInterface ()
 Virtual destructor.
 
virtual void defineFilterOptions (Args &args) const =0
 Define section filtering command line options in an Args. More...
 
virtual bool filterSection (DuckContext &duck, const Section &section, uint16_t cas, PIDSet &more_pids)=0
 Check if a specific section must be filtered and displayed. More...
 
virtual bool loadFilterOptions (DuckContext &duck, Args &args, PIDSet &initial_pids)=0
 Load arguments from command line. More...
 

Detailed Description

An interface which is used to filter sections in TablesLogger.

This abstract interface must be implemented by classes which define filtering rules for TablesLogger. There is one main instance which comes from TSDuck. Additional instances may be defined by external extensions.

Member Function Documentation

◆ defineFilterOptions()

virtual void ts::TablesLoggerFilterInterface::defineFilterOptions ( Args args) const
pure virtual

Define section filtering command line options in an Args.

Parameters
[in,out]argsCommand line arguments to update.

Implemented in ts::TablesLoggerFilter.

◆ loadFilterOptions()

virtual bool ts::TablesLoggerFilterInterface::loadFilterOptions ( DuckContext duck,
Args args,
PIDSet initial_pids 
)
pure virtual

Load arguments from command line.

Args error indicator is set in case of incorrect arguments.

Parameters
[in,out]duckTSDuck context.
[in,out]argsCommand line arguments.
[out]initial_pidsInitial PID's that the filter would like to see.
Returns
True on success, false on error in argument line.

Implemented in ts::TablesLoggerFilter.

◆ filterSection()

virtual bool ts::TablesLoggerFilterInterface::filterSection ( DuckContext duck,
const Section section,
uint16_t  cas,
PIDSet more_pids 
)
pure virtual

Check if a specific section must be filtered and displayed.

Parameters
[in,out]duckTSDuck context.
[in]sectionThe section to check.
[in]casThe CAS id for this section.
[out]more_pidsAdditional PID's that the filter would like to see.
Returns
True if the section can be displayed, false if it must not be displayed. A section is actually displayed if all section filters returned true.

Implemented in ts::TablesLoggerFilter.


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