OpenZWave Library 1.6.1914
Loading...
Searching...
No Matches
Public Member Functions | List of all members
OpenZWave::Internal::VC::ValueBitSet Class Reference
ValueID Support

BitSet value sent to/received from a node. More...

#include <ValueBitSet.h>

Inheritance diagram for OpenZWave::Internal::VC::ValueBitSet:
Collaboration diagram for OpenZWave::Internal::VC::ValueBitSet:

Public Member Functions

 ValueBitSet (uint32 const _homeId, uint8 const _nodeId, ValueID::ValueGenre const _genre, uint8 const _commandClassId, uint8 const _instance, uint16 const _index, string const &_label, string const &_units, bool const _readOnly, bool const _writeOnly, uint32 const _value, uint8 const _pollIntensity)
 ValueBitSet ()
virtual ~ValueBitSet ()
bool Set (uint32 const _value)
uint32 GetValue () const
void SetTargetValue (uint32 const _target, uint32 _duration=0)
bool SetBit (uint8 const _idx)
bool ClearBit (uint8 const _idx)
bool GetBit (uint8 _idx) const
bool SetBitMask (uint32 _bitMask)
uint32 GetBitMask () const
void OnValueRefreshed (uint32 const _value)
virtual string const GetAsString () const
virtual string const GetAsBinaryString () const
virtual bool SetFromString (string const &_value)
virtual void ReadXML (uint32 const _homeId, uint8 const _nodeId, uint8 const _commandClassId, TiXmlElement const *_valueElement)
virtual void WriteXML (TiXmlElement *_valueElement)
string GetBitHelp (uint8 _idx)
bool SetBitHelp (uint8 _idx, string help)
string GetBitLabel (uint8 _idx)
bool SetBitLabel (uint8 _idx, string label)
uint8 GetSize () const
void SetSize (uint8 size)
Public Member Functions inherited from OpenZWave::Internal::VC::Value
 Value (uint32 const _homeId, uint8 const _nodeId, ValueID::ValueGenre const _genre, uint8 const _commandClassId, uint8 const _instance, uint16 const _index, ValueID::ValueType const _type, string const &_label, string const &_units, bool const _readOnly, bool const _writeOnly, bool const _isset, uint8 const _pollIntensity)
 Value ()
ValueID const & GetID () const
bool IsReadOnly () const
bool IsWriteOnly () const
bool IsSet () const
bool IsPolled () const
string const GetLabel () const
void SetLabel (string const &_label, string const lang="")
string const & GetUnits () const
void SetUnits (string const &_units)
string const GetHelp () const
void SetHelp (string const &_help, string const lang="")
uint8 const & GetPollIntensity () const
void SetPollIntensity (uint8 const &_intensity)
int32 GetMin () const
int32 GetMax () const
void SetChangeVerified (bool _verify)
bool GetChangeVerified ()
void SetRefreshAfterSet (bool _refreshAfterSet)
bool GetRefreshAfterSet ()
bool Set ()
void sendValueRefresh (uint32 _unused)
Public Member Functions inherited from OpenZWave::Internal::Platform::Ref
 Ref ()
void AddRef ()
int32 Release ()

Additional Inherited Members

Static Public Member Functions inherited from OpenZWave::Internal::VC::Value
static OpenZWave::ValueID::ValueGenre GetGenreEnumFromName (char const *_name)
static char const * GetGenreNameFromEnum (ValueID::ValueGenre _genre)
static OpenZWave::ValueID::ValueType GetTypeEnumFromName (char const *_name)
static char const * GetTypeNameFromEnum (ValueID::ValueType _type)
Protected Member Functions inherited from OpenZWave::Internal::VC::Value
virtual ~Value ()
bool IsCheckingChange () const
void SetCheckingChange (bool _check)
bool IsTargetValueSet () const
void OnValueRefreshed ()
void OnValueChanged ()
int VerifyRefreshedValue (void *_originalValue, void *_checkValue, void *_newValue, void *_targetValue, ValueID::ValueType _type, int _originalValueLength=0, int _checkValueLength=0, int _newValueLength=0, int _targetValueLength=0)
int CheckTargetValue (void *_newValue, void *_targetValue, ValueID::ValueType _type, int _newValueLength, int _targetValueLength)
Protected Member Functions inherited from OpenZWave::Internal::Platform::Ref
virtual ~Ref ()
Protected Attributes inherited from OpenZWave::Internal::VC::Value
int32 m_min
int32 m_max
time_t m_refreshTime
bool m_verifyChanges
bool m_refreshAfterSet
ValueID m_id
bool m_targetValueSet
uint32 m_duration

