|  | OpenZWave Library 1.6.0
    | 
Base class for all Z-Wave command classes. More...
#include <CommandClass.h>
 Inheritance diagram for OpenZWave::CommandClass:
 Inheritance diagram for OpenZWave::CommandClass:| Classes | |
| struct | RefreshValue | 
| Public Types | |
| enum | { RequestFlag_Static = 0x00000001 , RequestFlag_Session = 0x00000002 , RequestFlag_Dynamic = 0x00000004 , RequestFlag_AfterMark = 0x00000008 } | 
| enum | StaticRequest { StaticRequest_Instances = 0x01 , StaticRequest_Values = 0x02 , StaticRequest_Version = 0x04 } | 
| typedef struct OpenZWave::CommandClass::RefreshValue | RefreshValue | 
| Public Member Functions | |
| CommandClass (uint32 const _homeId, uint8 const _nodeId) | |
| virtual | ~CommandClass () | 
| virtual void | ReadXML (TiXmlElement const *_ccElement) | 
| virtual void | WriteXML (TiXmlElement *_ccElement) | 
| virtual bool | RequestState (uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue) | 
| virtual bool | RequestValue (uint32 const _requestFlags, uint16 const _index, uint8 const _instance, Driver::MsgQueue const _queue) | 
| virtual void | refreshValuesOnWakeup () | 
| virtual uint8 const | GetCommandClassId () const =0 | 
| virtual string const | GetCommandClassName () const =0 | 
| string const | GetCommandClassLabel () | 
| void | SetCommandClassLabel (string label) | 
| virtual bool | HandleMsg (uint8 const *_data, uint32 const _length, uint32 const _instance=1)=0 | 
| virtual bool | HandleIncomingMsg (uint8 const *_data, uint32 const _length, uint32 const _instance=1) | 
| virtual bool | SetValue (Value const &_value) | 
| virtual void | SetValueBasic (uint8 const _instance, uint8 const _level) | 
| virtual void | SetVersion (uint8 const _version) | 
| bool | RequestStateForAllInstances (uint32 const _requestFlags, Driver::MsgQueue const _queue) | 
| bool | CheckForRefreshValues (Value const *_value) | 
| virtual uint8 | GetMaxVersion () | 
| uint8 | GetVersion () const | 
| Bitfield const * | GetInstances () const | 
| uint32 | GetHomeId () const | 
| uint8 | GetNodeId () const | 
| Driver * | GetDriver () const | 
| Node * | GetNodeUnsafe () const | 
| Value * | GetValue (uint8 const _instance, uint16 const _index) | 
| bool | RemoveValue (uint8 const _instance, uint16 const _index) | 
| uint8 | GetEndPoint (uint8 const _instance) | 
| uint8 | GetInstance (uint8 const _endPoint) | 
| void | SetInstances (uint8 const _instances) | 
| void | SetInstance (uint8 const _endPoint) | 
| virtual void | SetInstanceLabel (uint8 const _instance, char *label) | 
| string | GetInstanceLabel (uint8 const _instance) | 
| uint8 | GetNumInstances () | 
| void | SetAfterMark () | 
| void | SetEndPoint (uint8 const _instance, uint8 const _endpoint) | 
| bool | IsAfterMark () const | 
| bool | IsSecured () const | 
| void | SetSecured () | 
| bool | IsSecureSupported () const | 
| void | ClearSecureSupport () | 
| void | SetSecureSupport () | 
| void | SetInNIF () | 
| bool | IsInNIF () | 
| string | ExtractValue (uint8 const *_data, uint8 *_scale, uint8 *_precision, uint8 _valueOffset=1) const | 
| void | AppendValue (Msg *_msg, string const &_value, uint8 const _scale) const | 
| uint8 const | GetAppendValueSize (string const &_value) const | 
| int32 | ValueToInteger (string const &_value, uint8 *o_precision, uint8 *o_size) const | 
| void | UpdateMappedClass (uint8 const _instance, uint8 const _classId, uint8 const _value) | 
| virtual void | CreateVars (uint8 const _instance, uint8 const _index) | 
| bool | HasStaticRequest (uint8_t _request) const | 
| void | SetStaticRequest (uint8_t _request) | 
| void | ClearStaticRequest (uint8_t _request) | 
| uint32 | GetSentCnt () const | 
| uint32 | GetReceivedCnt () const | 
| void | SentCntIncr () | 
| void | ReceivedCntIncr () | 
| Protected Member Functions | |
| virtual void | CreateVars (uint8 const _instance) | 
| void | ReadValueRefreshXML (TiXmlElement const *_ccElement) | 
| Protected Attributes | |
| CompatOptionManager | m_com | 
| CompatOptionManager | m_dom | 
Base class for all Z-Wave command classes.
| typedef struct OpenZWave::CommandClass::RefreshValue OpenZWave::CommandClass::RefreshValue | 
| anonymous enum | 
| 
 | virtual | 
