PVR::CPVRTimerType Class Reference

#include <PVRTimerType.h>

Public Member Functions
	CPVRTimerType ()
	CPVRTimerType (const PVR_TIMER_TYPE &type, int iClientId)
	CPVRTimerType (unsigned int iTypeId, uint64_t iAttributes, const std::string &strDescription="")
virtual	~CPVRTimerType ()
	CPVRTimerType (const CPVRTimerType &type)=delete
CPVRTimerType &	operator= (const CPVRTimerType &orig)=delete
bool	operator== (const CPVRTimerType &right) const
bool	operator!= (const CPVRTimerType &right) const
void	Update (const CPVRTimerType &type)
	Update the data of this instance with the data given by another type instance.
int	GetClientId () const
	Get the PVR client id for this type.
unsigned int	GetTypeId () const
	Get the numeric type id of this type.
const std::string &	GetDescription () const
	Get the plain text (UI) description of this type.
uint64_t	GetAttributes () const
	Get the attributes of this type.
bool	IsTimerRule () const
	Check whether this type is for timer rules or one time timers.
bool	IsReminder () const
	Check whether this type is for reminder timers or recording timers.
bool	IsOnetime () const
	Check whether this type is for timer rules or one time timers.
bool	IsManual () const
	Check whether this type is for epg-based or manual timers.
bool	IsEpgBased () const
	Check whether this type is for epg-based or manual timers.
bool	IsEpgBasedTimerRule () const
	Check whether this type is for epg-based timer rules.
bool	IsEpgBasedOnetime () const
	Check whether this type is for one time epg-based timers.
bool	IsManualTimerRule () const
	Check whether this type is for manual timer rules.
bool	IsManualOnetime () const
	Check whether this type is for one time manual timers.
bool	IsReadOnly () const
	Check whether this type is readonly (must not be modified after initial creation).
bool	AllowsDelete () const
	Check whether this type allows deletion.
bool	ForbidsNewInstances () const
	Check whether this type forbids creation of new timers of this type.
bool	ForbidsEpgTagOnCreate () const
	Check whether this timer type is forbidden when epg tag info is present.
bool	RequiresEpgTagOnCreate () const
	Check whether this timer type requires epg tag info to be present.
bool	RequiresEpgSeriesOnCreate () const
	Check whether this timer type requires epg tag info including series attributes to be present.
bool	RequiresEpgSeriesLinkOnCreate () const
	Check whether this timer type requires epg tag info including a series link to be present.
bool	SupportsEnableDisable () const
	Check whether this type supports the "enabling/disabling" of timers of its type.
bool	SupportsChannels () const
	Check whether this type supports channels.
bool	SupportsStartTime () const
	Check whether this type supports start time.
bool	SupportsEndTime () const
	Check whether this type supports end time.
bool	SupportsStartAnyTime () const
	Check whether this type supports start any time.
bool	SupportsEndAnyTime () const
	Check whether this type supports end any time.
bool	SupportsEpgTitleMatch () const
	Check whether this type supports matching a search string against epg episode title.
bool	SupportsEpgFulltextMatch () const
	Check whether this type supports matching a search string against extended (fulltext) epg data. This includes title matching.
bool	SupportsFirstDay () const
	Check whether this type supports a first day the timer is active.
bool	SupportsWeekdays () const
	Check whether this type supports weekdays for timer schedules.
bool	SupportsRecordOnlyNewEpisodes () const
	Check whether this type supports the "record only new episodes" feature.
bool	SupportsStartMargin () const
	Check whether this type supports pre record time.
bool	SupportsEndMargin () const
	Check whether this type supports post record time.
bool	SupportsPriority () const
	Check whether this type supports recording priorities.
bool	SupportsLifetime () const
	Check whether this type supports lifetime for recordings.
bool	SupportsMaxRecordings () const
	Check whether this type supports MaxRecordings for recordings.
bool	SupportsRecordingFolders () const
	Check whether this type supports user specified recording folders.
bool	SupportsRecordingGroup () const
	Check whether this type supports recording groups.
