BaseLib::DeviceDescription::UiElements Class Reference

Class holding information on how UI elements look like. More...

#include <UiElements.h>

Classes
struct	UiPeerInfo
struct	UiVariableInfo

Public Types
typedef std::shared_ptr< UiVariableInfo >	PUiVariableInfo
typedef std::shared_ptr< UiPeerInfo >	PUiPeerInfo

Public Member Functions
struct BaseLib::DeviceDescription::UiElements::UiVariableInfo	__attribute__ ((aligned(128)))
struct BaseLib::DeviceDescription::UiElements::UiPeerInfo	__attribute__ ((aligned(64)))
	UiElements (BaseLib::SharedObjects *baseLib)
virtual	~UiElements ()=default
void	clear ()
PVariable	getUiElements (const std::string &language)
PHomegearUiElement	getUiElement (const std::string &language, const std::string &id)
PHomegearUiElement	getUiElement (const std::string &language, const std::string &id, PUiPeerInfo peerInfo)
	Returns an UI element and assigns peer IDs to it. More...

Protected Member Functions
void	load (const std::string &language)

Protected Attributes
BaseLib::SharedObjects *	_bl = nullptr
std::mutex	_uiInfoMutex
std::unordered_map< std::string, std::unordered_map< std::string, PHomegearUiElement > >	_uiInfo

Detailed Description

Class holding information on how UI elements look like.

It is used to load all UI elements.

Member Typedef Documentation

PUiPeerInfo

typedef std::shared_ptr<UiPeerInfo> BaseLib::DeviceDescription::UiElements::PUiPeerInfo

PUiVariableInfo

typedef std::shared_ptr<UiVariableInfo> BaseLib::DeviceDescription::UiElements::PUiVariableInfo

Constructor & Destructor Documentation

UiElements()

BaseLib::DeviceDescription::UiElements::UiElements ( BaseLib::SharedObjects *  baseLib )

explicit

~UiElements()

virtual BaseLib::DeviceDescription::UiElements::~UiElements ( )

virtualdefault

Member Function Documentation

__attribute__() [1/2]

struct BaseLib::DeviceDescription::UiElements::UiPeerInfo BaseLib::DeviceDescription::UiElements::__attribute__

(

(aligned(64))

)

__attribute__() [2/2]

struct BaseLib::DeviceDescription::UiElements::UiVariableInfo BaseLib::DeviceDescription::UiElements::__attribute__

(

(aligned(128))

)

clear()

void BaseLib::DeviceDescription::UiElements::clear

(

)

getUiElement() [1/2]

PHomegearUiElement BaseLib::DeviceDescription::UiElements::getUiElement	(	const std::string &	language,
		const std::string &	id
	)

getUiElement() [2/2]

PHomegearUiElement BaseLib::DeviceDescription::UiElements::getUiElement	(	const std::string &	language,
		const std::string &	id,
		PUiPeerInfo	peerInfo
	)

Returns an UI element and assigns peer IDs to it.

Parameters

language	The language to return (e. g. "en-US")
id	The ID of the UI element
peerInfo	The peer IDs to assign

Returns

Returns the UI element on success.

getUiElements()

PVariable BaseLib::DeviceDescription::UiElements::getUiElements

(

const std::string &

language

)

load()

void BaseLib::DeviceDescription::UiElements::load ( const std::string &  language )

protected

Member Data Documentation

_bl

BaseLib::SharedObjects* BaseLib::DeviceDescription::UiElements::_bl = nullptr

protected

_uiInfo

std::unordered_map<std::string, std::unordered_map<std::string, PHomegearUiElement> > BaseLib::DeviceDescription::UiElements::_uiInfo

protected

_uiInfoMutex

std::mutex BaseLib::DeviceDescription::UiElements::_uiInfoMutex

protected

---

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

• DeviceDescription/UI/UiElements.h
• DeviceDescription/UI/UiElements.cpp