Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
Loading...
Searching...
No Matches
PVR::CPVRTimersContainer Class Reference

#include <PVRTimers.h>

Inheritance diagram for PVR::CPVRTimersContainer:
PVR::CPVRTimers

Public Types

typedef std::vector< std::shared_ptr< CPVRTimerInfoTag > > VecTimerInfoTag
 
typedef std::map< CDateTime, VecTimerInfoTagMapTags
 

Public Member Functions

bool UpdateFromClient (const std::shared_ptr< CPVRTimerInfoTag > &timer)
 Add a timer tag to this container or update the tag if already present in this container.
 
std::shared_ptr< CPVRTimerInfoTagGetByClient (int iClientId, int iClientIndex) const
 Get the timer tag denoted by given client id and timer id.
 
const MapTagsGetTags () const
 Get the timertags map.
 

Protected Member Functions

void InsertEntry (const std::shared_ptr< CPVRTimerInfoTag > &newTimer)
 

Protected Attributes

CCriticalSection m_critSection
 
unsigned int m_iLastId = 0
 
MapTags m_tags
 

Member Typedef Documentation

◆ MapTags

◆ VecTimerInfoTag

typedef std::vector<std::shared_ptr<CPVRTimerInfoTag> > PVR::CPVRTimersContainer::VecTimerInfoTag

Member Function Documentation

◆ GetByClient()

std::shared_ptr< CPVRTimerInfoTag > CPVRTimersContainer::GetByClient ( int iClientId,
int iClientIndex ) const

Get the timer tag denoted by given client id and timer id.

Parameters
iClientIdThe client id.
iClientIndexThe timer id.
Returns
the timer tag if found, null otherwise.

◆ GetTags()

const MapTags & PVR::CPVRTimersContainer::GetTags ( ) const
inline

Get the timertags map.

Returns
The map.

◆ InsertEntry()

void CPVRTimersContainer::InsertEntry ( const std::shared_ptr< CPVRTimerInfoTag > & newTimer)
protected

◆ UpdateFromClient()

bool CPVRTimersContainer::UpdateFromClient ( const std::shared_ptr< CPVRTimerInfoTag > & timer)

Add a timer tag to this container or update the tag if already present in this container.

Parameters
Thetimer tag
Returns
True, if the update was successful. False, otherwise.

Member Data Documentation

◆ m_critSection

CCriticalSection PVR::CPVRTimersContainer::m_critSection
mutableprotected

◆ m_iLastId

unsigned int PVR::CPVRTimersContainer::m_iLastId = 0
protected

◆ m_tags

MapTags PVR::CPVRTimersContainer::m_tags
protected

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