TSDuck Version 3.19-1374 (TSDuck - The MPEG Transport Stream Toolkit)
ts::ApplicationStorageDescriptor Class Reference

Representation of an application_storage_descriptor (AIT specific). More...

Inheritance diagram for ts::ApplicationStorageDescriptor:
Collaboration diagram for ts::ApplicationStorageDescriptor:

Public Member Functions

 ApplicationStorageDescriptor ()
 Default constructor.
 
 ApplicationStorageDescriptor (DuckContext &duck, const Descriptor &bin)
 Constructor from a binary descriptor. More...
 
virtual void buildXML (DuckContext &, xml::Element *) const override
 Helper method to convert this object to XML. More...
 
virtual Standards definingStandards () const override
 Get the list of standards which define this object. More...
 
virtual void deserialize (DuckContext &, const Descriptor &) override
 This abstract method deserializes a binary descriptor. More...
 
void deserialize (DuckContext &duck, const DescriptorList &dlist, size_t index)
 Deserialize a descriptor from a descriptor list. More...
 
virtual void fromXML (DuckContext &, const xml::Element *) override
 This abstract converts an XML structure to a table or descriptor. More...
 
void invalidate ()
 Invalidate this object. More...
 
bool isPrivateDescriptor () const
 Check if this descriptor is a private descriptor. More...
 
bool isValid () const
 Check if this object is valid. More...
 
PDS requiredPDS () const
 Get the required private data specifier. More...
 
virtual void serialize (DuckContext &, Descriptor &) const override
 This abstract method serializes a descriptor. More...
 
DID tag () const
 Get the descriptor tag. More...
 
virtual 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 DisplayDescriptor (TablesDisplay &display, DID did, const uint8_t *payload, size_t size, int indent, TID tid, PDS pds)
 Static method to display a descriptor. More...
 

Public Attributes

bool is_launchable_with_older_version
 Is launchable with older version.
 
bool launchable_completely_from_cache
 Launchable completely from cache.
 
bool not_launchable_from_broadcast
 Not launchable from broadcast.
 
uint8_t priority
 Application priority.
 
uint8_t storage_property
 Storage property.
 
uint32_t version
 31 bits, application version.
 

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

bool checkXMLName (const xml::Element *element) const
 Check that an XML element has the right name for this table. More...
 
bool serializeEnd (Descriptor &bin, const ByteBlockPtr &bbp) const
 Tool for serialization: complete a serialization. More...
 
ByteBlockPtr serializeStart () const
 Tool for serialization: get a byte buffer for serialization. More...
 

Static Protected Member Functions

static bool SerializeFixedLength (DuckContext &duck, ByteBlock &bb, const UString &str, const size_t size)
 This static method serializes a DVB string with a required fixed size. More...
 
static bool SerializeLanguageCode (DuckContext &duck, ByteBlock &bb, const UString &str)
 This static method serializes a 3-byte language or country code. More...
 

Protected Attributes

bool _is_valid
 It is the responsibility of the subclasses to set the valid flag.
 
PDS _required_pds
 Required private data specified.
 
DID _tag
 The descriptor tag can be modified by subclasses only.
 
const UChar *const _xml_name
 XML table or descriptor name.
 

Detailed Description

Representation of an application_storage_descriptor (AIT specific).

This descriptor cannot be present in other tables than an AIT because its tag reuses an MPEG-defined one.

See also
ETSI TS 102 809, 5.3.10.1.

Constructor & Destructor Documentation

◆ ApplicationStorageDescriptor()

ts::ApplicationStorageDescriptor::ApplicationStorageDescriptor ( DuckContext duck,
const Descriptor bin 
)

Constructor from a binary descriptor.

Parameters
[in,out]duckTSDuck execution context.
[in]binA binary descriptor to deserialize.

Member Function Documentation

◆ serialize()

virtual void ts::ApplicationStorageDescriptor::serialize ( DuckContext duck,
Descriptor bin 
) const
overridevirtual

This abstract method serializes a descriptor.

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

Implements ts::AbstractDescriptor.

◆ deserialize() [1/2]

virtual void ts::ApplicationStorageDescriptor::deserialize ( DuckContext duck,
const Descriptor bin 
)
overridevirtual

This abstract method deserializes a binary descriptor.

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 descriptor to interpret according to the descriptor subclass.

Implements ts::AbstractDescriptor.

◆ buildXML()

virtual void ts::ApplicationStorageDescriptor::buildXML ( DuckContext duck,
xml::Element root 
) const
overridevirtual

Helper method to convert this object to XML.

When this object is valid, the default implementation of toXML() creates a root node with the default XML name and then invoke buildXML() to populate the XML node.

