Kodi Documentation  18.0
Kodi is an open source media player and entertainment hub.
Public Member Functions | Static Public Attributes | List of all members
PVR::CPVRChannelNumber Class Reference

#include <PVRChannelNumber.h>

Public Member Functions

 CPVRChannelNumber ()=default
 
constexpr CPVRChannelNumber (unsigned int iChannelNumber, unsigned int iSubChannelNumber)
 
constexpr bool operator== (const CPVRChannelNumber &right) const
 
constexpr bool operator!= (const CPVRChannelNumber &right) const
 
constexpr bool operator< (const CPVRChannelNumber &right) const
 
constexpr bool IsValid () const
 Check whether this channel number is valid (main channel number > 0). More...
 
constexpr unsigned int GetChannelNumber () const
 Set the primary channel number. More...
 
constexpr unsigned int GetSubChannelNumber () const
 Set the sub channel number. More...
 
std::string FormattedChannelNumber () const
 Get a string representation for the channel number. More...
 

Static Public Attributes

static const char SEPARATOR = '.'
 The character used to separate channel and subchannel number. More...
 

Constructor & Destructor Documentation

§ CPVRChannelNumber() [1/2]

PVR::CPVRChannelNumber::CPVRChannelNumber ( )
default

§ CPVRChannelNumber() [2/2]

constexpr PVR::CPVRChannelNumber::CPVRChannelNumber ( unsigned int  iChannelNumber,
unsigned int  iSubChannelNumber 
)
inline

Member Function Documentation

§ FormattedChannelNumber()

std::string CPVRChannelNumber::FormattedChannelNumber ( ) const

Get a string representation for the channel number.

Returns
The formatted string in the form <channel>SEPARATOR<subchannel>.

§ GetChannelNumber()

constexpr unsigned int PVR::CPVRChannelNumber::GetChannelNumber ( ) const
inline

Set the primary channel number.

Returns
The channel number.

§ GetSubChannelNumber()

constexpr unsigned int PVR::CPVRChannelNumber::GetSubChannelNumber ( ) const
inline

Set the sub channel number.

Returns
The sub channel number (ATSC).

§ IsValid()

constexpr bool PVR::CPVRChannelNumber::IsValid ( void  ) const
inline

Check whether this channel number is valid (main channel number > 0).

Returns
True if valid, false otherwise..

§ operator!=()

constexpr bool PVR::CPVRChannelNumber::operator!= ( const CPVRChannelNumber &  right) const
inline

§ operator<()

constexpr bool PVR::CPVRChannelNumber::operator< ( const CPVRChannelNumber &  right) const
inline

§ operator==()

constexpr bool PVR::CPVRChannelNumber::operator== ( const CPVRChannelNumber &  right) const
inline

Member Data Documentation

§ SEPARATOR

const char CPVRChannelNumber::SEPARATOR = '.'
static

The character used to separate channel and subchannel number.

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