ts::SignalState Class Reference

#include <tsSignalState.h>

Inheritance diagram for ts::SignalState:

Collaboration diagram for ts::SignalState:

Classes
class	Value

Public Types
enum class	Unit {   COUNTER ,   PERCENT ,   MDB }

Public Member Functions
	SignalState ()=default
virtual void	clear ()
virtual std::ostream &	display (std::ostream &strm, const UString &margin=UString(), int level=Severity::Info) const override
void	setPercent (std::optional< Value > SignalState::*field, int64_t value, int64_t min, int64_t max)
void	toJSON (json::Object &obj) const
virtual UString	toString () const override

Public Attributes
std::optional< Value >	bit_error_rate {}
std::optional< Value >	packet_error_rate {}
bool	signal_locked = false
std::optional< Value >	signal_noise_ratio {}
std::optional< Value >	signal_strength {}

Detailed Description

State of a modulated broadcast signal.

The type of information on the state of a modulated broadcast signal highly depends on the operating systems and drivers. The units also differ. The value can be in decibels or percentage. So, this structure contains many different fields which can be set or not.

Member Enumeration Documentation

Unit

enum class ts::SignalState::Unit

strong

Unit of a state value.

Enumerator
COUNTER	A raw counter value, unit is 1, whatever it means.
PERCENT	A value from 0 to 100.
MDB	Milli-decibel, unit of 0.001 dB.

Constructor & Destructor Documentation

SignalState()

ts::SignalState::SignalState ( )

default

Constructor.

Member Function Documentation

clear()

virtual void ts::SignalState::clear ( )

virtual

Clear content, reset all values, they become "unset"

toString()

virtual UString ts::SignalState::toString ( ) const

overridevirtual

Convert to a string object.

Returns

This object, converted as a string.

Implements ts::StringifyInterface.

display()

virtual std::ostream & ts::SignalState::display ( std::ostream & stream, const UString & margin = UString(), int level = Severity::Info ) const

overridevirtual

Display the content of this object to a stream.

Parameters

[in,out]	stream	The stream where to print the content. Standard output by default.
[in]	margin	The prefix string on each line, empty by default.
[in]	level	Severity level (for instance, Severity::Info or Severity::Debug may display more information).

Returns

A reference to stream.

Implements ts::DisplayInterface.

toJSON()

void ts::SignalState::toJSON

(

json::Object &

obj

)

const

Build a JSON description of this object.

Parameters

[in,out]

obj

JSON object into which the signal state information is added.

setPercent()

void ts::SignalState::setPercent	(	std::optional< Value > SignalState::*	field,
		int64_t	value,
		int64_t	min,
		int64_t	max )

Set a percentage value from a raw driver value. This method is a utility for system-specific implementations.

Parameters

[out]	field	Pointer-to-member for the field to update.
[in]	value	Raw value as returned by the driver. The field is set with a value from 0 to 100, based on the range min to max.
[in]	min	Minimum value corresponding to 0 %.
[in]	max	Maximum value corresponding to 100 %.

Member Data Documentation

signal_locked

bool ts::SignalState::signal_locked = false

Set to true when the signal is confirmed to be locked at the input of the demodulator.

signal_strength

std::optional<Value> ts::SignalState::signal_strength {}

Signal strength.

signal_noise_ratio

std::optional<Value> ts::SignalState::signal_noise_ratio {}

Signal to noise ratio (SNR).

bit_error_rate

std::optional<Value> ts::SignalState::bit_error_rate {}

Bit error rate (BER).

packet_error_rate

std::optional<Value> ts::SignalState::packet_error_rate {}

Packet error rate (PER).

---

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

• tsSignalState.h