dvblinkremote::Schedule Class Reference

Abstract base class for schedules. More...

Inheritance diagram for dvblinkremote::Schedule:

Public Types
enum	DVBLinkScheduleType { SCHEDULE_TYPE_MANUAL = 0, SCHEDULE_TYPE_BY_EPG = 1 }
	An enum for schedule types. More...

Public Member Functions
	Schedule (const DVBLinkScheduleType scheduleType, const std::string &channelId, const int recordingsToKeep=0)
	Initializes a new instance of the dvblinkremote::Schedule class.
	Schedule (const DVBLinkScheduleType scheduleType, const std::string &id, const std::string &channelId, const int recordingsToKeep=0)
	Initializes a new instance of the dvblinkremote::Schedule class.
virtual	~Schedule ()=0
	Pure virtual destructor for cleaning up allocated memory.
std::string &	GetID ()
	Gets the identifier of the schedule.
std::string &	GetChannelID ()
	Gets the channel identifier for the schedule.
DVBLinkScheduleType &	GetScheduleType ()
	Gets the type for the schedule .

Public Attributes
std::string	UserParameter
	The user parameter of the schedule request.
bool	ForceAdd
	A flag indicating that new schedule should be added even if there are other conflicting schedules present.
int	RecordingsToKeep
	Indicates how many recordings to keep for a repeated recording.

Detailed Description

Abstract base class for schedules.

Member Enumeration Documentation

enum dvblinkremote::Schedule::DVBLinkScheduleType

An enum for schedule types.

Enumerator:

SCHEDULE_TYPE_MANUAL	Used for manual schedules.
SCHEDULE_TYPE_BY_EPG	Used for electronic program guide (EPG) schedules.

Constructor & Destructor Documentation

dvblinkremote::Schedule::Schedule	(	const DVBLinkScheduleType	scheduleType,
		const std::string &	channelId,
		const int	recordingsToKeep = 0
	)

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

Parameters

scheduleType	a constant DVBLinkScheduleType instance representing the type of schedule.
channelId	a constant string reference representing the channel identifier.
recordingsToKeep	an optional constant integer representing how many recordings to keep for a repeated recording. Default value is 0, i.e. keep all recordings.

dvblinkremote::Schedule::Schedule	(	const DVBLinkScheduleType	scheduleType,
		const std::string &	id,
		const std::string &	channelId,
		const int	recordingsToKeep = 0
	)

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

Parameters

scheduleType	a constant DVBLinkScheduleType instance representing the type of schedule.
id	a constant string reference representing the schedule identifier.
channelId	a constant string reference representing the channel identifier.
recordingsToKeep	an optional constant integer representing how many recordings to keep for a repeated recording. Default value is 0, i.e. keep all recordings.

virtual dvblinkremote::Schedule::~Schedule ( )

pure virtual

Pure virtual destructor for cleaning up allocated memory.

Member Function Documentation

std::string& dvblinkremote::Schedule::GetChannelID

(

)

Gets the channel identifier for the schedule.

Returns

Channel identifier

std::string& dvblinkremote::Schedule::GetID

(

)

Gets the identifier of the schedule.

Returns

Schedule identifier

DVBLinkScheduleType& dvblinkremote::Schedule::GetScheduleType

(

)

Gets the type for the schedule .

Returns

DVBLinkScheduleType instance reference

Member Data Documentation

bool dvblinkremote::Schedule::ForceAdd

A flag indicating that new schedule should be added even if there are other conflicting schedules present.

int dvblinkremote::Schedule::RecordingsToKeep

Indicates how many recordings to keep for a repeated recording.

Remarks

Possible values (1, 2, 3, 4, 5, 6, 7, 10; 0 - keep all)

std::string dvblinkremote::Schedule::UserParameter

The user parameter of the schedule request.