PERIPHERALS::CPeripheralBusGCController Class Reference

#include <PeripheralBusGCController.h>

Inheritance diagram for PERIPHERALS::CPeripheralBusGCController:

Public Member Functions
	CPeripheralBusGCController (CPeripherals &manager)
	~CPeripheralBusGCController () override
bool	InitializeProperties (CPeripheral &peripheral) override
	Initialize the properties of a peripheral with a known location.
void	Initialise (void) override
	Initialise this bus and start a polling thread if this bus needs polling.
void	ProcessEvents () override
	Poll for events.
bool	PerformDeviceScan (PeripheralScanResults &results) override
	Scan for devices on this bus and add them to the results list. This will have to be implemented for each bus.
PeripheralScanResults	GetInputDevices ()
void	callOnDeviceAdded (const std::string &strLocation)
void	callOnDeviceRemoved (const std::string &strLocation)
void	SetScanResults (const PeripheralScanResults &resScanResults)
const std::string &	getDeviceLocationPrefix ()
Public Member Functions inherited from PERIPHERALS::CPeripheralBus
	CPeripheralBus (const std::string &threadname, CPeripherals &manager, PeripheralBusType type)
	~CPeripheralBus (void) override
PeripheralBusType	Type (void) const
bool	NeedsPolling (void) const
virtual bool	InitializeButtonMap (const CPeripheral &peripheral, KODI::JOYSTICK::IButtonMap &buttonMap) const
	Initialize a joystick buttonmap, if possible.
virtual std::string	GetAppearance (const CPeripheral &peripheral) const
	Get the appearance of a peripheral, if known.
virtual PeripheralPtr	GetPeripheral (const std::string &strLocation) const
	Get the instance of the peripheral at the given location.
virtual bool	HasPeripheral (const std::string &strLocation) const
	Check whether a peripheral is present at the given location.
virtual bool	SupportsFeature (PeripheralFeature feature) const
	Check if the bus supports the given feature.
virtual unsigned int	GetPeripheralsWithFeature (PeripheralVector &results, const PeripheralFeature feature) const
	Get all peripheral instances that have the given feature.
virtual unsigned int	GetNumberOfPeripherals () const
virtual unsigned int	GetNumberOfPeripheralsWithId (const int iVendorId, const int iProductId) const
virtual void	GetFeatures (std::vector< PeripheralFeature > &features) const
	Get all features that are supported by devices on this bus.
virtual bool	HasFeature (const PeripheralFeature feature) const
	Check whether there is at least one device present with the given feature.
virtual void	OnDeviceAdded (const std::string &strLocation)
	Callback method for when a device has been added. Will perform a device scan.
virtual void	OnDeviceChanged (const std::string &strLocation)
	Callback method for when a device has been changed. Will perform a device scan.
virtual void	OnDeviceRemoved (const std::string &strLocation)
	Callback method for when a device has been removed. Will perform a device scan.
virtual void	Clear (void)
	Stop the polling thread and clear all known devices on this bus.
virtual void	TriggerDeviceScan (void)
	Scan for devices.
virtual void	GetDirectory (const std::string &strPath, CFileItemList &items) const
	Get all fileitems for a path.
virtual PeripheralPtr	GetByPath (const std::string &strPath) const
	Get the instance of a peripheral given it's path.
virtual void	Register (const PeripheralPtr &peripheral)
	Register a new peripheral on this bus.
virtual bool	FindComPort (std::string &strLocation)
virtual void	EnableButtonMapping ()
	Initialize button mapping.
virtual void	PowerOff (const std::string &strLocation)
	Power off the specified device.

Additional Inherited Members
Protected Types inherited from CThread
enum	WaitResponse { WAIT_INTERRUPTED = -1 , WAIT_SIGNALED = 0 , WAIT_TIMEDOUT = 1 }
Protected Member Functions inherited from PERIPHERALS::CPeripheralBus
void	Process (void) override
virtual bool	ScanForDevices (void)
virtual void	UnregisterRemovedDevices (const PeripheralScanResults &results)
virtual void	RegisterNewDevices (const PeripheralScanResults &results)
Protected Member Functions inherited from CThread
	CThread (const char *ThreadName)