bool	SupportsAnyChannel () const
	Check whether this type supports 'any channel', for example for defining a timer rule that should match any channel instead of a particular channel.
bool	SupportsReadOnlyDelete () const
	Check whether this type supports deletion of an otherwise read-only timer.
void	GetPriorityValues (std::vector< std::pair< std::string, int > > &list) const
	Obtain a list with all possible values for the priority attribute.
int	GetPriorityDefault () const
	Obtain the default value for the priority attribute.
void	GetLifetimeValues (std::vector< std::pair< std::string, int > > &list) const
	Obtain a list with all possible values for the lifetime attribute.
int	GetLifetimeDefault () const
	Obtain the default value for the lifetime attribute.
void	GetMaxRecordingsValues (std::vector< std::pair< std::string, int > > &list) const
	Obtain a list with all possible values for the MaxRecordings attribute.
int	GetMaxRecordingsDefault () const
	Obtain the default value for the MaxRecordings attribute.
void	GetPreventDuplicateEpisodesValues (std::vector< std::pair< std::string, int > > &list) const
	Obtain a list with all possible values for the duplicate episode prevention attribute.
int	GetPreventDuplicateEpisodesDefault () const
	Obtain the default value for the duplicate episode prevention attribute.
void	GetRecordingGroupValues (std::vector< std::pair< std::string, int > > &list) const
	Obtain a list with all possible values for the recording group attribute.
int	GetRecordingGroupDefault () const
	Obtain the default value for the Recording Group attribute.

Static Public Member Functions
static const std::vector< std::shared_ptr< CPVRTimerType > >	GetAllTypes ()
	Return a list with all known timer types.
static const std::shared_ptr< CPVRTimerType >	GetFirstAvailableType (const std::shared_ptr< const CPVRClient > &client)
	Return the first available timer type from given client.
static std::shared_ptr< CPVRTimerType >	CreateFromIds (unsigned int iTypeId, int iClientId)
	Create a timer type from given timer type id and client id.
static std::shared_ptr< CPVRTimerType >	CreateFromAttributes (uint64_t iMustHaveAttr, uint64_t iMustNotHaveAttr, int iClientId)
	Create a timer type from given timer type attributes and client id.

Constructor & Destructor Documentation

CPVRTimerType() [1/4]

CPVRTimerType::CPVRTimerType

(

)

CPVRTimerType() [2/4]

CPVRTimerType::CPVRTimerType	(	const PVR_TIMER_TYPE &	type,
		int	iClientId )

CPVRTimerType() [3/4]

CPVRTimerType::CPVRTimerType	(	unsigned int	iTypeId,
		uint64_t	iAttributes,
		const std::string &	strDescription = "" )

~CPVRTimerType()

CPVRTimerType::~CPVRTimerType ( )

virtualdefault

CPVRTimerType() [4/4]

PVR::CPVRTimerType::CPVRTimerType ( const CPVRTimerType & type )

delete

Member Function Documentation

AllowsDelete()

bool PVR::CPVRTimerType::AllowsDelete ( ) const

inline

Check whether this type allows deletion.

Returns

True if type allows deletion, false otherwise.

CreateFromAttributes()

std::shared_ptr< CPVRTimerType > CPVRTimerType::CreateFromAttributes ( uint64_t iMustHaveAttr, uint64_t iMustNotHaveAttr, int iClientId )

static

Create a timer type from given timer type attributes and client id.

Parameters

iMustHaveAttr	a combination of PVR_TIMER_TYPE_* attributes the type to create must have.
iMustNotHaveAttr	a combination of PVR_TIMER_TYPE_* attributes the type to create must not have.
iClientId	the PVR client id.

Returns

A timer type instance.

CreateFromIds()

std::shared_ptr< CPVRTimerType > CPVRTimerType::CreateFromIds ( unsigned int iTypeId, int iClientId )

static

Create a timer type from given timer type id and client id.

Parameters

iTimerType	the timer type id.
iClientId	the PVR client id.

