xbmc
Public Member Functions | Static Public Attributes | List of all members
PVR::CPVRChannelNumber Class Reference
Collaboration diagram for PVR::CPVRChannelNumber:
Collaboration graph
[legend]

Public Member Functions

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...
 
std::string SortableChannelNumber () const
 Get a string representation for the channel number that can be used for SortItems. More...
 

Static Public Attributes

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

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

◆ SortableChannelNumber()

std::string CPVRChannelNumber::SortableChannelNumber ( ) const

Get a string representation for the channel number that can be used for SortItems.

Returns
The sortable string in the form <channel> <subchannel>.

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