TSDuck Version 3.24-2000 (TSDuck - The MPEG Transport Stream Toolkit)
ts::DiscontinuityInformationTable Class Reference

Representation of a Discontinuity Information Table (DIT) More...

Inheritance diagram for ts::DiscontinuityInformationTable:
Collaboration diagram for ts::DiscontinuityInformationTable:

Public Member Functions

 DiscontinuityInformationTable (bool tr=false)
 Default constructor. More...
 
 DiscontinuityInformationTable (DuckContext &duck, const BinaryTable &table)
 Constructor from a binary table. More...
 
virtual void clear ()
 This method clears the content of the table or descriptor. More...
 
virtual Standards definingStandards () const override
 Get the list of standards which define this object. More...
 
void deserialize (DuckContext &duck, const BinaryTable &bin)
 This method deserializes a binary table. More...
 
void fromXML (DuckContext &duck, const xml::Element *element)
 This method converts an XML structure to a table or descriptor in this object. More...
 
void invalidate ()
 Invalidate this object. More...
 
virtual bool isPrivate () const
 Check if the table is a private one (ie. More...
 
bool isValid () const
 Check if this object is valid. More...
 
void serialize (DuckContext &duck, BinaryTable &bin) const
 This method serializes a table. More...
 
TID tableId () const
 Get the table_id. More...
 
xml::ElementtoXML (DuckContext &duck, xml::Element *parent) const
 This method converts this object to XML. More...
 
UString xmlName () const
 Get the XMl node name representing this table or descriptor. More...
 

Static Public Member Functions

static void DisplaySection (ts::TablesDisplay &display, const ts::Section &section, ts::PSIBuffer &payload, const ts::UString &margin)
 A static method to display a section. More...
 

Public Attributes

bool transition
 Transport stream transition.
 

Static Public Attributes

static const UChar *const XML_GENERIC_DESCRIPTOR
 XML tag name for generic descriptors.
 
static const UChar *const XML_GENERIC_LONG_TABLE
 XML tag name for generic tables with long sections.
 
static const UChar *const XML_GENERIC_SHORT_TABLE
 XML tag name for generic short sections.
 

Protected Member Functions

void addOneSection (BinaryTable &table, PSIBuffer &payload) const
 Helper method for serializePayload(): add a section in a binary table. More...
 
virtual void addOneSectionImpl (BinaryTable &table, PSIBuffer &payload) const
 Actual implementation of adding one section in a binary table. More...
 
virtual bool analyzeXML (DuckContext &, const xml::Element *) override
 Helper method to convert this object from XML. More...
 
virtual void buildXML (DuckContext &, xml::Element *) const override
 Helper method to convert this object to XML. More...
 
virtual void clearContent () override
 Helper method to clear the content of the table or descriptor. More...
 
virtual void deserializePayload (PSIBuffer &, const Section &) override
 This abstract method deserializes the payload of one section. More...
 
virtual void deserializePayloadWrapper (PSIBuffer &buf, const Section &section)
 Wrapper for deserializePayload(). More...
 
virtual bool isValidTableId (TID tid) const
 This method checks if a table id is valid for this object. More...
 
virtual size_t maxPayloadSize () const
 Get the maximum size in bytes of the payload of sections of this table. More...
 
virtual void serializePayload (BinaryTable &, PSIBuffer &) const override
 This abstract method serializes the payload of all sections in the table. More...
 
virtual bool useTrailingCRC32 () const
 Check if the sections of this table have a trailing CRC32. More...
 

Protected Attributes

bool _is_valid
 It is the responsibility of the subclasses to set the valid flag.
 
TID _table_id
 The table id can be modified by subclasses only.
 

Detailed Description

Representation of a Discontinuity Information Table (DIT)

See also
ETSI 300 468, 7.1.1.

Constructor & Destructor Documentation

◆ DiscontinuityInformationTable() [1/2]

ts::DiscontinuityInformationTable::DiscontinuityInformationTable ( bool  tr = false)

Default constructor.

Parameters
[in]trTransport stream transition.

◆ DiscontinuityInformationTable() [2/2]

ts::DiscontinuityInformationTable::DiscontinuityInformationTable ( DuckContext duck,
const BinaryTable table 
)

Constructor from a binary table.

Parameters
[in,out]duckTSDuck execution context.
[in]tableBinary table to deserialize.

Member Function Documentation

◆ DisplaySection()

static void ts::DiscontinuityInformationTable::DisplaySection ( ts::TablesDisplay display,
const ts::Section section,
ts::PSIBuffer payload,
const ts::UString margin 
)
static

A static method to display a section.

Parameters
[in,out]displayDisplay engine.
[in]sectionThe section to display.
[in,out]payloadA PSIBuffer over the payload.
[in]marginLeft margin content.

◆ clearContent()

virtual void ts::DiscontinuityInformationTable::clearContent ( )
overrideprotectedvirtual

Helper method to clear the content of the table or descriptor.

It is called by clear(). In clearContent(), the subclass shall simply revert the value of all fields to their original values in the default constructor.

Implements ts::AbstractSignalization.

◆ serializePayload()

virtual void ts::DiscontinuityInformationTable::serializePayload ( BinaryTable table,
PSIBuffer buf 
) const
overrideprotectedvirtual

This abstract method serializes the payload of all sections in the table.

When serialize() is called, the output binary table is cleared and serializePayload() is called. A subclass shall implement serializePayload() which adds all required sections in the binary table.

Note that it is not necessary to explicitly add the last (or only) section. Upon return from serializePayload(), serialize() checks the state of the payload buffer. If the output binary table is still empty or if the payload buffer is not empty (or not empty after the last saved write position), then addOneSection() is automatically called.

Parameters
[in,out]tableThe binary table into which this object shall be serialized. The table is initially empty when serialize() calls serializePayload().
[in,out]bufA PSIBuffer with the appropriate size for the section payload. The payload buffer is initially empty when serialize() calls serializePayload().

Implements ts::AbstractTable.

◆ deserializePayload()

virtual void ts::DiscontinuityInformationTable::deserializePayload ( PSIBuffer buf,
const Section section 
)
overrideprotectedvirtual

This abstract method deserializes the payload of one section.

When deserialize() is called, this object is cleared and validated. Then, deserializePayload() is invoked for each section in the binary table. A subclass shall implement deserializePayload() which adds the content of the binary section to the C++ object. Do not reset the object in deserializePayload() since it is repeatedly called for each section of a single binary table.

Parameters
[in,out]bufDeserialization buffer. The subclass shall read the descriptor payload from buf. The end of read is the end of the binary payload. If any kind of error is reported in the buffer or if the payload is not completely read, the deserialization is considered as invalid.
[in]sectionA reference to the section. Can be used to access values in the section header (typically for long sections).

Implements ts::AbstractTable.

◆ buildXML()

virtual void ts::DiscontinuityInformationTable::buildXML ( DuckContext duck,
xml::Element root 
) const
overrideprotectedvirtual

Helper method to convert this object to XML.

It is called by toXML() only when the object is valid. The root element is already built with the appropriate XML node name. In buildXML(), the subclass shall simply populate the XML node.

Parameters
[in,out]rootThe root node for the new XML tree.
[in,out]duckTSDuck execution context.

Implements ts::AbstractSignalization.

◆ analyzeXML()

virtual bool ts::DiscontinuityInformationTable::analyzeXML ( DuckContext duck,
const xml::Element element 
)
overrideprotectedvirtual

Helper method to convert this object from XML.

It is called by fromXML() after checking the validity of the XML node name. In analyzeXML(), the subclass shall populate the C++ object from the content of the XML node. If analyzeXML() returns false, this table or descriptor object is then invalidated and cleared.

Parameters
[in,out]duckTSDuck execution context.
[in]elementXML element to convert.
Returns
True if the analysis is correct, false otherwise.

Implements ts::AbstractSignalization.

◆ tableId()

TID ts::AbstractTable::tableId ( ) const
inlineinherited

Get the table_id.

Returns
The table_id.

◆ isPrivate()

virtual bool ts::AbstractTable::isPrivate ( ) const
virtualinherited

Check if the table is a private one (ie.

not MPEG-defined). The default implementation returns true. MPEG-defined tables should override this method to return false.

Returns
True if the table is a private one (ie. not MPEG-defined).

Reimplemented in ts::PMT, ts::CableEmergencyAlertTable, ts::SpliceInformationTable, ts::CAT, ts::TSDT, ts::DSMCCStreamDescriptorsTable, and ts::PAT.

◆ serialize()

void ts::AbstractTable::serialize ( DuckContext duck,
BinaryTable bin 
) const
inherited

This method serializes a table.

Parameters
[in,out]duckTSDuck execution context.
[out]binA binary table object. Its content is replaced with a binary representation of this object.

◆ deserialize()

void ts::AbstractTable::deserialize ( DuckContext duck,
const BinaryTable bin 
)
inherited

This method deserializes a binary table.

In case of success, this object is replaced with the interpreted content of bin. In case of error, this object is invalidated.

Parameters
[in,out]duckTSDuck execution context.
[in]binA binary table to interpret according to the table subclass.

◆ isValidTableId()

virtual bool ts::AbstractTable::isValidTableId ( TID  tid) const
protectedvirtualinherited

This method checks if a table id is valid for this object.

Parameters
[in]tidA table id to check.
Returns
True if tid is a valid table id for this object, false otherwise. The default implementation checks that tid is identical to the table id of this object.

Reimplemented in ts::EIT, ts::SDT, ts::NBIT, and ts::NIT.

◆ maxPayloadSize()

virtual size_t ts::AbstractTable::maxPayloadSize ( ) const
protectedvirtualinherited

Get the maximum size in bytes of the payload of sections of this table.

Returns
The maximum size in bytes of the payload of sections of this table.

Reimplemented in ts::AbstractLongTable.

◆ useTrailingCRC32()

virtual bool ts::AbstractTable::useTrailingCRC32 ( ) const
protectedvirtualinherited

Check if the sections of this table have a trailing CRC32.

This is usually false for short sections but some short sections such as DVB-TOT use a CRC32.

Returns
True if the sections of this table have a trailing CRC32.

Reimplemented in ts::TOT, ts::SpliceInformationTable, and ts::AbstractLongTable.

◆ addOneSection()

void ts::AbstractTable::addOneSection ( BinaryTable table,
PSIBuffer payload 
) const
protectedinherited

Helper method for serializePayload(): add a section in a binary table.

For long tables, the section number is always one more than the current last section in the table.

It the payload buffer has a pushed read/write state, this state is restored and immediately pushed again. The typical use case is the following:

  • A table may create more than one section.
  • The payload of all sections starts with the same fixed data.
  • In the subclass, the method serializePayload() builds the initial fixed data once.
  • The method serializePayload() immediately pushes the read/write state of the buffer.
  • The method serializePayload() builds payloads and call addOneSection().
  • Upon return from addOneSection(), the buffer is back right after the initial fixed data.
Parameters
[in,out]tableThe binary table into which the new section shall be added.
[in,out]payloadA PSIBuffer containing the section payload between the read and the write pointer.

◆ addOneSectionImpl()

virtual void ts::AbstractTable::addOneSectionImpl ( BinaryTable table,
PSIBuffer payload 
) const
protectedvirtualinherited

Actual implementation of adding one section in a binary table.

Do not call directly, it is only called by addOneSection() and is overridden in AbstractLongTable.

Parameters
[in,out]tableThe binary table into which the new section shall be added.
[in,out]payloadA PSIBuffer containing the section payload between the read and the write pointer.

Reimplemented in ts::AbstractLongTable.

◆ deserializePayloadWrapper()

virtual void ts::AbstractTable::deserializePayloadWrapper ( PSIBuffer buf,
const Section section 
)
protectedvirtualinherited

Wrapper for deserializePayload().

This is a method to overload in intermediate classes to avoid using "call superclass" to all tables.

Parameters
[in,out]bufDeserialization buffer.
[in]sectionA reference to the section.

Reimplemented in ts::AbstractLongTable.

◆ isValid()

bool ts::AbstractSignalization::isValid ( ) const
inlineinherited

Check if this object is valid.

Returns
True if this object is valid.

◆ invalidate()

void ts::AbstractSignalization::invalidate ( )
inlineinherited

Invalidate this object.

This object must be rebuilt.

◆ clear()

virtual void ts::AbstractSignalization::clear ( )
virtualinherited

This method clears the content of the table or descriptor.

Upon return, the object is valid and in the same empty state as after a default constructor.

Reimplemented in ts::AbstractLongTable.

◆ xmlName()

UString ts::AbstractSignalization::xmlName ( ) const
inherited

Get the XMl node name representing this table or descriptor.

Returns
The XML node name.

◆ toXML()

xml::Element* ts::AbstractSignalization::toXML ( DuckContext duck,
xml::Element parent 
) const
inherited

This method converts this object to XML.

When this object is valid, this method creates a root node with the default XML name and then invokes buildXML() in the subclass to populate the XML node.

Parameters
[in,out]duckTSDuck execution context.
[in,out]parentThe parent node for the new XML tree.
Returns
The new XML element.

◆ fromXML()

void ts::AbstractSignalization::fromXML ( DuckContext duck,
const xml::Element element 
)
inherited

This method converts an XML structure to a table or descriptor in this object.

In case of success, this object is replaced with the interpreted content of the XML structure. In case of error, this object is invalidated.

This method checks the name of the XML node and then invokes analyzeXML() in the subclass. Depending on the returned values of analyzeXML(), this object is either validated or invalidated.

Parameters
[in,out]duckTSDuck execution context.
[in]elementXML element to convert.

◆ definingStandards()

virtual Standards ts::AbstractSignalization::definingStandards ( ) const
overridevirtualinherited

Get the list of standards which define this object.

Returns
A bit mask of standards.

Implements ts::AbstractDefinedByStandards.


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