dvblinkremote::ManualSchedule Class Reference

Abstract base class for manual schedules. More...

Inheritance diagram for dvblinkremote::ManualSchedule:

Public Types
enum	DVBLinkManualScheduleDayMask {   MANUAL_SCHEDULE_DAY_MASK_SUNDAY = 1, MANUAL_SCHEDULE_DAY_MASK_MONDAY = 2, MANUAL_SCHEDULE_DAY_MASK_TUESDAY = 4, MANUAL_SCHEDULE_DAY_MASK_WEDNESDAY = 8,   MANUAL_SCHEDULE_DAY_MASK_THURSDAY = 16, MANUAL_SCHEDULE_DAY_MASK_FRIDAY = 32, MANUAL_SCHEDULE_DAY_MASK_SATURDAY = 64, MANUAL_SCHEDULE_DAY_MASK_DAILY = 255 }
	An enum to be used for constructing a bitflag to be used for defining repeated recordings for manual schedules. More...
Public Types inherited from dvblinkremote::Schedule
enum	DVBLinkScheduleType { SCHEDULE_TYPE_MANUAL = 0, SCHEDULE_TYPE_BY_EPG = 1 }
	An enum for schedule types. More...

Public Member Functions
	ManualSchedule (const std::string &channelId, const long startTime, const long duration, const long dayMask, const std::string &title="")
	Initializes a new instance of the dvblinkremote::ManualSchedule class.
	ManualSchedule (const std::string &id, const std::string &channelId, const long startTime, const long duration, const long dayMask, const std::string &title="")
	Initializes a new instance of the dvblinkremote::ManualSchedule class.
virtual	~ManualSchedule ()=0
	Pure virtual destructor for cleaning up allocated memory.
long	GetStartTime ()
	Gets the start time for the manual schedule request.
long	GetDuration ()
	Gets the duration for the manual schedule request.
long	GetDayMask ()
	Gets the day bitmask for the manual schedule request.
Public Member Functions inherited from dvblinkremote::Schedule
	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	Title
	The title of the manual schedule request.
Public Attributes inherited from dvblinkremote::Schedule
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 manual schedules.

Member Enumeration Documentation

enum dvblinkremote::ManualSchedule::DVBLinkManualScheduleDayMask

An enum to be used for constructing a bitflag to be used for defining repeated recordings for manual schedules.

Enumerator:

MANUAL_SCHEDULE_DAY_MASK_SUNDAY	Sunday schedule.
MANUAL_SCHEDULE_DAY_MASK_MONDAY	Monday schedule.
MANUAL_SCHEDULE_DAY_MASK_TUESDAY	Tuesday schedule.
MANUAL_SCHEDULE_DAY_MASK_WEDNESDAY	Wednesday schedule.
MANUAL_SCHEDULE_DAY_MASK_THURSDAY	Thursday schedule.
MANUAL_SCHEDULE_DAY_MASK_FRIDAY	Friday schedule.
MANUAL_SCHEDULE_DAY_MASK_SATURDAY	Saturday schedule.
MANUAL_SCHEDULE_DAY_MASK_DAILY	Daily schedule.

Constructor & Destructor Documentation

dvblinkremote::ManualSchedule::ManualSchedule	(	const std::string &	channelId,
		const long	startTime,
		const long	duration,
		const long	dayMask,
		const std::string &	title = ""
	)

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

Parameters

channelId	a constant string reference representing the channel identifier.
startTime	a constant long representing the start time of the schedule.
duration	a constant long representing the duration of the schedule.
dayMask	a constant long representing the day bitflag of the schedule.

Remarks

Construct the dayMask parameter by using bitwize operations on the DVBLinkManualScheduleDayMask.

See Also

DVBLinkManualScheduleDayMask

Parameters

title

of schedule

dvblinkremote::ManualSchedule::ManualSchedule	(	const std::string &	id,
		const std::string &	channelId,
		const long	startTime,
		const long	duration,
		const long	dayMask,
		const std::string &	title = ""
	)

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

Parameters

id	a constant string reference representing the schedule identifier.
channelId	a constant string reference representing the channel identifier.
startTime	a constant long representing the start time of the schedule.
duration	a constant long representing the duration of the schedule.
dayMask	a constant long representing the day bitflag of the schedule.

Remarks

Construct the dayMask parameter by using bitwize operations on the DVBLinkManualScheduleDayMask.

See Also

DVBLinkManualScheduleDayMask

Parameters

title

of schedule

virtual dvblinkremote::ManualSchedule::~ManualSchedule ( )

pure virtual

Pure virtual destructor for cleaning up allocated memory.

Member Function Documentation

long dvblinkremote::ManualSchedule::GetDayMask

(

)

Gets the day bitmask for the manual schedule request.

Returns

Day bitmask

long dvblinkremote::ManualSchedule::GetDuration

(

)

Gets the duration for the manual schedule request.

Returns

Duration

long dvblinkremote::ManualSchedule::GetStartTime

(

)

Gets the start time for the manual schedule request.

Returns

Start time

Member Data Documentation

std::string dvblinkremote::ManualSchedule::Title

The title of the manual schedule request.