Returns

A timer type instance.

ForbidsEpgTagOnCreate()

bool PVR::CPVRTimerType::ForbidsEpgTagOnCreate ( ) const

inline

Check whether this timer type is forbidden when epg tag info is present.

Returns

True if new instances are forbidden when epg info is present, false otherwise.

ForbidsNewInstances()

bool PVR::CPVRTimerType::ForbidsNewInstances ( ) const

inline

Check whether this type forbids creation of new timers of this type.

Returns

True if new instances are forbidden, false otherwise.

GetAllTypes()

const std::vector< std::shared_ptr< CPVRTimerType > > CPVRTimerType::GetAllTypes ( )

static

Return a list with all known timer types.

Returns

A list of timer types or an empty list if no types available.

GetAttributes()

uint64_t PVR::CPVRTimerType::GetAttributes ( ) const

inline

Get the attributes of this type.

Returns

The attributes.

GetClientId()

int PVR::CPVRTimerType::GetClientId ( ) const

inline

Get the PVR client id for this type.

Returns

The PVR client id.

GetDescription()

const std::string & PVR::CPVRTimerType::GetDescription ( ) const

inline

Get the plain text (UI) description of this type.

Returns

The description.

GetFirstAvailableType()

const std::shared_ptr< CPVRTimerType > CPVRTimerType::GetFirstAvailableType ( const std::shared_ptr< const CPVRClient > & client )

static

Return the first available timer type from given client.

Parameters

client

the PVR client.

Returns

A timer type or NULL if none available.

GetLifetimeDefault()

int PVR::CPVRTimerType::GetLifetimeDefault ( ) const

inline

Obtain the default value for the lifetime attribute.

Returns

the default value.

GetLifetimeValues()

void CPVRTimerType::GetLifetimeValues

(

std::vector< std::pair< std::string, int > > &

list

)

const

Obtain a list with all possible values for the lifetime attribute.

Parameters

list	out, the list with the values or an empty list, if lifetime is not supported by this type.

GetMaxRecordingsDefault()

int PVR::CPVRTimerType::GetMaxRecordingsDefault ( ) const

inline

Obtain the default value for the MaxRecordings attribute.

Returns

the default value.

GetMaxRecordingsValues()

void CPVRTimerType::GetMaxRecordingsValues

(

std::vector< std::pair< std::string, int > > &

list

)

const

Obtain a list with all possible values for the MaxRecordings attribute.

Parameters

list	out, the list with the values or an empty list, if MaxRecordings is not supported by this type.

GetPreventDuplicateEpisodesDefault()

int PVR::CPVRTimerType::GetPreventDuplicateEpisodesDefault ( ) const

inline

Obtain the default value for the duplicate episode prevention attribute.

Returns

the default value.

GetPreventDuplicateEpisodesValues()

void CPVRTimerType::GetPreventDuplicateEpisodesValues

(

std::vector< std::pair< std::string, int > > &

list

)

const

Obtain a list with all possible values for the duplicate episode prevention attribute.

Parameters

list	out, the list with the values or an empty list, if duplicate episode prevention is not supported by this type.

GetPriorityDefault()

int PVR::CPVRTimerType::GetPriorityDefault ( ) const

inline

Obtain the default value for the priority attribute.

Returns

the default value.

GetPriorityValues()

void CPVRTimerType::GetPriorityValues

(

std::vector< std::pair< std::string, int > > &

list

)

const

Obtain a list with all possible values for the priority attribute.

Parameters

list	out, the list with the values or an empty list, if priority is not supported by this type.

GetRecordingGroupDefault()

int PVR::CPVRTimerType::GetRecordingGroupDefault ( ) const

inline

Obtain the default value for the Recording Group attribute.

Returns

the default value.

GetRecordingGroupValues()

void CPVRTimerType::GetRecordingGroupValues

(

std::vector< std::pair< std::string, int > > &

list

)

const

Obtain a list with all possible values for the recording group attribute.

Parameters

list	out, the list with the values or an empty list, if recording group is not supported by this type.