Append a floating-point value to a message.
| _msg | The message to which the value should be appended. | 
| _value | A string containing a decimal number to be appended. | 
| _scale | A byte indicating the scale corresponding to this value (e.g., 1=F and 0=C for temperatures). | 
| bool CommandClass::CheckForRefreshValues | ( | Value const * | _value | ) | 
| 
 | inline | 
| void CommandClass::ClearStaticRequest | ( | uint8_t | _request | ) | 
| 
 | inlineprotectedvirtual | 
Reimplemented in OpenZWave::AssociationCommandConfiguration, OpenZWave::BarrierOperator, OpenZWave::Basic, OpenZWave::BasicWindowCovering, OpenZWave::Battery, OpenZWave::CentralScene, OpenZWave::ClimateControlSchedule, OpenZWave::Clock, OpenZWave::Color, OpenZWave::ControllerReplication, OpenZWave::DoorLock, OpenZWave::DoorLockLogging, OpenZWave::EnergyProduction, OpenZWave::Indicator, OpenZWave::Language, OpenZWave::Lock, OpenZWave::ManufacturerSpecific, OpenZWave::Meter, OpenZWave::MeterPulse, OpenZWave::Powerlevel, OpenZWave::Protection, OpenZWave::SceneActivation, OpenZWave::Security, OpenZWave::SensorBinary, OpenZWave::SensorMultilevel, OpenZWave::SimpleAV, OpenZWave::SoundSwitch, OpenZWave::SwitchAll, OpenZWave::SwitchBinary, OpenZWave::SwitchMultilevel, OpenZWave::SwitchToggleBinary, OpenZWave::SwitchToggleMultilevel, OpenZWave::ThermostatFanMode, OpenZWave::ThermostatFanState, OpenZWave::ThermostatMode, OpenZWave::ThermostatOperatingState, OpenZWave::TimeParameters, OpenZWave::UserCode, OpenZWave::Version, OpenZWave::WakeUp, and OpenZWave::ZWavePlusInfo.
| 
 | inlinevirtual | 
Reimplemented in OpenZWave::ThermostatSetpoint.
| string CommandClass::ExtractValue | ( | uint8 const * | _data, | 
| uint8 * | _scale, | ||
| uint8 * | _precision, | ||
| uint8 | _valueOffset = 1 ) const | 
| uint8 const CommandClass::GetAppendValueSize | ( | string const & | _value | ) | const | 
| 
 | pure virtual | 
