OpenZWave Library: NoOperation.h Source File

| OpenZWave Library 1.6.0

NoOperation.h
Go to the documentation of this file.
1 //-----------------------------------------------------------------------------
2 //
3 // NoOperation.h
4 //
5 // Implementation of the Z-Wave COMMAND_CLASS_NO_OPERATION
6 //
7 // Copyright (c) 2012 Greg Satz <satz@iranger.com>
8 //
9 // SOFTWARE NOTICE AND LICENSE
10 //
11 // This file is part of OpenZWave.
12 //
13 // OpenZWave is free software: you can redistribute it and/or modify
14 // it under the terms of the GNU Lesser General Public License as published
15 // by the Free Software Foundation, either version 3 of the License,
16 // or (at your option) any later version.
17 //
18 // OpenZWave is distributed in the hope that it will be useful,
19 // but WITHOUT ANY WARRANTY; without even the implied warranty of
20 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 // GNU Lesser General Public License for more details.
22 //
23 // You should have received a copy of the GNU Lesser General Public License
24 // along with OpenZWave. If not, see <http://www.gnu.org/licenses/>.
25 //
26 //-----------------------------------------------------------------------------
27
28 #ifndef _NoOperation_H
29 #define _NoOperation_H
30
31 #include "command_classes/CommandClass.h"
32
33 namespace OpenZWave
34 {
38 class NoOperation: public CommandClass
39 {
40 public:
41 static CommandClass* Create( uint32 const _homeId, uint8 const _nodeId ){ return new NoOperation( _homeId, _nodeId ); }
42 virtual ~NoOperation(){}
43
44 static uint8 const StaticGetCommandClassId(){ return 0x00; }
45 static string const StaticGetCommandClassName(){ return "COMMAND_CLASS_NO_OPERATION"; }
46
47 void Set( bool const _route, Driver::MsgQueue const _queue = Driver::MsgQueue_NoOp );
48
49 // From CommandClass
50 virtual uint8 const GetCommandClassId()const{ return StaticGetCommandClassId(); }
51 virtual string const GetCommandClassName()const{ return StaticGetCommandClassName(); }
52 virtual bool HandleMsg( uint8 const* _data, uint32 const _length, uint32 const _instance = 1 );
53
54 private:
55 NoOperation( uint32 const _homeId, uint8 const _nodeId ): CommandClass( _homeId, _nodeId ){}
56 };
57
58 } // namespace OpenZWave
59
60 #endif
61
OpenZWave::NoOperation
Implements COMMAND_CLASS_NO_OPERATION (0x00), a Z-Wave device command class.
Definition: NoOperation.h:38
OpenZWave
Definition: Bitfield.h:34
OpenZWave::Driver::MsgQueue
MsgQueue
Definition: Driver.h:591
OpenZWave::NoOperation::Set
void Set(bool const _route, Driver::MsgQueue const _queue=Driver::MsgQueue_NoOp)
Definition: NoOperation.cpp:59
OpenZWave::NoOperation::HandleMsg
virtual bool HandleMsg(uint8 const *_data, uint32 const _length, uint32 const _instance=1)
Definition: NoOperation.cpp:43
CommandClass.h
OpenZWave::Driver::MsgQueue_NoOp
Definition: Driver.h:594
OpenZWave::NoOperation::StaticGetCommandClassId
static uint8 const StaticGetCommandClassId()
Definition: NoOperation.h:44
OpenZWave::NoOperation::~NoOperation
virtual ~NoOperation()
Definition: NoOperation.h:42
OpenZWave::NoOperation::Create
static CommandClass * Create(uint32 const _homeId, uint8 const _nodeId)
Definition: NoOperation.h:41
OpenZWave::NoOperation::StaticGetCommandClassName
static string const StaticGetCommandClassName()
Definition: NoOperation.h:45
OpenZWave::CommandClass
Base class for all Z-Wave command classes.
Definition: CommandClass.h:55
OpenZWave::NoOperation::GetCommandClassId
virtual uint8 const GetCommandClassId() const
Definition: NoOperation.h:50
uint32
unsigned int uint32
Definition: Defs.h:95
OpenZWave::NoOperation::GetCommandClassName
virtual string const GetCommandClassName() const
Definition: NoOperation.h:51
uint8
unsigned char uint8
Definition: Defs.h:89