DVBLink Remote API Library documentation  0.2.0-Master
 All Classes Namespaces Functions Variables Enumerations Enumerator Pages
dvblinkremote::EpgSchedule Class Reference

Abstract base class for electronic program guide (EPG) schedules. More...

Inheritance diagram for dvblinkremote::EpgSchedule:
dvblinkremote::Schedule dvblinkremote::AddScheduleByEpgRequest dvblinkremote::StoredEpgSchedule

Public Member Functions

 EpgSchedule (const std::string &channelId, const std::string &programId, const bool repeat=false, const bool newOnly=false, const bool recordSeriesAnytime=false)
 Initializes a new instance of the dvblinkremote::EpgSchedule class.
 EpgSchedule (const std::string &id, const std::string &channelId, const std::string &programId, const bool repeat=false, const bool newOnly=false, const bool recordSeriesAnytime=false)
 Initializes a new instance of the dvblinkremote::EpgSchedule class.
virtual ~EpgSchedule ()=0
 Pure virtual destructor for cleaning up allocated memory.
std::string & GetProgramID ()
 Gets the program identifier for the schedule.
- 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.
DVBLinkScheduleTypeGetScheduleType ()
 Gets the type for the schedule .

Public Attributes

bool Repeat
 The repeat flag for the schedule.
bool NewOnly
 Flag representing if only new programs have to be recorded.
bool RecordSeriesAnytime
 Flag representing whether to record only series starting around original program start time or any of them.
- 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.

Additional Inherited Members

- Public Types inherited from dvblinkremote::Schedule
enum  DVBLinkScheduleType { SCHEDULE_TYPE_MANUAL = 0, SCHEDULE_TYPE_BY_EPG = 1 }
 An enum for schedule types. More...

Detailed Description

Abstract base class for electronic program guide (EPG) schedules.

Constructor & Destructor Documentation

dvblinkremote::EpgSchedule::EpgSchedule ( const std::string &  channelId,
const std::string &  programId,
const bool  repeat = false,
const bool  newOnly = false,
const bool  recordSeriesAnytime = false 
)

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

Parameters
channelIda constant string reference representing the channel identifier.
programIda constant string reference representing the program identifier.
repeatan optional constant boolean representing if the schedule should be repeated or not. Default value is false.
newOnlyan optional constant boolean representing if only new programs have to be recorded. Default value is false.
recordSeriesAnytimean optional constant boolean representing whether to record only series starting around original program start time or any of them. Default value is false.
dvblinkremote::EpgSchedule::EpgSchedule ( const std::string &  id,
const std::string &  channelId,
const std::string &  programId,
const bool  repeat = false,
const bool  newOnly = false,
const bool  recordSeriesAnytime = false 
)

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

Parameters
ida constant string reference representing the schedule identifier.
channelIda constant string reference representing the channel identifier.
programIda constant string reference representing the program identifier.
repeatan optional constant boolean representing if the schedule should be repeated or not. Default value is false.
newOnlyan optional constant boolean representing if only new programs have to be recorded. Default value is false.
recordSeriesAnytimean optional constant boolean representing whether to record only series starting around original program start time or any of them. Default value is false.
virtual dvblinkremote::EpgSchedule::~EpgSchedule ( )
pure virtual

Pure virtual destructor for cleaning up allocated memory.

Member Function Documentation

std::string& dvblinkremote::EpgSchedule::GetProgramID ( )

Gets the program identifier for the schedule.

Returns
Program identifier

Member Data Documentation

bool dvblinkremote::EpgSchedule::NewOnly

Flag representing if only new programs have to be recorded.

bool dvblinkremote::EpgSchedule::RecordSeriesAnytime

Flag representing whether to record only series starting around original program start time or any of them.

bool dvblinkremote::EpgSchedule::Repeat

The repeat flag for the schedule.