Implemented in OpenZWave::Alarm, OpenZWave::ApplicationStatus, OpenZWave::Association, OpenZWave::AssociationCommandConfiguration, OpenZWave::BarrierOperator, OpenZWave::Basic, OpenZWave::BasicWindowCovering, OpenZWave::Battery, OpenZWave::CentralScene, OpenZWave::ClimateControlSchedule, OpenZWave::Clock, OpenZWave::Color, OpenZWave::Configuration, OpenZWave::ControllerReplication, OpenZWave::CRC16Encap, OpenZWave::DeviceResetLocally, OpenZWave::DoorLock, OpenZWave::DoorLockLogging, OpenZWave::EnergyProduction, OpenZWave::Hail, OpenZWave::Indicator, OpenZWave::Language, OpenZWave::Lock, OpenZWave::ManufacturerProprietary, OpenZWave::ManufacturerSpecific, OpenZWave::Meter, OpenZWave::MeterPulse, OpenZWave::MultiChannelAssociation, OpenZWave::MultiCmd, OpenZWave::MultiInstance, OpenZWave::NodeNaming, OpenZWave::NoOperation, OpenZWave::Powerlevel, OpenZWave::Proprietary, OpenZWave::Protection, OpenZWave::SceneActivation, OpenZWave::Security, OpenZWave::SensorAlarm, OpenZWave::SensorBinary, OpenZWave::SensorMultilevel, OpenZWave::SimpleAV, OpenZWave::SoundSwitch, OpenZWave::SwitchAll, OpenZWave::SwitchBinary, OpenZWave::SwitchMultilevel, OpenZWave::SwitchToggleBinary, OpenZWave::SwitchToggleMultilevel, OpenZWave::ThermostatFanMode, OpenZWave::ThermostatFanState, OpenZWave::ThermostatMode, OpenZWave::ThermostatOperatingState, OpenZWave::ThermostatSetpoint, OpenZWave::TimeParameters, OpenZWave::UserCode, OpenZWave::Version, OpenZWave::WakeUp, and OpenZWave::ZWavePlusInfo.
| string const CommandClass::GetCommandClassLabel | ( | ) | 
| 
 | pure virtual | 
Implemented in OpenZWave::Alarm, OpenZWave::ApplicationStatus, OpenZWave::Association, OpenZWave::AssociationCommandConfiguration, OpenZWave::BarrierOperator, OpenZWave::Basic, OpenZWave::BasicWindowCovering, OpenZWave::Battery, OpenZWave::CentralScene, OpenZWave::ClimateControlSchedule, OpenZWave::Clock, OpenZWave::Color, OpenZWave::Configuration, OpenZWave::ControllerReplication, OpenZWave::CRC16Encap, OpenZWave::DeviceResetLocally, OpenZWave::DoorLock, OpenZWave::DoorLockLogging, OpenZWave::EnergyProduction, OpenZWave::Hail, OpenZWave::Indicator, OpenZWave::Language, OpenZWave::Lock, OpenZWave::ManufacturerProprietary, OpenZWave::ManufacturerSpecific, OpenZWave::Meter, OpenZWave::MeterPulse, OpenZWave::MultiChannelAssociation, OpenZWave::MultiCmd, OpenZWave::MultiInstance, OpenZWave::NodeNaming, OpenZWave::NoOperation, OpenZWave::Powerlevel, OpenZWave::Proprietary, OpenZWave::Protection, OpenZWave::SceneActivation, OpenZWave::Security, OpenZWave::SensorAlarm, OpenZWave::SensorBinary, OpenZWave::SensorMultilevel, OpenZWave::SimpleAV, OpenZWave::SoundSwitch, OpenZWave::SwitchAll, OpenZWave::SwitchBinary, OpenZWave::SwitchMultilevel, OpenZWave::SwitchToggleBinary, OpenZWave::SwitchToggleMultilevel, OpenZWave::ThermostatFanMode, OpenZWave::ThermostatFanState, OpenZWave::ThermostatMode, OpenZWave::ThermostatOperatingState, OpenZWave::ThermostatSetpoint, OpenZWave::TimeParameters, OpenZWave::UserCode, OpenZWave::Version, OpenZWave::WakeUp, and OpenZWave::ZWavePlusInfo.
| Driver * CommandClass::GetDriver | ( | ) | const | 
| 
 | inline | 
| string CommandClass::GetInstanceLabel | ( | uint8 const | _instance | ) | 
| 
 | inline | 
| 
 | inlinevirtual | 
Reimplemented in OpenZWave::Alarm, OpenZWave::BarrierOperator, OpenZWave::CentralScene, OpenZWave::Color, OpenZWave::ManufacturerSpecific, OpenZWave::Meter, OpenZWave::MultiInstance, OpenZWave::SensorMultilevel, OpenZWave::SwitchBinary, OpenZWave::SwitchMultilevel, OpenZWave::ThermostatMode, OpenZWave::ThermostatSetpoint, and OpenZWave::WakeUp.
| 
 | inline | 
| Node * CommandClass::GetNodeUnsafe | ( | ) | const | 
| 
 | inline | 
| 
 | inline | 
| 
 | inline | 