Detailed Description

BitSet value sent to/received from a node.

Constructor & Destructor Documentation

◆ ValueBitSet() [1/2]

OpenZWave::Internal::VC::ValueBitSet::ValueBitSet ( uint32 const _homeId,
uint8 const _nodeId,
ValueID::ValueGenre const _genre,
uint8 const _commandClassId,
uint8 const _instance,
uint16 const _index,
string const & _label,
string const & _units,
bool const _readOnly,
bool const _writeOnly,
uint32 const _value,
uint8 const _pollIntensity )

◆ ValueBitSet() [2/2]

OpenZWave::Internal::VC::ValueBitSet::ValueBitSet ( )
inline

◆ ~ValueBitSet()

virtual OpenZWave::Internal::VC::ValueBitSet::~ValueBitSet ( )
inlinevirtual

Member Function Documentation

◆ ClearBit()

bool OpenZWave::Internal::VC::ValueBitSet::ClearBit ( uint8 const _idx)

◆ GetAsBinaryString()

std::string const OpenZWave::Internal::VC::ValueBitSet::GetAsBinaryString ( ) const
virtual

◆ GetAsString()

std::string const OpenZWave::Internal::VC::ValueBitSet::GetAsString ( ) const
virtual

Reimplemented from OpenZWave::Internal::VC::Value.

◆ GetBit()

bool OpenZWave::Internal::VC::ValueBitSet::GetBit ( uint8 _idx) const

◆ GetBitHelp()

std::string OpenZWave::Internal::VC::ValueBitSet::GetBitHelp ( uint8 _idx)

◆ GetBitLabel()

std::string OpenZWave::Internal::VC::ValueBitSet::GetBitLabel ( uint8 _idx)

◆ GetBitMask()

uint32 OpenZWave::Internal::VC::ValueBitSet::GetBitMask ( ) const

◆ GetSize()

uint8 OpenZWave::Internal::VC::ValueBitSet::GetSize ( ) const

◆ GetValue()

uint32 OpenZWave::Internal::VC::ValueBitSet::GetValue ( ) const

◆ OnValueRefreshed()

void OpenZWave::Internal::VC::ValueBitSet::OnValueRefreshed ( uint32 const _value)

◆ ReadXML()

void OpenZWave::Internal::VC::ValueBitSet::ReadXML ( uint32 const _homeId,
uint8 const _nodeId,
uint8 const _commandClassId,
TiXmlElement const * _valueElement )
virtual

Reimplemented from OpenZWave::Internal::VC::Value.

◆ Set()

bool OpenZWave::Internal::VC::ValueBitSet::Set ( uint32 const _value)

◆ SetBit()

bool OpenZWave::Internal::VC::ValueBitSet::SetBit ( uint8 const _idx)

◆ SetBitHelp()

bool OpenZWave::Internal::VC::ValueBitSet::SetBitHelp ( uint8 _idx,
string help )

◆ SetBitLabel()

bool OpenZWave::Internal::VC::ValueBitSet::SetBitLabel ( uint8 _idx,
string label )

◆ SetBitMask()

bool OpenZWave::Internal::VC::ValueBitSet::SetBitMask ( uint32 _bitMask)

◆ SetFromString()

bool OpenZWave::Internal::VC::ValueBitSet::SetFromString ( string const & _value)
virtual

Reimplemented from OpenZWave::Internal::VC::Value.

◆ SetSize()

void OpenZWave::Internal::VC::ValueBitSet::SetSize ( uint8 size)

◆ SetTargetValue()

void OpenZWave::Internal::VC::ValueBitSet::SetTargetValue ( uint32 const _target,
uint32 _duration = 0 )

◆ WriteXML()

void OpenZWave::Internal::VC::ValueBitSet::WriteXML ( TiXmlElement * _valueElement)
virtual

Reimplemented from OpenZWave::Internal::VC::Value.

The documentation for this class was generated from the following files:
Generated on for OpenZWave Library by doxygen 1.15.0