TSDuck v3.46-4930
MPEG Transport Stream Toolkit
Loading...
Searching...
No Matches
ts::emmgmux::StreamTest Class Reference

#include <tsEMMGMUX.h>

Inheritance diagram for ts::emmgmux::StreamTest:
Collaboration diagram for ts::emmgmux::StreamTest:

Public Member Functions

 StreamTest (const ts::tlv::MessageFactory &fact)
 Constructor from a message factory.
 StreamTest (const ts::tlv::Protocol &proto)
 Constructor with version from protocol.
 StreamTest (ts::tlv::VERSION version)
 Constructor with version.
virtual ts::UString dump (size_t indent=0) const override
void forceProtocolVersion (VERSION version)
bool hasProtocolVersion () const
VERSION protocolVersion () const
void serialize (Serializer &zer) const
TAG tag () const

Public Attributes

uint16_t channel_id = 0
 Channel id.
uint32_t client_id = 0
 Client id.
uint16_t stream_id = 0
 Stream id.

Protected Types

using superclass = StreamMessage

Protected Member Functions

virtual void serializeParameters (ts::tlv::Serializer &) const override

Static Protected Member Functions

template<typename INT>
requires std::integral<INT>
static UString dumpDecimal (size_t indent, const UString &name, const INT &value)
template<typename INT>
requires std::integral<INT>
static UString dumpHexa (size_t indent, const UString &name, const INT &value)
template<typename INT>
requires std::integral<INT>
static UString dumpInteger (size_t indent, const UString &name, const INT &value)
static UString dumpOptional (size_t indent, const UString &name, bool has_value, const ByteBlock &value, uint32_t flags=UString::HEXA|UString::ASCII)
template<typename INT>
requires std::integral<INT>
static UString dumpOptionalDecimal (size_t indent, const UString &name, bool has_value, const INT &value)
template<typename INT>
requires std::integral<INT>
static UString dumpOptionalDecimal (size_t indent, const UString &name, const std::optional< INT > &value)
template<typename INT>
requires std::integral<INT>
static UString dumpOptionalHexa (size_t indent, const UString &name, bool has_value, const INT &value)
template<typename INT>
requires std::integral<INT>
static UString dumpOptionalHexa (size_t indent, const UString &name, const std::optional< INT > &value)
template<typename INT>
requires std::integral<INT>
static UString dumpOptionalInteger (size_t indent, const UString &name, bool has_value, const INT &value)
template<typename INT>
requires std::integral<INT>
static UString dumpOptionalInteger (size_t indent, const UString &name, const std::optional< INT > &value)
template<typename INT>
requires std::integral<INT>
static UString dumpVector (size_t indent, const UString &name, const std::vector< INT > &val, UString(*toString)(INT)=nullptr)
static UString dumpVector (size_t indent, const UString &name, const UStringVector &value)

Detailed Description

EMMG/PDG <=> MUX stream_test command

Member Typedef Documentation

◆ superclass

Alias for the superclass of subclasses.

Constructor & Destructor Documentation

◆ StreamTest() [1/3]

ts::emmgmux::StreamTest::StreamTest ( ts::tlv::VERSION version)
inline

Constructor with version.

Parameters
[in]versionProtocol version.

◆ StreamTest() [2/3]

ts::emmgmux::StreamTest::StreamTest ( const ts::tlv::Protocol & proto)
inline

Constructor with version from protocol.

Parameters
[in]protoProtocol definition.

◆ StreamTest() [3/3]

ts::emmgmux::StreamTest::StreamTest ( const ts::tlv::MessageFactory & fact)

Constructor from a message factory.

Parameters
[in]factMessage factory.

Member Function Documentation

◆ dump()

virtual ts::UString ts::emmgmux::StreamTest::dump ( size_t indent = 0) const
overridevirtual

Dump routine. Create a string representing the message content. The implementation in the base class dumps the common fields. Can be used by subclasses.