The default implementation is to do nothing. Subclasses which override toXML() do not need to implement buildXML() since it won't be invoked.

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

Reimplemented from ts::AbstractSignalization.

◆ fromXML()

virtual void ts::ApplicationStorageDescriptor::fromXML ( DuckContext duck,
const xml::Element element 
)
overridevirtual

This abstract converts an XML structure to a table or descriptor.

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

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

Implements ts::AbstractSignalization.

◆ DisplayDescriptor()

static void ts::ApplicationStorageDescriptor::DisplayDescriptor ( TablesDisplay display,
DID  did,
const uint8_t *  payload,
size_t  size,
int  indent,
TID  tid,
PDS  pds 
)
static

Static method to display a descriptor.

Parameters
[in,out]displayDisplay engine.
[in]didDescriptor id.
[in]payloadAddress of the descriptor payload.
[in]sizeSize in bytes of the descriptor payload.
[in]indentIndentation width.
[in]tidTable id of table containing the descriptors.
[in]pdsPrivate Data Specifier.

◆ tag()

DID ts::AbstractDescriptor::tag ( ) const
inlineinherited

Get the descriptor tag.

Returns
The descriptor tag.

◆ requiredPDS()

PDS ts::AbstractDescriptor::requiredPDS ( ) const
inlineinherited

Get the required private data specifier.

Returns
The private data specifier which is required to interpret correctly this descriptor in a section. Return zero if this descriptor is a DVB-defined or MPEG-defined descriptor, not a private specifier.

◆ isPrivateDescriptor()

bool ts::AbstractDescriptor::isPrivateDescriptor ( ) const
inlineinherited

Check if this descriptor is a private descriptor.

Returns
True if this descriptor is a private descriptor, false if it is a DVB-defined or MPEG-defined descriptor.

◆ deserialize() [2/2]

void ts::AbstractDescriptor::deserialize ( DuckContext duck,
const DescriptorList dlist,
size_t  index 
)
inherited

Deserialize a descriptor from a descriptor list.

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

Parameters
[in,out]duckTSDuck execution context.
[in]dlistA list of binary descriptors.
[in]indexIndex of the descriptor to deserialize in dlist.

◆ serializeStart()

ByteBlockPtr ts::AbstractDescriptor::serializeStart ( ) const
protectedinherited

Tool for serialization: get a byte buffer for serialization.

Returns
A safe pointer to a two-byte byffer containing the descriptor tag and zero as length.

◆ serializeEnd()

bool ts::AbstractDescriptor::serializeEnd ( Descriptor bin,
const ByteBlockPtr bbp 
) const
protectedinherited

Tool for serialization: complete a serialization.

Parameters
[out]binA binary descriptor object which receives the serialized object.
[in]bbpSafe pointer containing the serialized data, typically returned by serializeStart(). The tag and length will be updated.
Returns
True if the serialized descriptor is valid.

◆ 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.

◆ xmlName()

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

Get the XMl node name representing this table or descriptor.

Returns
The XML node name.

◆ toXML()

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

This method converts this object to XML.

When this object is valid, the default implementation of toXML() creates a root node with the default XML name and then invoke buildXML() to populate the XML node.

Subclasses have the choice to either implement buildXML() or toXML(). If the object is serialized as one single XML node, it is simpler to implement buildXML().

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

Reimplemented in ts::SSULinkageDescriptor, and ts::SSUDataBroadcastIdDescriptor.

◆ 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.

◆ checkXMLName()

bool ts::AbstractSignalization::checkXMLName ( const xml::Element element) const
protectedinherited

Check that an XML element has the right name for this table.

Parameters
[in]elementXML element to check.
Returns
True on success, false on error.

◆ SerializeFixedLength()

static bool ts::AbstractSignalization::SerializeFixedLength ( DuckContext duck,
ByteBlock bb,
const UString str,
const size_t  size 
)
staticprotectedinherited

This static method serializes a DVB string with a required fixed size.

Parameters
[in,out]duckTSDuck execution context.
[in,out]bbA byte-block where str will be appended if its size is correct.
[in]strString to serialize.
[in]sizeRequired size in bytes of the serialized string.
Returns
True if the size has the required length and has been serialized.

◆ SerializeLanguageCode()

static bool ts::AbstractSignalization::SerializeLanguageCode ( DuckContext duck,
ByteBlock bb,
const UString str 
)
staticprotectedinherited

This static method serializes a 3-byte language or country code.

Parameters
[in,out]duckTSDuck execution context.
[in,out]bbA byte-block where str will be appended if its size is correct.
[in]strString to serialize.
Returns
True if the size has the required length and has been serialized.

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