PVR::CPVREpgSearchFilter Class Reference

#include <EpgSearchFilter.h>

Public Member Functions
	CPVREpgSearchFilter ()=delete
	CPVREpgSearchFilter (bool bRadio)
	ctor.
void	Reset ()
	Clear this filter.
std::string	GetPath () const
	Return the path for this filter.
bool	FilterEntry (const std::shared_ptr< const CPVREpgInfoTag > &tag) const
	Check if a tag will be filtered or not.
bool	IsRadio () const
	Get the type of channels to search.
const std::string &	GetSearchTerm () const
void	SetSearchTerm (const std::string &strSearchTerm)
void	SetSearchPhrase (const std::string &strSearchPhrase)
bool	IsCaseSensitive () const
void	SetCaseSensitive (bool bIsCaseSensitive)
bool	ShouldSearchInDescription () const
void	SetSearchInDescription (bool bSearchInDescription)
int	GetGenreType () const
void	SetGenreType (int iGenreType)
int	GetMinimumDuration () const
void	SetMinimumDuration (int iMinimumDuration)
int	GetMaximumDuration () const
void	SetMaximumDuration (int iMaximumDuration)
bool	ShouldIgnoreFinishedBroadcasts () const
void	SetIgnoreFinishedBroadcasts (bool bIgnoreFinishedBroadcasts)
bool	ShouldIgnoreFutureBroadcasts () const
void	SetIgnoreFutureBroadcasts (bool bIgnoreFutureBroadcasts)
const CDateTime &	GetStartDateTime () const
void	SetStartDateTime (const CDateTime &startDateTime)
const CDateTime &	GetEndDateTime () const
void	SetEndDateTime (const CDateTime &endDateTime)
bool	ShouldIncludeUnknownGenres () const
void	SetIncludeUnknownGenres (bool bIncludeUnknownGenres)
bool	ShouldRemoveDuplicates () const
void	SetRemoveDuplicates (bool bRemoveDuplicates)
int	GetClientID () const
void	SetClientID (int iClientID)
int	GetChannelGroupID () const
void	SetChannelGroupID (int iChannelGroupID)
int	GetChannelUID () const
void	SetChannelUID (int iChannelUID)
bool	IsFreeToAirOnly () const
void	SetFreeToAirOnly (bool bFreeToAirOnly)
bool	ShouldIgnorePresentTimers () const
void	SetIgnorePresentTimers (bool bIgnorePresentTimers)
bool	ShouldIgnorePresentRecordings () const
void	SetIgnorePresentRecordings (bool bIgnorePresentRecordings)
int	GetDatabaseId () const
void	SetDatabaseId (int iDatabaseId)
const std::string &	GetTitle () const
void	SetTitle (const std::string &title)
const CDateTime &	GetLastExecutedDateTime () const
void	SetLastExecutedDateTime (const CDateTime &lastExecutedDateTime)
const PVREpgSearchData &	GetEpgSearchData () const
void	SetEpgSearchDataFiltered ()
bool	IsChanged () const
void	SetChanged (bool bChanged)

Static Public Member Functions
static void	RemoveDuplicates (std::vector< std::shared_ptr< CPVREpgInfoTag > > &results)
	remove duplicates from a list of epg tags.

Constructor & Destructor Documentation

CPVREpgSearchFilter() [1/2]

PVR::CPVREpgSearchFilter::CPVREpgSearchFilter ( )

delete

CPVREpgSearchFilter() [2/2]

CPVREpgSearchFilter::CPVREpgSearchFilter ( bool bRadio )

explicit

ctor.

Parameters

bRadio

the type of channels to search - if true, 'radio'. 'tv', otherwise.

Member Function Documentation

FilterEntry()

bool CPVREpgSearchFilter::FilterEntry

(

const std::shared_ptr< const CPVREpgInfoTag > &

tag

)

const

Check if a tag will be filtered or not.

Parameters

tag	The tag to check.

Returns

True if this tag matches the filter, false if not.

GetChannelGroupID()

int PVR::CPVREpgSearchFilter::GetChannelGroupID ( ) const

inline

GetChannelUID()

int PVR::CPVREpgSearchFilter::GetChannelUID ( ) const

inline

GetClientID()

int PVR::CPVREpgSearchFilter::GetClientID ( ) const

inline

GetDatabaseId()

int PVR::CPVREpgSearchFilter::GetDatabaseId ( ) const

inline

GetEndDateTime()

const CDateTime & PVR::CPVREpgSearchFilter::GetEndDateTime ( ) const

inline

GetEpgSearchData()

const PVREpgSearchData & PVR::CPVREpgSearchFilter::GetEpgSearchData ( ) const

inline

GetGenreType()

int PVR::CPVREpgSearchFilter::GetGenreType ( ) const

inline

GetLastExecutedDateTime()

const CDateTime & PVR::CPVREpgSearchFilter::GetLastExecutedDateTime ( ) const

inline

GetMaximumDuration()

int PVR::CPVREpgSearchFilter::GetMaximumDuration ( ) const

inline

GetMinimumDuration()

int PVR::CPVREpgSearchFilter::GetMinimumDuration ( ) const

inline

GetPath()

std::string CPVREpgSearchFilter::GetPath

(

)

const

Return the path for this filter.

Returns

the path.

GetSearchTerm()

const std::string & PVR::CPVREpgSearchFilter::GetSearchTerm ( ) const

inline

GetStartDateTime()