Parameters
[in]indentLeft indentation size.
Returns
A string representing the message.

Reimplemented from ts::tlv::Message.

◆ serializeParameters()

virtual void ts::emmgmux::StreamTest::serializeParameters ( ts::tlv::Serializer & zer) const
overrideprotectedvirtual

Parameter serialization. This protected pure virtual method must be implemented by subclasses to serialize their parameters.

Parameters
[in,out]zerA TLV serializer.

Implements ts::tlv::Message.

◆ hasProtocolVersion()

bool ts::tlv::Message::hasProtocolVersion ( ) const
inlineinherited

Check if the message has a protocol version number.

Returns
True if the message has a protocol version number.

◆ protocolVersion()

VERSION ts::tlv::Message::protocolVersion ( ) const
inlineinherited

Get the protocol version number.

Returns
The protocol version number.

◆ forceProtocolVersion()

void ts::tlv::Message::forceProtocolVersion ( VERSION version)
inlineinherited

Force the protocol version number to another value. Use with care.

Parameters
[in]versionThe protocol version number.

◆ tag()

TAG ts::tlv::Message::tag ( ) const
inlineinherited

Get the message tag.

Returns
The message tag.

◆ serialize()

void ts::tlv::Message::serialize ( Serializer & zer) const
inherited

Serialize the message using a Serializer.

Parameters
[in,out]zerA TLV serializer.

◆ dumpVector() [1/2]

UString ts::tlv::Message::dumpVector ( size_t indent,
const UString & name,
const UStringVector & value )
staticprotectedinherited

Dump a vector of strings (helper routine for subclasses).

Parameters
[in]indentLeft indentation size.
[in]nameParameter name.
[in]valueVector of strings.
Returns
The formatted string with embedded new-lines.

◆ dumpVector() [2/2]

template<typename INT>
requires std::integral<INT>
UString ts::tlv::Message::dumpVector ( size_t indent,
const UString & name,
const std::vector< INT > & val,
UString(* toString )(INT) = nullptr )
staticprotectedinherited

Dump a vector of integer values (helper routine for subclasses). Signed integer types are dumped in decimal, unsigned types in hexadecimal.

Template Parameters
INTAn integer type.
Parameters
[in]indentLeft indentation size.
[in]nameParameter name.
[in]valVector of integer values.
[in]toStringOptional function to convert an INT value into a string.
Returns
The formatted string with embedded new-lines.

◆ dumpOptional()

UString ts::tlv::Message::dumpOptional ( size_t indent,
const UString & name,
bool has_value,
const ByteBlock & value,
uint32_t flags = UString::HEXA|UString::ASCII )
staticprotectedinherited

Dump an optional byte block (helper routine for subclasses).

Parameters
[in]indentLeft indentation size.
[in]nameParameter name.
[in]has_valueIf false, no value is available, return an empty string.
[in]valueByte block.
[in]flagsHexa dump flags for ts::Hexa().
Returns
The formatted string with embedded new-lines.

◆ dumpDecimal()

template<typename INT>
requires std::integral<INT>
UString ts::tlv::Message::dumpDecimal ( size_t indent,
const UString & name,
const INT & value )
inlinestaticprotectedinherited

Dump an integer value in decimal (helper routine for subclasses).

Template Parameters
INTAn integer type.
Parameters
[in]indentLeft indentation size.
[in]nameParameter name.
[in]valueInteger value.
Returns
The formatted string with embedded new-lines.

◆ dumpHexa()

template<typename INT>
requires std::integral<INT>
UString ts::tlv::Message::dumpHexa ( size_t indent,
const UString & name,
const INT & value )
inlinestaticprotectedinherited

Dump an integer value in hexadecimal (helper routine for subclasses).

Template Parameters
INTAn integer type.
Parameters
[in]indentLeft indentation size.
[in]nameParameter name.
[in]valueInteger value.
Returns
The formatted string with embedded new-lines.

◆ dumpInteger()

