ts::DTVProperties Class Reference

Encapsulation of Linux DVB property lists. More...

#include <tsDTVProperties.h>

Public Member Functions
	DTVProperties ()
	Default constructor.
virtual	~DTVProperties ()
	Destructor.
size_t	add (uint32_t cmd, uint32_t data=-1)
	Add a new property.
size_t	addStat (uint32_t cmd)
	Add a new property to get statistics.
template<typename ENUM > requires std::integral<ENUM> || std::is_enum_v<ENUM>
void	addVar (uint32_t cmd, const std::optional< ENUM > &data)
	Add a new property if a variable is set.
void	clear ()
	Clear all previously added commands.
size_t	count () const
	Get the number of properties in the buffer.
uint32_t	getByCommand (uint32_t cmd) const
	Get the value of a property in the buffer.
uint32_t	getByIndex (size_t index) const
	Get the value of the property at a specified index.
::dtv_properties *	getIoctlParam ()
	Get the address of the dtv_properties structure for ioctl() call.
const ::dtv_properties *	getIoctlParam () const
	Get the address of the dtv_properties structure for ioctl() call.
bool	getStatByCommand (int64_t &value, ::fecap_scale_params &scale, uint32_t cmd, size_t layer) const
	Get the value of a statistics property in the buffer.
template<typename INT > requires std::integral<INT> || std::is_enum_v<INT>
void	getValuesByCommand (std::set< INT > &values, uint32_t cmd) const
	Get the multiple values of a property in the buffer.
template<typename INT > requires std::integral<INT> || std::is_enum_v<INT>
void	getValuesByIndex (std::set< INT > &values, size_t index) const
	Get the multiple values of a property at a specified index.
void	report (Report &report, int severity) const
	Display the content of the object (for debug purpose).
void	reportStat (Report &report, int severity) const
	Display the statistics content of the object (for debug purpose).
size_t	search (uint32_t cmd) const
	Search a property in the buffer.

Static Public Member Functions
static const char *	CommandName (uint32_t cmd)
	Return the name of a command.

Static Public Attributes
static constexpr uint32_t	UNKNOWN = ~0U
	Returned value for unknown data.

Detailed Description

Encapsulation of Linux DVB property lists.

Member Function Documentation

count()

size_t ts::DTVProperties::count ( ) const

inline

Get the number of properties in the buffer.

Returns

The number of properties in the buffer.

add()

size_t ts::DTVProperties::add	(	uint32_t	cmd,
		uint32_t	data = -1
	)

Add a new property.

Parameters

[in]	cmd	Command code.
[in]	data	Optional command data.

Returns

The index in property buffer.

addVar()

template<typename ENUM >
requires std::integral<ENUM> || std::is_enum_v<ENUM>

void ts::DTVProperties::addVar ( uint32_t  cmd, const std::optional< ENUM > &  data  )

inline

Add a new property if a variable is set.

Parameters

[in]	cmd	Command code.
[in]	data	Optional command data.

addStat()

size_t ts::DTVProperties::addStat

(

uint32_t

cmd

)

Add a new property to get statistics.

Parameters

[in]

cmd

Command code.

Returns

The index in property buffer.

search()

size_t ts::DTVProperties::search

(

uint32_t

cmd

)

const

Search a property in the buffer.

Parameters

[in]

cmd

Command code.

Returns

The index of cmd in buffer or count() if not found.

getByCommand()

uint32_t ts::DTVProperties::getByCommand

(

uint32_t

cmd

)

const

Get the value of a property in the buffer.

Parameters

[in]

cmd

Command code.

Returns

The data value of cmd in buffer or UNKNOWN if not found.

getByIndex()

uint32_t ts::DTVProperties::getByIndex

(

size_t

index

)

const

Get the value of the property at a specified index.

Parameters

[in]

index

Index in buffer.

Returns

The data value at index or UNKNOWN if out of range.

getStatByCommand()

bool ts::DTVProperties::getStatByCommand	(	int64_t &	value,
		::fecap_scale_params &	scale,
		uint32_t	cmd,
		size_t	layer
	)		const

Get the value of a statistics property in the buffer.

Parameters

[out]	value	Statistics value.
[out]	scale	Representation of the value.
[in]	cmd	Command code.
[in]	layer	Statistics layer. 0 in most case, 1..3 for ISDB sub-layers.

Returns

True on success, false on error or not available.

getValuesByCommand()

template<typename INT >
requires std::integral<INT> || std::is_enum_v<INT>

void ts::DTVProperties::getValuesByCommand	(	std::set< INT > &	values,
		uint32_t	cmd
	)		const

Get the multiple values of a property in the buffer.

To be used with properties which return a set of integer values.

Template Parameters

INT	An integer or enum type, any size, signed or unsigned.

Parameters

[out]	values	A set receiving all integer values.
[in]	cmd	Command code.

getValuesByIndex()

template<typename INT >
requires std::integral<INT> || std::is_enum_v<INT>

void ts::DTVProperties::getValuesByIndex	(	std::set< INT > &	values,
		size_t	index
	)		const

Get the multiple values of a property at a specified index.

To be used with properties which return a set of integer values.

Template Parameters

INT	An integer or enum type, any size, signed or unsigned.

Parameters

[out]	values	A set receiving all integer values.
[in]	index	Index in buffer.

getIoctlParam() [1/2]

const ::dtv_properties * ts::DTVProperties::getIoctlParam ( ) const

inline

Get the address of the dtv_properties structure for ioctl() call.

Returns

The address of the dtv_properties structure.

getIoctlParam() [2/2]

::dtv_properties * ts::DTVProperties::getIoctlParam ( )

inline

Get the address of the dtv_properties structure for ioctl() call.

Returns

The address of the dtv_properties structure.

report()

void ts::DTVProperties::report	(	Report &	report,
		int	severity
	)		const

Display the content of the object (for debug purpose).

Parameters

[in,out]	report	Where to display the content.
[in]	severity	Severity level of messages (typically a debug level).

reportStat()

void ts::DTVProperties::reportStat	(	Report &	report,
		int	severity
	)		const

Display the statistics content of the object (for debug purpose).

Parameters

[in,out]	report	Where to display the content.
[in]	severity	Severity level of messages (typically a debug level).

CommandName()

static const char * ts::DTVProperties::CommandName ( uint32_t  cmd )

inlinestatic

Return the name of a command.

Parameters

[in]

cmd

Command code.

Returns

A name for cmd or a null pointer if unknown.

---

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

• tsDTVProperties.h