| 
 | inline | 
| 
 | inlinevirtual | 
Reimplemented in OpenZWave::MultiInstance, and OpenZWave::SwitchMultilevel.
| 
 | pure virtual | 
Implemented in OpenZWave::Alarm, OpenZWave::ApplicationStatus, OpenZWave::Association, OpenZWave::AssociationCommandConfiguration, OpenZWave::BarrierOperator, OpenZWave::Basic, OpenZWave::BasicWindowCovering, OpenZWave::Battery, OpenZWave::CentralScene, OpenZWave::ClimateControlSchedule, OpenZWave::Clock, OpenZWave::Color, OpenZWave::Configuration, OpenZWave::ControllerReplication, OpenZWave::CRC16Encap, OpenZWave::DeviceResetLocally, OpenZWave::DoorLock, OpenZWave::DoorLockLogging, OpenZWave::EnergyProduction, OpenZWave::Hail, OpenZWave::Indicator, OpenZWave::Language, OpenZWave::Lock, OpenZWave::ManufacturerProprietary, OpenZWave::ManufacturerSpecific, OpenZWave::Meter, OpenZWave::MeterPulse, OpenZWave::MultiChannelAssociation, OpenZWave::MultiCmd, OpenZWave::MultiInstance, OpenZWave::NodeNaming, OpenZWave::NoOperation, OpenZWave::Powerlevel, OpenZWave::Proprietary, OpenZWave::Protection, OpenZWave::SceneActivation, OpenZWave::Security, OpenZWave::SensorAlarm, OpenZWave::SensorBinary, OpenZWave::SensorMultilevel, OpenZWave::SimpleAV, OpenZWave::SoundSwitch, OpenZWave::SwitchAll, OpenZWave::SwitchBinary, OpenZWave::SwitchMultilevel, OpenZWave::SwitchToggleBinary, OpenZWave::SwitchToggleMultilevel, OpenZWave::ThermostatFanMode, OpenZWave::ThermostatFanState, OpenZWave::ThermostatMode, OpenZWave::ThermostatOperatingState, OpenZWave::ThermostatSetpoint, OpenZWave::TimeParameters, OpenZWave::UserCode, OpenZWave::Version, OpenZWave::WakeUp, and OpenZWave::ZWavePlusInfo.
| 
 | inline | 
| 
 | inline | 
| 
 | inline | 
| 
 | inline | 
| 
 | inline | 
| 
 | protected | 
| 
 | virtual | 
| 
 | inline | 
| 
 | virtual | 
| 
 | inlinevirtual | 
Reimplemented in OpenZWave::Alarm, OpenZWave::Association, OpenZWave::AssociationCommandConfiguration, OpenZWave::BarrierOperator, OpenZWave::Basic, OpenZWave::Battery, OpenZWave::CentralScene, OpenZWave::ClimateControlSchedule, OpenZWave::Clock, OpenZWave::Color, OpenZWave::DoorLock, OpenZWave::DoorLockLogging, OpenZWave::EnergyProduction, OpenZWave::Indicator, OpenZWave::Language, OpenZWave::Lock, OpenZWave::ManufacturerSpecific, OpenZWave::Meter, OpenZWave::MeterPulse, OpenZWave::MultiChannelAssociation, OpenZWave::NodeNaming, OpenZWave::Powerlevel, OpenZWave::Protection, OpenZWave::SensorAlarm, OpenZWave::SensorBinary, OpenZWave::SensorMultilevel, OpenZWave::SoundSwitch, OpenZWave::SwitchAll, OpenZWave::SwitchBinary, OpenZWave::SwitchMultilevel, OpenZWave::SwitchToggleBinary, OpenZWave::SwitchToggleMultilevel, OpenZWave::ThermostatFanMode, OpenZWave::ThermostatFanState, OpenZWave::ThermostatMode, OpenZWave::ThermostatOperatingState, OpenZWave::ThermostatSetpoint, OpenZWave::TimeParameters, OpenZWave::UserCode, OpenZWave::Version, OpenZWave::WakeUp, and OpenZWave::ZWavePlusInfo.
| bool CommandClass::RequestStateForAllInstances | ( | uint32 const | _requestFlags, | 
| Driver::MsgQueue const | _queue ) | 
| 
 | inlinevirtual | 
