TSDuck Version 3.32-2769 (TSDuck - The MPEG Transport Stream Toolkit)
ts::FileNameRate Class Reference

Representation of a file name and an associated repetition rate. More...

Collaboration diagram for ts::FileNameRate:

Public Member Functions

 FileNameRate (const UString &name=UString(), MilliSecond rep=0)
 Default constructor. More...
 
bool operator!= (const FileNameRate &other) const
 Comparison operator. More...
 
bool operator< (const FileNameRate &other) const
 Comparison "less than" operator. More...
 
bool operator== (const FileNameRate &other) const
 Comparison operator. More...
 
bool scanFile (size_t retry=1, Report &report=(*(static_cast< ts::Report * >(ts::NullReport::Instance()))))
 Scan the file for update. More...
 

Public Attributes

UString display_name
 File name in display form.
 
Time file_date
 Last modification date of file.
 
UString file_name
 File name.
 
bool inline_xml
 File name contains inline XML text (not a real file name).
 
MilliSecond repetition
 Repetition rate in milliseconds.
 
size_t retry_count
 Number of allowed retry in case of error when using the file.
 

Detailed Description

Representation of a file name and an associated repetition rate.

This is typically used to handle section files to inject into transport streams.

Constructor & Destructor Documentation

◆ FileNameRate()

ts::FileNameRate::FileNameRate ( const UString name = UString(),
MilliSecond  rep = 0 
)
explicit

Default constructor.

Parameters
[in]nameFile name.
[in]repRepetition rate in milliseconds.

Member Function Documentation

◆ operator==()

bool ts::FileNameRate::operator== ( const FileNameRate other) const

Comparison operator.

Parameters
[in]otherOther instance to compare.
Returns
True if this instance is equal to other.

◆ operator!=()

bool ts::FileNameRate::operator!= ( const FileNameRate other) const
inline

Comparison operator.

Parameters
[in]otherOther instance to compare.
Returns
True if this instance is different from other.

◆ operator<()

bool ts::FileNameRate::operator< ( const FileNameRate other) const

Comparison "less than" operator.

It does not really makes sense. Only defined to allow usage in containers.

Parameters
[in]otherOther instance to compare.
Returns
True if this instance is less than to other.

◆ scanFile()

bool ts::FileNameRate::scanFile ( size_t  retry = 1,
Report report = (*(static_cast< ts::Report * >(ts::NullReport::Instance()))) 
)

Scan the file for update.

Update the modification date of the file in file_date.

Parameters
[in]retryNumber of allowed retry in case of error when using the file.
[in]reportWhere to report a verbose message when a file changed.
Returns
True if the file has changed or is scanned for the first time or has been deleted.

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