libhomegear-base  0.7
Base library for Homegear and Homegear family modules.
Public Types | Public Member Functions | Public Attributes | Protected Attributes | List of all members
BaseLib::DeviceDescription::HomegearUiElement Class Reference

Class defining a physical packet. More...

#include <HomegearUiElement.h>

Public Types

enum  Type { Type::undefined, Type::simple, Type::complex }
 

Public Member Functions

 HomegearUiElement (BaseLib::SharedObjects *baseLib)
 
 HomegearUiElement (BaseLib::SharedObjects *baseLib, xml_node *node)
 
 HomegearUiElement (HomegearUiElement const &rhs)
 
virtual ~HomegearUiElement ()=default
 
HomegearUiElement & operator= (const HomegearUiElement &rhs)
 
PVariable getElementInfo (bool addHelpInfo=false)
 

Public Attributes

std::string id
 
Type type = Type::undefined
 
std::string control
 
std::string description
 
std::unordered_map< std::string, PUiIcon > icons
 
std::unordered_map< std::string, PUiText > texts
 
std::list< PUiVariable > variableInputs
 
std::list< PUiVariable > variableOutputs
 
std::unordered_map< std::string, PVariable > metadata
 
PUiGrid grid
 
std::list< PUiControl > controls
 

Protected Attributes

BaseLib::SharedObjects * _bl = nullptr
 

Detailed Description

Class defining a physical packet.

Member Enumeration Documentation

§ Type

enum BaseLib::DeviceDescription::HomegearUiElement::Type
strong
Enumerator
undefined 
simple 
complex 

Constructor & Destructor Documentation

§ HomegearUiElement() [1/3]

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

§ HomegearUiElement() [2/3]

BaseLib::DeviceDescription::HomegearUiElement::HomegearUiElement ( BaseLib::SharedObjects *  baseLib,
xml_node *  node 
)

§ HomegearUiElement() [3/3]

BaseLib::DeviceDescription::HomegearUiElement::HomegearUiElement ( HomegearUiElement const &  rhs)

§ ~HomegearUiElement()

virtual BaseLib::DeviceDescription::HomegearUiElement::~HomegearUiElement ( )
virtualdefault

Member Function Documentation

§ getElementInfo()

PVariable BaseLib::DeviceDescription::HomegearUiElement::getElementInfo ( bool  addHelpInfo = false)

§ operator=()

HomegearUiElement & BaseLib::DeviceDescription::HomegearUiElement::operator= ( const HomegearUiElement &  rhs)

Member Data Documentation

§ _bl

BaseLib::SharedObjects* BaseLib::DeviceDescription::HomegearUiElement::_bl = nullptr
protected

§ control

std::string BaseLib::DeviceDescription::HomegearUiElement::control

§ controls

std::list<PUiControl> BaseLib::DeviceDescription::HomegearUiElement::controls

§ description

std::string BaseLib::DeviceDescription::HomegearUiElement::description

§ grid

PUiGrid BaseLib::DeviceDescription::HomegearUiElement::grid

§ icons

std::unordered_map<std::string, PUiIcon> BaseLib::DeviceDescription::HomegearUiElement::icons

§ id

std::string BaseLib::DeviceDescription::HomegearUiElement::id

§ metadata

std::unordered_map<std::string, PVariable> BaseLib::DeviceDescription::HomegearUiElement::metadata

§ texts

std::unordered_map<std::string, PUiText> BaseLib::DeviceDescription::HomegearUiElement::texts

§ type

Type BaseLib::DeviceDescription::HomegearUiElement::type = Type::undefined

§ variableInputs

std::list<PUiVariable> BaseLib::DeviceDescription::HomegearUiElement::variableInputs

§ variableOutputs

std::list<PUiVariable> BaseLib::DeviceDescription::HomegearUiElement::variableOutputs
The documentation for this class was generated from the following files: