dvblinkremote::Channel Class Reference

Represent a DVBLink channel. More...

Public Types
enum	DVBLinkChannelType { CHANNEL_TYPE_TV = 0, CHANNEL_TYPE_RADIO = 1, CHANNEL_TYPE_OTHER = 2 }
	An enum for channel types. More...

Public Member Functions
	Channel (const std::string &id, const long dvbLinkId, const std::string &name, const DVBLinkChannelType type, const int number=-1, const int subNumber=-1)
	Initializes a new instance of the dvblinkremote::Channel class.
	Channel (Channel &channel)
	Initializes a new instance of the dvblinkremote::Channel class by coping another dvblinkremote::Channel instance.
	~Channel ()
	Destructor for cleaning up allocated memory.
std::string &	GetID ()
	Gets the identifier of the channel.
long	GetDvbLinkID ()
	Gets the DVBLink identifier of the channel.
std::string &	GetName ()
	Gets the name of the channel.
DVBLinkChannelType &	GetChannelType ()
	Gets the type of the channel.

Public Attributes
int	Number
	Represents the number of the channel.
int	SubNumber
	Represents the sub-number of the channel.
bool	ChildLock
	Represents if a child lock is active or not for the channel.

Detailed Description

Represent a DVBLink channel.

Member Enumeration Documentation

enum dvblinkremote::Channel::DVBLinkChannelType

An enum for channel types.

Enumerator:

CHANNEL_TYPE_TV
CHANNEL_TYPE_RADIO
CHANNEL_TYPE_OTHER

Constructor & Destructor Documentation

dvblinkremote::Channel::Channel	(	const std::string &	id,
		const long	dvbLinkId,
		const std::string &	name,
		const DVBLinkChannelType	type,
		const int	number = -1,
		const int	subNumber = -1
	)

Initializes a new instance of the dvblinkremote::Channel class.

Parameters

id	a constant string reference representing the generic identifier of the channel.
dvbLinkId	a constant long representing the DVBLink identifier of the channel.
name	a constant string reference representing the name of the channel.
type	a constant DVBLinkChannelType instance representing the type of the channel.
number	an optional constant integer representing the number of the channel.
subNumber	an optional constant integer representing the sub-number of the channel.

dvblinkremote::Channel::Channel

(

Channel &

channel

)

Initializes a new instance of the dvblinkremote::Channel class by coping another dvblinkremote::Channel instance.

Parameters

channel

a dvblinkremote::Channel reference.

dvblinkremote::Channel::~Channel

(

)

Destructor for cleaning up allocated memory.

Member Function Documentation

DVBLinkChannelType& dvblinkremote::Channel::GetChannelType

(

)

Gets the type of the channel.

Returns

ChannelType instance reference

long dvblinkremote::Channel::GetDvbLinkID

(

)

Gets the DVBLink identifier of the channel.

Returns

DVBLink channel identifier

std::string& dvblinkremote::Channel::GetID

(

)

Gets the identifier of the channel.

Returns

Channel identifier

std::string& dvblinkremote::Channel::GetName

(

)

Gets the name of the channel.

Returns

Channel name

Member Data Documentation

bool dvblinkremote::Channel::ChildLock

Represents if a child lock is active or not for the channel.

int dvblinkremote::Channel::Number

Represents the number of the channel.

int dvblinkremote::Channel::SubNumber

Represents the sub-number of the channel.