Reimplemented in OpenZWave::Alarm, OpenZWave::Association, OpenZWave::AssociationCommandConfiguration, OpenZWave::BarrierOperator, OpenZWave::Basic, OpenZWave::Battery, OpenZWave::CentralScene, OpenZWave::ClimateControlSchedule, OpenZWave::Clock, OpenZWave::Color, OpenZWave::Configuration, OpenZWave::DoorLock, OpenZWave::DoorLockLogging, OpenZWave::EnergyProduction, OpenZWave::Indicator, OpenZWave::Language, OpenZWave::Lock, OpenZWave::ManufacturerProprietary, OpenZWave::ManufacturerSpecific, OpenZWave::Meter, OpenZWave::MeterPulse, OpenZWave::MultiChannelAssociation, OpenZWave::NodeNaming, OpenZWave::Powerlevel, OpenZWave::Protection, OpenZWave::SensorAlarm, OpenZWave::SensorBinary, OpenZWave::SensorMultilevel, OpenZWave::SoundSwitch, OpenZWave::SwitchAll, OpenZWave::SwitchBinary, OpenZWave::SwitchMultilevel, OpenZWave::SwitchToggleBinary, OpenZWave::SwitchToggleMultilevel, OpenZWave::ThermostatFanMode, OpenZWave::ThermostatFanState, OpenZWave::ThermostatMode, OpenZWave::ThermostatOperatingState, OpenZWave::ThermostatSetpoint, OpenZWave::TimeParameters, OpenZWave::UserCode, OpenZWave::Version, OpenZWave::WakeUp, and OpenZWave::ZWavePlusInfo.
| 
 | inline | 
| 
 | inline | 
| void CommandClass::SetCommandClassLabel | ( | string | label | ) | 
| 
 | inline | 
| void CommandClass::SetInstance | ( | uint8 const | _endPoint | ) | 
| 
 | virtual | 
Reimplemented in OpenZWave::MultiInstance.
| void CommandClass::SetInstances | ( | uint8 const | _instances | ) | 
| 
 | inline | 
| 
 | inline | 
| void CommandClass::SetStaticRequest | ( | uint8_t | _request | ) | 
| 
 | inlinevirtual | 
Reimplemented in OpenZWave::Alarm, OpenZWave::BarrierOperator, OpenZWave::Basic, OpenZWave::BasicWindowCovering, OpenZWave::CentralScene, OpenZWave::ClimateControlSchedule, OpenZWave::Clock, OpenZWave::Color, OpenZWave::Configuration, OpenZWave::ControllerReplication, OpenZWave::DoorLock, OpenZWave::DoorLockLogging, OpenZWave::Indicator, OpenZWave::Lock, OpenZWave::ManufacturerProprietary, OpenZWave::Meter, OpenZWave::Powerlevel, OpenZWave::Protection, OpenZWave::SimpleAV, OpenZWave::SoundSwitch, OpenZWave::SwitchAll, OpenZWave::SwitchBinary, OpenZWave::SwitchMultilevel, OpenZWave::SwitchToggleBinary, OpenZWave::SwitchToggleMultilevel, OpenZWave::ThermostatFanMode, OpenZWave::ThermostatMode, OpenZWave::ThermostatSetpoint, OpenZWave::TimeParameters, OpenZWave::UserCode, and OpenZWave::WakeUp.
| 
 | inlinevirtual | 
Reimplemented in OpenZWave::Color, OpenZWave::DoorLock, OpenZWave::SensorBinary, OpenZWave::SwitchBinary, and OpenZWave::SwitchMultilevel.
| 
 | virtual | 
Reimplemented in OpenZWave::SwitchMultilevel, and OpenZWave::WakeUp.
| void CommandClass::UpdateMappedClass | ( | uint8 const | _instance, | 
| uint8 const | _classId, | ||
| uint8 const | _value ) | 
| int32 CommandClass::ValueToInteger | ( | string const & | _value, | 
| uint8 * | o_precision, | ||
| uint8 * | o_size ) const | 
| 
 | virtual | 
| 
 | protected | 
| 
 | protected |