template<typename INT>
requires std::integral<INT>
UString ts::tlv::Message::dumpInteger ( size_t indent,
const UString & name,
const INT & value )
inlinestaticprotectedinherited

Dump an integer value (helper routine for subclasses). Signed integer types are dumped in decimal, unsigned types in hexadecimal.

Template Parameters
INTAn integer type.
Parameters
[in]indentLeft indentation size.
[in]nameParameter name.
[in]valueInteger value.
Returns
The formatted string with embedded new-lines.

◆ dumpOptionalDecimal() [1/2]

template<typename INT>
requires std::integral<INT>
UString ts::tlv::Message::dumpOptionalDecimal ( size_t indent,
const UString & name,
bool has_value,
const INT & value )
inlinestaticprotectedinherited

Dump an optional integer value in decimal (helper routine for subclasses).

Template Parameters
INTAn integer type.
Parameters
[in]indentLeft indentation size.
[in]nameParameter name.
[in]has_valueIf false, no value is available, return an empty string.
[in]valueInteger value.
Returns
The formatted string with embedded new-lines.

◆ dumpOptionalDecimal() [2/2]

template<typename INT>
requires std::integral<INT>
UString ts::tlv::Message::dumpOptionalDecimal ( size_t indent,
const UString & name,
const std::optional< INT > & value )
inlinestaticprotectedinherited

Dump an optional integer value in decimal (helper routine for subclasses).

Template Parameters
INTAn integer type.
Parameters
[in]indentLeft indentation size.
[in]nameParameter name.
[in]valueInteger value.
Returns
The formatted string with embedded new-lines.

◆ dumpOptionalHexa() [1/2]

template<typename INT>
requires std::integral<INT>
UString ts::tlv::Message::dumpOptionalHexa ( size_t indent,
const UString & name,
bool has_value,
const INT & value )
inlinestaticprotectedinherited

Dump an optional integer value in hexadecimal (helper routine for subclasses).

Template Parameters
INTAn integer type.
Parameters
[in]indentLeft indentation size.
[in]nameParameter name.
[in]has_valueIf false, no value is available, return an empty string.
[in]valueInteger value.
Returns
The formatted string with embedded new-lines.

◆ dumpOptionalHexa() [2/2]

template<typename INT>
requires std::integral<INT>
UString ts::tlv::Message::dumpOptionalHexa ( size_t indent,
const UString & name,
const std::optional< INT > & value )
inlinestaticprotectedinherited

Dump an optional integer value in hexadecimal (helper routine for subclasses).

Template Parameters
INTAn integer type.
Parameters
[in]indentLeft indentation size.
[in]nameParameter name.
[in]valueInteger value.
Returns
The formatted string with embedded new-lines.

◆ dumpOptionalInteger() [1/2]

template<typename INT>
requires std::integral<INT>
UString ts::tlv::Message::dumpOptionalInteger ( size_t indent,
const UString & name,
bool has_value,
const INT & value )
inlinestaticprotectedinherited

Dump an optional integer value (helper routine for subclasses). Signed integer types are dumped in decimal, unsigned types in hexadecimal.

Template Parameters
INTAn integer type.
Parameters
[in]indentLeft indentation size.
[in]nameParameter name.
[in]has_valueIf false, no value is available, return an empty string.
[in]valueInteger value.
Returns
The formatted string with embedded new-lines.

◆ dumpOptionalInteger() [2/2]

template<typename INT>
requires std::integral<INT>
UString ts::tlv::Message::dumpOptionalInteger ( size_t indent,
const UString & name,
const std::optional< INT > & value )
inlinestaticprotectedinherited

Dump an optional integer value (helper routine for subclasses). Signed integer types are dumped in decimal, unsigned types in hexadecimal.

Template Parameters
INTAn integer type.
Parameters
[in]indentLeft indentation size.
[in]nameParameter name.
[in]valueInteger value.
Returns
The formatted string with embedded new-lines.

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