Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
KODI::GAME::CControllerHub Class Reference

A branch in the controller tree. More...

#include <ControllerHub.h>

Public Member Functions

 CControllerHub ()=default
 
 CControllerHub (const CControllerHub &other)
 
 CControllerHub (CControllerHub &&other)=default
 
CControllerHuboperator= (const CControllerHub &rhs)
 
CControllerHuboperator= (CControllerHub &&rhs) noexcept
 
 ~CControllerHub ()
 
void Clear ()
 
bool HasPorts () const
 
PortVecGetPorts ()
 
const PortVecGetPorts () const
 
void SetPorts (PortVec ports)
 
bool IsControllerAccepted (const std::string &controllerId) const
 
bool IsControllerAccepted (const std::string &portAddress, const std::string &controllerId) const
 
ControllerVector GetControllers () const
 
void GetControllers (ControllerVector &controllers) const
 
const CPortNodeGetPort (const std::string &address) const
 
void GetInputPorts (std::vector< std::string > &inputPorts) const
 Get a list of ports that accept player input.
 
void GetKeyboardPorts (std::vector< std::string > &keyboardPorts) const
 Get a list of ports that accept keyboard input.
 
void GetMousePorts (std::vector< std::string > &mousePorts) const
 Get a list of ports that accept mouse input.
 
bool Serialize (tinyxml2::XMLElement &controllerElement) const
 
bool Deserialize (const tinyxml2::XMLElement &controllerElement)
 
std::string GetDigest (UTILITY::CDigest::Type digestType) const
 

Detailed Description

A branch in the controller tree.

Constructor & Destructor Documentation

◆ CControllerHub() [1/3]

KODI::GAME::CControllerHub::CControllerHub ( )
default

◆ CControllerHub() [2/3]

KODI::GAME::CControllerHub::CControllerHub ( const CControllerHub & other)
inline

◆ CControllerHub() [3/3]

KODI::GAME::CControllerHub::CControllerHub ( CControllerHub && other)
default

◆ ~CControllerHub()

CControllerHub::~CControllerHub ( )
default

Member Function Documentation

◆ Clear()

void CControllerHub::Clear ( )

◆ Deserialize()

bool CControllerHub::Deserialize ( const tinyxml2::XMLElement & controllerElement)

◆ GetControllers() [1/2]

ControllerVector CControllerHub::GetControllers ( ) const

◆ GetControllers() [2/2]

void CControllerHub::GetControllers ( ControllerVector & controllers) const

◆ GetDigest()

std::string CControllerHub::GetDigest ( UTILITY::CDigest::Type digestType) const

◆ GetInputPorts()

void CControllerHub::GetInputPorts ( std::vector< std::string > & inputPorts) const

Get a list of ports that accept player input.

Parameters
[out]inputPortsThe list of input ports

◆ GetKeyboardPorts()

void CControllerHub::GetKeyboardPorts ( std::vector< std::string > & keyboardPorts) const

Get a list of ports that accept keyboard input.

Parameters
[out]keyboardPortsThe list of keyboard ports

◆ GetMousePorts()

void CControllerHub::GetMousePorts ( std::vector< std::string > & mousePorts) const

Get a list of ports that accept mouse input.

Parameters
[out]mousePortsThe list of mouse ports

◆ GetPort()

const CPortNode & CControllerHub::GetPort ( const std::string & address) const

◆ GetPorts() [1/2]

PortVec & KODI::GAME::CControllerHub::GetPorts ( )
inline

◆ GetPorts() [2/2]

const PortVec & KODI::GAME::CControllerHub::GetPorts ( ) const
inline

◆ HasPorts()

bool KODI::GAME::CControllerHub::HasPorts ( ) const
inline

◆ IsControllerAccepted() [1/2]

bool CControllerHub::IsControllerAccepted ( const std::string & controllerId) const

◆ IsControllerAccepted() [2/2]

bool CControllerHub::IsControllerAccepted ( const std::string & portAddress,
const std::string & controllerId ) const

◆ operator=() [1/2]

CControllerHub & CControllerHub::operator= ( CControllerHub && rhs)
noexcept

◆ operator=() [2/2]

CControllerHub & CControllerHub::operator= ( const CControllerHub & rhs)

◆ Serialize()

bool CControllerHub::Serialize ( tinyxml2::XMLElement & controllerElement) const

◆ SetPorts()

void CControllerHub::SetPorts ( PortVec ports)

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