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

#include <HmDevice.h>

Classes

struct  BooleanOperator
 
struct  Operations
 
struct  UIFlags
 

Public Member Functions

 HomeMaticParameter (BaseLib::SharedObjects *baseLib)
 
 HomeMaticParameter (BaseLib::SharedObjects *baseLib, xml_node *node, bool checkForID=false)
 
virtual ~HomeMaticParameter ()
 
virtual bool checkCondition (int32_t value)
 
virtual std::shared_ptr< Variable > convertFromPacket (std::vector< uint8_t > &data, bool isEvent=false)
 Converts binary data of a packet received by a physical interface to a RPC variable. More...
 
virtual void convertToPacket (const std::shared_ptr< Variable > value, std::vector< uint8_t > &convertedValue)
 Converts a RPC variable to binary data to send it over a physical interface. More...
 
virtual void convertToPacket (std::string value, std::vector< uint8_t > &convertedValue)
 Tries to convert a string value to a binary data to send it over a physical interface. More...
 
virtual void reverseData (const std::vector< uint8_t > &data, std::vector< uint8_t > &reversedData)
 Reverses a binary array. More...
 
virtual void adjustBitPosition (std::vector< uint8_t > &data)
 

Public Attributes

uint32_t _bitmask [8] = {0xFF, 0x01, 0x03, 0x07, 0x0F, 0x1F, 0x3F, 0x7F}
 
ParameterSet * parentParameterSet = nullptr
 
double index = 0
 
double size = 0
 
double index2 = 0
 
double size2 = 0
 
int32_t index2Offset = -1
 
bool isSigned = false
 
bool hidden = false
 
BooleanOperator::Enum booleanOperator = BooleanOperator::Enum::e
 
Operations::Enum operations = (Operations::Enum)3
 
UIFlags::Enum uiFlags = UIFlags::Enum::visible
 
PhysicalParameter::Type::Enum type = PhysicalParameter::Type::Enum::none
 
int32_t constValue = -1
 
std::string constValueString
 
std::string id
 
std::string param
 
std::string additionalParameter
 
std::string control
 
std::shared_ptr< LogicalParameter > logicalParameter
 
std::shared_ptr< PhysicalParameter > physicalParameter
 
std::vector< std::shared_ptr< ParameterConversion > > conversion
 
ParameterDescription description
 
bool omitIfSet = false
 
int32_t omitIf = 0
 
bool loopback = false
 
bool hasDominoEvents = false
 
int32_t mask = -1
 
std::string field
 
std::string subfield
 

Protected Attributes

BaseLib::SharedObjects * _bl = nullptr
 
std::shared_ptr< Rpc::RpcDecoder > _binaryDecoder
 
std::shared_ptr< Rpc::RpcEncoder > _binaryEncoder
 

Constructor & Destructor Documentation

§ HomeMaticParameter() [1/2]

BaseLib::HmDeviceDescription::HomeMaticParameter::HomeMaticParameter ( BaseLib::SharedObjects *  baseLib)

§ HomeMaticParameter() [2/2]

BaseLib::HmDeviceDescription::HomeMaticParameter::HomeMaticParameter ( BaseLib::SharedObjects *  baseLib,
xml_node *  node,
bool  checkForID = false 
)

§ ~HomeMaticParameter()

virtual BaseLib::HmDeviceDescription::HomeMaticParameter::~HomeMaticParameter ( )
inlinevirtual

Member Function Documentation

§ adjustBitPosition()

void BaseLib::HmDeviceDescription::HomeMaticParameter::adjustBitPosition ( std::vector< uint8_t > &  data)
virtual

§ checkCondition()

bool BaseLib::HmDeviceDescription::HomeMaticParameter::checkCondition ( int32_t  value)
virtual

§ convertFromPacket()

std::shared_ptr< Variable > BaseLib::HmDeviceDescription::HomeMaticParameter::convertFromPacket ( std::vector< uint8_t > &  data,
bool  isEvent = false 
)
virtual

Converts binary data of a packet received by a physical interface to a RPC variable.

Parameters
[in]dataThe data to convert. It is not modified, even though there is no "const".
isEvent(default false) Set to "true" if packet is an event packet. Necessary to set value of "Action" correctly.
Returns
Returns the RPC variable.

§ convertToPacket() [1/2]

void BaseLib::HmDeviceDescription::HomeMaticParameter::convertToPacket ( const std::shared_ptr< Variable >  value,
std::vector< uint8_t > &  convertedValue 
)
virtual

Converts a RPC variable to binary data to send it over a physical interface.

Parameters
[in]valueThe value to convert.
[out]convertedValueThe converted binary data.

§ convertToPacket() [2/2]