GetTypeId()

unsigned int PVR::CPVRTimerType::GetTypeId ( ) const

inline

Get the numeric type id of this type.

Returns

The type id.

IsEpgBased()

bool PVR::CPVRTimerType::IsEpgBased ( ) const

inline

Check whether this type is for epg-based or manual timers.

Returns

True if epg-based, false otherwise.

IsEpgBasedOnetime()

bool PVR::CPVRTimerType::IsEpgBasedOnetime ( ) const

inline

Check whether this type is for one time epg-based timers.

Returns

True if one time epg-based, false otherwise.

IsEpgBasedTimerRule()

bool PVR::CPVRTimerType::IsEpgBasedTimerRule ( ) const

inline

Check whether this type is for epg-based timer rules.

Returns

True if epg-based timer rule, false otherwise.

IsManual()

bool PVR::CPVRTimerType::IsManual ( ) const

inline

Check whether this type is for epg-based or manual timers.

Returns

True if manual, false otherwise.

IsManualOnetime()

bool PVR::CPVRTimerType::IsManualOnetime ( ) const

inline

Check whether this type is for one time manual timers.

Returns

True if one time manual, false otherwise.

IsManualTimerRule()

bool PVR::CPVRTimerType::IsManualTimerRule ( ) const

inline

Check whether this type is for manual timer rules.

Returns

True if manual timer rule, false otherwise.

IsOnetime()

bool PVR::CPVRTimerType::IsOnetime ( ) const

inline

Check whether this type is for timer rules or one time timers.

Returns

True if type represents a one time timer, false otherwise.

IsReadOnly()

bool PVR::CPVRTimerType::IsReadOnly ( ) const

inline

Check whether this type is readonly (must not be modified after initial creation).

Returns

True if readonly, false otherwise.

IsReminder()

bool PVR::CPVRTimerType::IsReminder ( ) const

inline

Check whether this type is for reminder timers or recording timers.

Returns

True if type represents a reminder timer, false otherwise.

IsTimerRule()

bool PVR::CPVRTimerType::IsTimerRule ( ) const

inline

Check whether this type is for timer rules or one time timers.

Returns

True if type represents a timer rule, false otherwise.

operator!=()

bool CPVRTimerType::operator!=

(

const CPVRTimerType &

right

)

const

operator=()

CPVRTimerType & PVR::CPVRTimerType::operator= ( const CPVRTimerType & orig )

delete

operator==()

bool CPVRTimerType::operator==

(

const CPVRTimerType &

right

)

const

RequiresEpgSeriesLinkOnCreate()

bool PVR::CPVRTimerType::RequiresEpgSeriesLinkOnCreate ( ) const

inline

Check whether this timer type requires epg tag info including a series link to be present.

Returns

True if new instances require an EPG tag with a series link, false otherwise.

RequiresEpgSeriesOnCreate()

bool PVR::CPVRTimerType::RequiresEpgSeriesOnCreate ( ) const

inline

Check whether this timer type requires epg tag info including series attributes to be present.

Returns

True if new instances require an EPG tag with series attributes, false otherwise.

RequiresEpgTagOnCreate()

bool PVR::CPVRTimerType::RequiresEpgTagOnCreate ( ) const

inline

Check whether this timer type requires epg tag info to be present.

Returns

True if new instances require EPG info, false otherwise.

SupportsAnyChannel()

bool PVR::CPVRTimerType::SupportsAnyChannel ( ) const

inline

Check whether this type supports 'any channel', for example for defining a timer rule that should match any channel instead of a particular channel.

Returns

True if any channel is supported, false otherwise.

SupportsChannels()

bool PVR::CPVRTimerType::SupportsChannels ( ) const

inline

Check whether this type supports channels.

Returns

True if channels are supported, false otherwise.

SupportsEnableDisable()

bool PVR::CPVRTimerType::SupportsEnableDisable ( ) const

inline

Check whether this type supports the "enabling/disabling" of timers of its type.

Returns

True if "enabling/disabling" feature is supported, false otherwise.