const CDateTime & PVR::CPVREpgSearchFilter::GetStartDateTime ( ) const

inline

GetTitle()

const std::string & PVR::CPVREpgSearchFilter::GetTitle ( ) const

inline

IsCaseSensitive()

bool PVR::CPVREpgSearchFilter::IsCaseSensitive ( ) const

inline

IsChanged()

bool PVR::CPVREpgSearchFilter::IsChanged ( ) const

inline

IsFreeToAirOnly()

bool PVR::CPVREpgSearchFilter::IsFreeToAirOnly ( ) const

inline

IsRadio()

bool PVR::CPVREpgSearchFilter::IsRadio ( ) const

inline

Get the type of channels to search.

Returns

true, if 'radio'. false, otherwise.

RemoveDuplicates()

void CPVREpgSearchFilter::RemoveDuplicates ( std::vector< std::shared_ptr< CPVREpgInfoTag > > & results )

static

remove duplicates from a list of epg tags.

Parameters

results

The list of epg tags.

Reset()

void CPVREpgSearchFilter::Reset

(

)

Clear this filter.

SetCaseSensitive()

void CPVREpgSearchFilter::SetCaseSensitive

(

bool

bIsCaseSensitive

)

SetChanged()

void PVR::CPVREpgSearchFilter::SetChanged ( bool bChanged )

inline

SetChannelGroupID()

void CPVREpgSearchFilter::SetChannelGroupID

(

int

iChannelGroupID

)

SetChannelUID()

void CPVREpgSearchFilter::SetChannelUID

(

int

iChannelUID

)

SetClientID()

void CPVREpgSearchFilter::SetClientID

(

int

iClientID

)

SetDatabaseId()

void CPVREpgSearchFilter::SetDatabaseId

(

int

iDatabaseId

)

SetEndDateTime()

void CPVREpgSearchFilter::SetEndDateTime

(

const CDateTime &

endDateTime

)

SetEpgSearchDataFiltered()

void PVR::CPVREpgSearchFilter::SetEpgSearchDataFiltered ( )

inline

SetFreeToAirOnly()

void CPVREpgSearchFilter::SetFreeToAirOnly

(

bool

bFreeToAirOnly

)

SetGenreType()

void CPVREpgSearchFilter::SetGenreType

(

int

iGenreType

)

SetIgnoreFinishedBroadcasts()

void CPVREpgSearchFilter::SetIgnoreFinishedBroadcasts

(

bool

bIgnoreFinishedBroadcasts

)

SetIgnoreFutureBroadcasts()

void CPVREpgSearchFilter::SetIgnoreFutureBroadcasts

(

bool

bIgnoreFutureBroadcasts

)

SetIgnorePresentRecordings()

void CPVREpgSearchFilter::SetIgnorePresentRecordings

(

bool

bIgnorePresentRecordings

)

SetIgnorePresentTimers()

void CPVREpgSearchFilter::SetIgnorePresentTimers

(

bool

bIgnorePresentTimers

)

SetIncludeUnknownGenres()

void CPVREpgSearchFilter::SetIncludeUnknownGenres

(

bool

bIncludeUnknownGenres

)

SetLastExecutedDateTime()

void CPVREpgSearchFilter::SetLastExecutedDateTime

(

const CDateTime &

lastExecutedDateTime

)

SetMaximumDuration()

void CPVREpgSearchFilter::SetMaximumDuration

(

int

iMaximumDuration

)

SetMinimumDuration()

void CPVREpgSearchFilter::SetMinimumDuration

(

int

iMinimumDuration

)

SetRemoveDuplicates()

void CPVREpgSearchFilter::SetRemoveDuplicates

(

bool

bRemoveDuplicates

)

SetSearchInDescription()

void CPVREpgSearchFilter::SetSearchInDescription

(

bool

bSearchInDescription

)

SetSearchPhrase()

void CPVREpgSearchFilter::SetSearchPhrase

(

const std::string &

strSearchPhrase

)

SetSearchTerm()

void CPVREpgSearchFilter::SetSearchTerm

(

const std::string &

strSearchTerm

)

SetStartDateTime()

void CPVREpgSearchFilter::SetStartDateTime

(

const CDateTime &

startDateTime

)

SetTitle()

void CPVREpgSearchFilter::SetTitle

(

const std::string &

title

)

ShouldIgnoreFinishedBroadcasts()

bool PVR::CPVREpgSearchFilter::ShouldIgnoreFinishedBroadcasts ( ) const

inline

ShouldIgnoreFutureBroadcasts()

bool PVR::CPVREpgSearchFilter::ShouldIgnoreFutureBroadcasts ( ) const

inline

ShouldIgnorePresentRecordings()

bool PVR::CPVREpgSearchFilter::ShouldIgnorePresentRecordings ( ) const

inline

ShouldIgnorePresentTimers()

bool PVR::CPVREpgSearchFilter::ShouldIgnorePresentTimers ( ) const

inline

ShouldIncludeUnknownGenres()

bool PVR::CPVREpgSearchFilter::ShouldIncludeUnknownGenres ( ) const

inline

ShouldRemoveDuplicates()

bool PVR::CPVREpgSearchFilter::ShouldRemoveDuplicates ( ) const

inline

ShouldSearchInDescription()

bool PVR::CPVREpgSearchFilter::ShouldSearchInDescription ( ) const

inline

---

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

• EpgSearchFilter.h
• EpgSearchFilter.cpp