virtual void	OnStartup ()
virtual void	OnExit ()
WaitResponse	AbortableWait (CEvent &event, std::chrono::milliseconds duration=std::chrono::milliseconds(-1))
	CThread (IRunnable *pRunnable, const char *ThreadName)
virtual	~CThread ()
void	Create (bool bAutoDelete=false)
template<typename Rep, typename Period>
void	Sleep (std::chrono::duration< Rep, Period > duration)
bool	IsAutoDelete () const
virtual void	StopThread (bool bWait=true)
bool	IsRunning () const
bool	IsCurrentThread () const
bool	Join (std::chrono::milliseconds duration)
bool	SetPriority (const ThreadPriority &priority)
	Set the threads priority. This uses the platforms native threading library to do so.
virtual void	OnException ()
Static Protected Member Functions inherited from CThread
static const std::thread::id	GetCurrentThreadId ()
static CThread *	GetCurrentThread ()
Protected Attributes inherited from PERIPHERALS::CPeripheralBus
PeripheralVector	m_peripherals
std::chrono::milliseconds	m_iRescanTime
bool	m_bNeedsPolling
CPeripherals &	m_manager
const PeripheralBusType	m_type
CCriticalSection	m_critSection
CEvent	m_triggerEvent
Protected Attributes inherited from CThread
std::atomic< bool >	m_bStop

Constructor & Destructor Documentation

CPeripheralBusGCController()

PERIPHERALS::CPeripheralBusGCController::CPeripheralBusGCController ( CPeripherals & manager )

explicit

~CPeripheralBusGCController()

PERIPHERALS::CPeripheralBusGCController::~CPeripheralBusGCController ( )

override

Member Function Documentation

callOnDeviceAdded()

void PERIPHERALS::CPeripheralBusGCController::callOnDeviceAdded

(

const std::string &

strLocation

)

callOnDeviceRemoved()

void PERIPHERALS::CPeripheralBusGCController::callOnDeviceRemoved

(

const std::string &

strLocation

)

getDeviceLocationPrefix()

const std::string & PERIPHERALS::CPeripheralBusGCController::getDeviceLocationPrefix ( )

inline

GetInputDevices()

PERIPHERALS::PeripheralScanResults PERIPHERALS::CPeripheralBusGCController::GetInputDevices

(

)

Initialise()

void PERIPHERALS::CPeripheralBusGCController::Initialise ( void )

overridevirtual

Initialise this bus and start a polling thread if this bus needs polling.

Reimplemented from PERIPHERALS::CPeripheralBus.

InitializeProperties()

bool PERIPHERALS::CPeripheralBusGCController::InitializeProperties ( CPeripheral & peripheral )

overridevirtual

Initialize the properties of a peripheral with a known location.

Reimplemented from PERIPHERALS::CPeripheralBus.

PerformDeviceScan()

bool PERIPHERALS::CPeripheralBusGCController::PerformDeviceScan ( PeripheralScanResults & results )

overridevirtual

Scan for devices on this bus and add them to the results list. This will have to be implemented for each bus.

Parameters

results

The result list.

Returns

True when the scan was successful, false otherwise.

Implements PERIPHERALS::CPeripheralBus.

ProcessEvents()

void PERIPHERALS::CPeripheralBusGCController::ProcessEvents ( void )

overridevirtual

Poll for events.

Todo

Multiple controller event processing

Todo

Multiple controller handling

Reimplemented from PERIPHERALS::CPeripheralBus.

SetScanResults()

void PERIPHERALS::CPeripheralBusGCController::SetScanResults

(

const PeripheralScanResults &

resScanResults

)

---

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

• PeripheralBusGCController.h
• PeripheralBusGCController.mm