ts::VersionInfo Class Reference

Information about version identification of TSDuck. More...

#include <tsVersionInfo.h>

Inheritance diagram for ts::VersionInfo:

Collaboration diagram for ts::VersionInfo:

Classes
class	RegisterFeature
	A class to register a feature of the application. More...

Public Types
enum class	Format {   ALL ,   SHORT ,   LONG ,   INTEGER ,   DATE }
	Types of version formatting, for predefined option --version. More...

Public Member Functions
	VersionInfo (Report &report)
	Default constructor.
virtual	~VersionInfo () override
	Destructor.
void	startNewVersionDetection ()
	Start a thread which checks the availability of a new TSDuck version.

Static Public Member Functions
static int	CompareVersions (const UString &v1, const UString &v2)
	Compare two version strings.
static const Names &	FormatEnum ()
	Enumeration description of class Format.
static UString	GetVersion (Format format=Format::SHORT, const UString &applicationName=UString())
	Get the TSDuck formatted version number.
static const Names &	SupportEnum ()
	Enumeration of supported features.

Detailed Description

Information about version identification of TSDuck.

Member Enumeration Documentation

Format

enum class ts::VersionInfo::Format

strong

Types of version formatting, for predefined option --version.

Enumerator
ALL	Multi-line output with full details.
SHORT	Short format X.Y-R.
LONG	Full explanatory format.
INTEGER	Integer format XXYYRRRRR.
DATE	Build date.

Constructor & Destructor Documentation

VersionInfo()

ts::VersionInfo::VersionInfo

(

Report &

report

)

Default constructor.

Parameters

[in,out]

report

Reference to the report object through which new versions will be reported.

Member Function Documentation

startNewVersionDetection()

void ts::VersionInfo::startNewVersionDetection

(

)

Start a thread which checks the availability of a new TSDuck version.

If a new version is found, it is reported through the Report object that was specified in the constructor. This can be done only once, further calls are ignored. The destructor of this object waits for the completion of the thread.

If the environment variable TSDUCK_NO_VERSION_CHECK is not empty, do not start the new version check. To debug new version checking, define the environment variable TS_DEBUG_NEW_VERSION to any non-empty value; debug and errors messages will be reported through the same Report object.

FormatEnum()

static const Names & ts::VersionInfo::FormatEnum ( )

inlinestatic

Enumeration description of class Format.

Typically used to implement the --version command line option.

Returns

A constant reference to the enumeration description.

SupportEnum()

static const Names & ts::VersionInfo::SupportEnum ( )

inlinestatic

Enumeration of supported features.

Typically used to implement the --support command line option. For each name, the value is 1 if the feature is supported and 0 if it is not.

Returns

A constant reference to the enumeration description.

GetVersion()

static UString ts::VersionInfo::GetVersion ( Format  format = Format::SHORT, const UString &  applicationName = UString()  )

static

Get the TSDuck formatted version number.

Parameters

[in]	format	Type of output, short by default.
[in]	applicationName	Name of the application to prepend to the long format.

Returns

The formatted version string.

CompareVersions()

static int ts::VersionInfo::CompareVersions ( const UString &  v1, const UString &  v2  )

static

Compare two version strings.

Parameters

[in]	v1	First version string.
[in]	v2	First version string.

Returns

One of -1, 0, 1 when v1 < v2, v1 == v2, v1 > v2.

---

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

• tsVersionInfo.h