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).
constexpr unsigned int	GetChannelNumber () const
	Set the primary channel number.
constexpr unsigned int	GetSubChannelNumber () const
	Set the sub channel number.
std::string	FormattedChannelNumber () const
	Get a string representation for the channel number.
std::string	SortableChannelNumber () const
	Get a string representation for the channel number that can be used for SortItems.

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

Constructor & Destructor Documentation

CPVRChannelNumber() [1/2]

PVR::CPVRChannelNumber::CPVRChannelNumber ( )

default

CPVRChannelNumber() [2/2]

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

inlineconstexpr

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

inlineconstexpr

Set the primary channel number.

Returns

The channel number.

GetSubChannelNumber()

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

inlineconstexpr

Set the sub channel number.

Returns

The sub channel number (ATSC).

IsValid()

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

inlineconstexpr

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

inlineconstexpr

operator<()

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

inlineconstexpr

operator==()

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

inlineconstexpr

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

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:

• PVRChannelNumber.h
• PVRChannelNumber.cpp