ts::TablesLoggerFilterInterface Class Reference

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

#include <tsTablesLoggerFilterInterface.h>

Inheritance diagram for ts::TablesLoggerFilterInterface:

Public Member Functions
virtual void	defineFilterOptions (Args &args) const =0
	Define section filtering command line options in an Args.
virtual bool	filterSection (DuckContext &duck, const Section &section, CASID cas, PIDSet &more_pids)=0
	Check if a specific section must be filtered and displayed.
virtual bool	loadFilterOptions (DuckContext &duck, Args &args, PIDSet &initial_pids)=0
	Load arguments from command line.
virtual bool	reset ()=0
	Reset context, if filtering restarts from the beginning for instance.

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]

args

Command 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]	duck	TSDuck context.
[in,out]	args	Command line arguments.
[out]	initial_pids	Initial PID's that the filter would like to see.

Returns

True on success, false on error in argument line.

Implemented in ts::TablesLoggerFilter.

reset()

virtual bool ts::TablesLoggerFilterInterface::reset ( )

pure virtual

Reset context, if filtering restarts from the beginning for instance.

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, CASID  cas, PIDSet &  more_pids  )

pure virtual

Check if a specific section must be filtered and displayed.

Parameters

[in,out]	duck	TSDuck context.
[in]	section	The section to check.
[in]	cas	The CAS id for this section.
[out]	more_pids	Additional 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:

• tsTablesLoggerFilterInterface.h