void BaseLib::HmDeviceDescription::HomeMaticParameter::convertToPacket ( std::string  value,
std::vector< uint8_t > &  convertedValue 
)
virtual

Tries to convert a string value to a binary data to send it over a physical interface.

Parameters
[in]valueThe value to convert.
[out]convertedValueThe converted binary data.

§ reverseData()

void BaseLib::HmDeviceDescription::HomeMaticParameter::reverseData ( const std::vector< uint8_t > &  data,
std::vector< uint8_t > &  reversedData 
)
virtual

Reverses a binary array.

Parameters
[in]dataThe array to reverse.
[out]reversedDataThe reversed array.

Member Data Documentation

§ _binaryDecoder

std::shared_ptr<Rpc::RpcDecoder> BaseLib::HmDeviceDescription::HomeMaticParameter::_binaryDecoder
protected

§ _binaryEncoder

std::shared_ptr<Rpc::RpcEncoder> BaseLib::HmDeviceDescription::HomeMaticParameter::_binaryEncoder
protected

§ _bitmask

uint32_t BaseLib::HmDeviceDescription::HomeMaticParameter::_bitmask[8] = {0xFF, 0x01, 0x03, 0x07, 0x0F, 0x1F, 0x3F, 0x7F}

§ _bl

BaseLib::SharedObjects* BaseLib::HmDeviceDescription::HomeMaticParameter::_bl = nullptr
protected

§ additionalParameter

std::string BaseLib::HmDeviceDescription::HomeMaticParameter::additionalParameter

§ booleanOperator

BooleanOperator::Enum BaseLib::HmDeviceDescription::HomeMaticParameter::booleanOperator = BooleanOperator::Enum::e

§ constValue

int32_t BaseLib::HmDeviceDescription::HomeMaticParameter::constValue = -1

§ constValueString

std::string BaseLib::HmDeviceDescription::HomeMaticParameter::constValueString

§ control

std::string BaseLib::HmDeviceDescription::HomeMaticParameter::control

§ conversion

std::vector<std::shared_ptr<ParameterConversion> > BaseLib::HmDeviceDescription::HomeMaticParameter::conversion

§ description

ParameterDescription BaseLib::HmDeviceDescription::HomeMaticParameter::description

§ field

std::string BaseLib::HmDeviceDescription::HomeMaticParameter::field

§ hasDominoEvents

bool BaseLib::HmDeviceDescription::HomeMaticParameter::hasDominoEvents = false

§ hidden

bool BaseLib::HmDeviceDescription::HomeMaticParameter::hidden = false

§ id

std::string BaseLib::HmDeviceDescription::HomeMaticParameter::id

§ index

double BaseLib::HmDeviceDescription::HomeMaticParameter::index = 0

§ index2

double BaseLib::HmDeviceDescription::HomeMaticParameter::index2 = 0

§ index2Offset

int32_t BaseLib::HmDeviceDescription::HomeMaticParameter::index2Offset = -1

§ isSigned

bool BaseLib::HmDeviceDescription::HomeMaticParameter::isSigned = false

§ logicalParameter

std::shared_ptr<LogicalParameter> BaseLib::HmDeviceDescription::HomeMaticParameter::logicalParameter

§ loopback

bool BaseLib::HmDeviceDescription::HomeMaticParameter::loopback = false

§ mask

int32_t BaseLib::HmDeviceDescription::HomeMaticParameter::mask = -1

§ omitIf

int32_t BaseLib::HmDeviceDescription::HomeMaticParameter::omitIf = 0

§ omitIfSet

bool BaseLib::HmDeviceDescription::HomeMaticParameter::omitIfSet = false

§ operations

Operations::Enum BaseLib::HmDeviceDescription::HomeMaticParameter::operations = (Operations::Enum)3

§ param

std::string BaseLib::HmDeviceDescription::HomeMaticParameter::param

§ parentParameterSet

ParameterSet* BaseLib::HmDeviceDescription::HomeMaticParameter::parentParameterSet = nullptr

§ physicalParameter

std::shared_ptr<PhysicalParameter> BaseLib::HmDeviceDescription::HomeMaticParameter::physicalParameter

§ size

double BaseLib::HmDeviceDescription::HomeMaticParameter::size = 0

§ size2

double BaseLib::HmDeviceDescription::HomeMaticParameter::size2 = 0

§ subfield

std::string BaseLib::HmDeviceDescription::HomeMaticParameter::subfield

§ type

PhysicalParameter::Type::Enum BaseLib::HmDeviceDescription::HomeMaticParameter::type = PhysicalParameter::Type::Enum::none

§ uiFlags

UIFlags::Enum BaseLib::HmDeviceDescription::HomeMaticParameter::uiFlags = UIFlags::Enum::visible
The documentation for this class was generated from the following files: