Class for defining an electronic program guide (EPG) search request. More...

Inheritance diagram for dvblinkremote::EpgSearchRequest:

Public Member Functions
	EpgSearchRequest (const std::string &channelId, const long startTime=EPG_SEARCH_TIME_NOT_BOUND, const long endTime=EPG_SEARCH_TIME_NOT_BOUND, const bool shortEpg=false)
	Initializes a new instance of the dvblinkremote::EpgSearchRequest class.
	EpgSearchRequest (const ChannelIdentifierList &channelIdentifierList, const long startTime=EPG_SEARCH_TIME_NOT_BOUND, const long endTime=EPG_SEARCH_TIME_NOT_BOUND, const bool shortEpg=false)
	Initializes a new instance of the dvblinkremote::EpgSearchRequest class.
	~EpgSearchRequest ()
	Destructor for cleaning up allocated memory.
ChannelIdentifierList &	GetChannelIdentifiers ()
	Gets a list of the channel identifiers of the epg search request.
void	AddChannelID (const std::string &channelId)
	Adds a channel identifier to be searched for.
long	GetStartTime ()
	Gets the start time of the epg search request.
void	SetStartTime (const long startTime)
	Sets the start time to be searched for.
long	GetEndTime ()
	Gets the end time of the epg search request.
void	SetEndTime (const long endTime)
	Sets the end time to be searched for.
bool	IsShortEpg ()
	Gets if short epg flag is set for the epg search request.
void	SetShortEpg (const bool shortEpg)
	Sets the short epg flag of the search request.

Public Attributes
std::string	ProgramID
	String representing the program identifier to search for.
std::string	Keywords
	String representing the keywords to search for.

Static Public Attributes
static const long	EPG_SEARCH_TIME_NOT_BOUND
	Constant long value which specifies that a time value not is bound.

Detailed Description

Class for defining an electronic program guide (EPG) search request.

This is used as input parameter for the IDVBLinkRemoteConnection::SearchEpg method.

See Also: IDVBLinkRemoteConnection::SearchEpg()

Constructor & Destructor Documentation

dvblinkremote::EpgSearchRequest::EpgSearchRequest	(	const std::string &	channelId,
		const long	startTime = `EPG_SEARCH_TIME_NOT_BOUND`,
		const long	endTime = `EPG_SEARCH_TIME_NOT_BOUND`,
		const bool	shortEpg = `false`
	)

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

Parameters

channelId	a constant string reference representing the channel identifier for searching the epg.
startTime	an optional constant long representing the start time of programs for searching the epg.
endTime	an optional constant long representing the end time of programs for searching the epg.
shortEpg	an optional constant boolean representing a flag for the level of returned EPG information from the epg search.

Remarks: By setting a startTime or endTime the search will only return programs that fully or partially fall into a specified time span. One of the parameters startTime or endTime may be -1 (EpgSearchRequest::EPG_SEARCH_TIME_NOT_BOUND), meaning that the search is not bound on the start time or end time side.; startTime and endTime is the number of seconds, counted from UNIX epoc: 00:00:00 UTC on 1 January 1970.; shortEpg specifies the level of returned EPG information and allows for faster EPG overview build up. Short EPG information includes only program id, name, start time, duration and genre info. Default value is false.

dvblinkremote::EpgSearchRequest::EpgSearchRequest	(	const ChannelIdentifierList &	channelIdentifierList,
		const long	startTime = `EPG_SEARCH_TIME_NOT_BOUND`,
		const long	endTime = `EPG_SEARCH_TIME_NOT_BOUND`,
		const bool	shortEpg = `false`
	)

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

Parameters

channelIdentifierList	a constant dvblinkremote::ChannelIdentifierList instance reference representing a list of channel identifiers for searching the epg.
startTime	an optional constant long representing the start time of programs for searching the epg.
endTime	an optional constant long representing the end time of programs for searching the epg.
shortEpg	an optional constant boolean representing a flag for the level of returned EPG information from the epg search.

Remarks: By setting a startTime or endTime the search will only return programs that fully or partially fall into a specified time span. One of the parameters startTime or endTime may be -1 (EpgSearchRequest::EPG_SEARCH_TIME_NOT_BOUND), meaning that the search is not bound on the start time or end time side.; startTime and endTime is the number of seconds, counted from UNIX epoc: 00:00:00 UTC on 1 January 1970.; shortEpg specifies the level of returned EPG information and allows for faster EPG overview build up. Short EPG information includes only program id, name, start time, duration and genre info. Default value is false.

dvblinkremote::EpgSearchRequest::~EpgSearchRequest ( )

Destructor for cleaning up allocated memory.

Member Function Documentation

void dvblinkremote::EpgSearchRequest::AddChannelID ( const std::string & channelId )

Adds a channel identifier to be searched for.

Parameters

channelId a constant strint reference representing the channel identifier to search for.

ChannelIdentifierList& dvblinkremote::EpgSearchRequest::GetChannelIdentifiers ( )

Gets a list of the channel identifiers of the epg search request.

Returns: Epg search request channel identifiers

long dvblinkremote::EpgSearchRequest::GetEndTime ( )

Gets the end time of the epg search request.

Returns: Epg search request end time

Remarks: Number of seconds, counted from UNIX epoc: 00:00:00 UTC on 1 January 1970.

long dvblinkremote::EpgSearchRequest::GetStartTime ( )

Gets the start time of the epg search request.

Returns: Epg search request start time

Remarks: Number of seconds, counted from UNIX epoc: 00:00:00 UTC on 1 January 1970.

bool dvblinkremote::EpgSearchRequest::IsShortEpg ( )

Gets if short epg flag is set for the epg search request.

Returns: if short epg flag is set or not

void dvblinkremote::EpgSearchRequest::SetEndTime ( const long endTime )

Sets the end time to be searched for.

Parameters

endTime a constant long representing the end time to search for.

void dvblinkremote::EpgSearchRequest::SetShortEpg ( const bool shortEpg )

Sets the short epg flag of the search request.

Parameters

shortEpg a const boolean representing if short epg flag is set or not.

void dvblinkremote::EpgSearchRequest::SetStartTime ( const long startTime )

Sets the start time to be searched for.

Parameters

startTime a constant long representing the start time to search for.

Member Data Documentation

const long dvblinkremote::EpgSearchRequest::EPG_SEARCH_TIME_NOT_BOUND

static

Constant long value which specifies that a time value not is bound.

Used for the start time and end time.

See Also: EpgSearchRequest::EpgSearchRequest; EpgSearchRequest::GetStartTime(); EpgSearchRequest::SetStartTime; EpgSearchRequest::GetEndTime(); EpgSearchRequest::SetEndTime

std::string dvblinkremote::EpgSearchRequest::Keywords

String representing the keywords to search for.

std::string dvblinkremote::EpgSearchRequest::ProgramID

String representing the program identifier to search for.

Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation