PVR::CPVRChannelGroupFactory Class Reference

#include <PVRChannelGroupFactory.h>

Public Member Functions
	CPVRChannelGroupFactory ()=default
virtual	~CPVRChannelGroupFactory ()=default
std::shared_ptr< CPVRChannelGroup >	CreateAllChannelsGroup (bool isRadio)
	Create an all channels group instance.
std::shared_ptr< CPVRChannelGroup >	CreateClientGroup (const PVR_CHANNEL_GROUP &groupData, int clientID, const std::shared_ptr< const CPVRChannelGroup > &allChannels)
	Create an instance for a group provided by a PVR client add-on.
std::shared_ptr< CPVRChannelGroup >	CreateUserGroup (bool isRadio, const std::string &name, const std::shared_ptr< const CPVRChannelGroup > &allChannels)
	Create an instance for a group created by the user.
std::shared_ptr< CPVRChannelGroup >	CreateGroup (int groupType, const CPVRChannelsPath &groupPath, const std::shared_ptr< const CPVRChannelGroup > &allChannels)
	Create a channel group matching the given type.
int	GetGroupTypePriority (const std::shared_ptr< const CPVRChannelGroup > &group) const
	Get the priority (e.g. for sorting groups) for the type of the given group. Lower number means higer priority.
std::vector< std::shared_ptr< CPVRChannelGroup > >	CreateMissingGroups (const std::shared_ptr< CPVRChannelGroup > &allChannelsGroup, const std::vector< std::shared_ptr< CPVRChannelGroup > > &allChannelGroups)
	Create any missing channel groups (e.g. after an update of groups/members/clients).

Constructor & Destructor Documentation

CPVRChannelGroupFactory()

PVR::CPVRChannelGroupFactory::CPVRChannelGroupFactory ( )

default

~CPVRChannelGroupFactory()

virtual PVR::CPVRChannelGroupFactory::~CPVRChannelGroupFactory ( )

virtualdefault

Member Function Documentation

CreateAllChannelsGroup()

std::shared_ptr< CPVRChannelGroup > CPVRChannelGroupFactory::CreateAllChannelsGroup

(

bool

isRadio

)

Create an all channels group instance.

Parameters

isRadio

Whether Radio or TV.

Returns

The new group.

CreateClientGroup()

std::shared_ptr< CPVRChannelGroup > CPVRChannelGroupFactory::CreateClientGroup	(	const PVR_CHANNEL_GROUP &	groupData,
		int	clientID,
		const std::shared_ptr< const CPVRChannelGroup > &	allChannels )

Create an instance for a group provided by a PVR client add-on.

Parameters

groupData	The group data.
clientID	The id of the client that provided the group.
allChannels	The all channels group.

Returns

The new group.

CreateGroup()

std::shared_ptr< CPVRChannelGroup > CPVRChannelGroupFactory::CreateGroup	(	int	groupType,
		const CPVRChannelsPath &	groupPath,
		const std::shared_ptr< const CPVRChannelGroup > &	allChannels )

Create a channel group matching the given type.

Parameters

groupType	The type of the group.
groupPath	The path of the group.
allChannels	The all channels group.

Returns

The new group.

CreateMissingGroups()

std::vector< std::shared_ptr< CPVRChannelGroup > > CPVRChannelGroupFactory::CreateMissingGroups	(	const std::shared_ptr< CPVRChannelGroup > &	allChannelsGroup,
		const std::vector< std::shared_ptr< CPVRChannelGroup > > &	allChannelGroups )

Create any missing channel groups (e.g. after an update of groups/members/clients).

Parameters

allChannelsGroup	The all channels group.
allChannelGroups	All channel groups.

Returns

The newly created groups, if any.

CreateUserGroup()

std::shared_ptr< CPVRChannelGroup > CPVRChannelGroupFactory::CreateUserGroup	(	bool	isRadio,
		const std::string &	name,
		const std::shared_ptr< const CPVRChannelGroup > &	allChannels )

Create an instance for a group created by the user.

Parameters

isRadio	Whether Radio or TV.
name	The name for the group.
allChannels	The all channels group.

Returns

The new group.

GetGroupTypePriority()

int CPVRChannelGroupFactory::GetGroupTypePriority

(

const std::shared_ptr< const CPVRChannelGroup > &

group

)

const

Get the priority (e.g. for sorting groups) for the type of the given group. Lower number means higer priority.

Parameters

group

The group.

Returns

The group's type priority.

---

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

• PVRChannelGroupFactory.h
• PVRChannelGroupFactory.cpp