SupportsEndAnyTime()

bool PVR::CPVRTimerType::SupportsEndAnyTime ( ) const

inline

Check whether this type supports end any time.

Returns

True if end any time is supported, false otherwise.

SupportsEndMargin()

bool PVR::CPVRTimerType::SupportsEndMargin ( ) const

inline

Check whether this type supports post record time.

Returns

True if post record time is supported, false otherwise.

SupportsEndTime()

bool PVR::CPVRTimerType::SupportsEndTime ( ) const

inline

Check whether this type supports end time.

Returns

True if end time values are supported, false otherwise.

SupportsEpgFulltextMatch()

bool PVR::CPVRTimerType::SupportsEpgFulltextMatch ( ) const

inline

Check whether this type supports matching a search string against extended (fulltext) epg data. This includes title matching.

Returns

True if fulltext matching is supported, false otherwise.

SupportsEpgTitleMatch()

bool PVR::CPVRTimerType::SupportsEpgTitleMatch ( ) const

inline

Check whether this type supports matching a search string against epg episode title.

Returns

True if title matching is supported, false otherwise.

SupportsFirstDay()

bool PVR::CPVRTimerType::SupportsFirstDay ( ) const

inline

Check whether this type supports a first day the timer is active.

Returns

True if first day is supported, false otherwise.

SupportsLifetime()

bool PVR::CPVRTimerType::SupportsLifetime ( ) const

inline

Check whether this type supports lifetime for recordings.

Returns

True if recording lifetime is supported, false otherwise.

SupportsMaxRecordings()

bool PVR::CPVRTimerType::SupportsMaxRecordings ( ) const

inline

Check whether this type supports MaxRecordings for recordings.

Returns

True if MaxRecordings is supported, false otherwise.

SupportsPriority()

bool PVR::CPVRTimerType::SupportsPriority ( ) const

inline

Check whether this type supports recording priorities.

Returns

True if recording priority is supported, false otherwise.

SupportsReadOnlyDelete()

bool PVR::CPVRTimerType::SupportsReadOnlyDelete ( ) const

inline

Check whether this type supports deletion of an otherwise read-only timer.

Returns

True if read-only deletion is supported, false otherwise.

SupportsRecordingFolders()

bool PVR::CPVRTimerType::SupportsRecordingFolders ( ) const

inline

Check whether this type supports user specified recording folders.

Returns

True if recording folders are supported, false otherwise.

SupportsRecordingGroup()

bool PVR::CPVRTimerType::SupportsRecordingGroup ( ) const

inline

Check whether this type supports recording groups.

Returns

True if recording groups are supported, false otherwise.

SupportsRecordOnlyNewEpisodes()

bool PVR::CPVRTimerType::SupportsRecordOnlyNewEpisodes ( ) const

inline

Check whether this type supports the "record only new episodes" feature.

Returns

True if the "record only new episodes" feature is supported, false otherwise.

SupportsStartAnyTime()

bool PVR::CPVRTimerType::SupportsStartAnyTime ( ) const

inline

Check whether this type supports start any time.

Returns

True if start any time is supported, false otherwise.

SupportsStartMargin()

bool PVR::CPVRTimerType::SupportsStartMargin ( ) const

inline

Check whether this type supports pre record time.

Returns

True if pre record time is supported, false otherwise.

SupportsStartTime()

bool PVR::CPVRTimerType::SupportsStartTime ( ) const

inline

Check whether this type supports start time.

Returns

True if start time values are supported, false otherwise.

SupportsWeekdays()

bool PVR::CPVRTimerType::SupportsWeekdays ( ) const

inline

Check whether this type supports weekdays for timer schedules.

Returns

True if weekdays are supported, false otherwise.

Update()

void CPVRTimerType::Update

(

const CPVRTimerType &

type

)

Update the data of this instance with the data given by another type instance.

Parameters

type	The instance containing the updated data.

---

The documentation for this class was generated from the following files:

• PVRTimerType.h
• PVRTimerType.cpp