OpenZWave Library  1.5.0
NodeNaming.h
Go to the documentation of this file.
1 //-----------------------------------------------------------------------------
2 //
3 // NodeNaming.h
4 //
5 // Implementation of the Z-Wave COMMAND_CLASS_NODE_NAMING
6 //
7 // Copyright (c) 2010 Mal Lansell <openzwave@lansell.org>
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 _NodeNaming_H
29 #define _NodeNaming_H
30 
32 
33 namespace OpenZWave
34 {
35 
41  string ExtractString( uint8 const* _data, uint32 const _length );
42 
48  uint32 ConvertUFT16ToUTF8( uint16 _utf16, char* _buffer, uint32 pos );
49 
50 
54  class NodeNaming: public CommandClass
55  {
56  public:
57  static CommandClass* Create( uint32 const _homeId, uint8 const _nodeId ){ return new NodeNaming( _homeId, _nodeId ); }
58  virtual ~NodeNaming(){}
59 
60  static uint8 const StaticGetCommandClassId(){ return 0x77; }
61  static string const StaticGetCommandClassName(){ return "COMMAND_CLASS_NODE_NAMING"; }
62 
63  // From CommandClass
64  virtual bool RequestState( uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue );
65  virtual bool RequestValue( uint32 const _requestFlags, uint16 const _index, uint8 const _instance, Driver::MsgQueue const _queue );
66  virtual uint8 const GetCommandClassId()const{ return StaticGetCommandClassId(); }
67  virtual string const GetCommandClassName()const{ return StaticGetCommandClassName(); }
68  virtual bool HandleMsg( uint8 const* _data, uint32 const _length, uint32 const _instance = 1 );
69 
70  void SetName( string const& _name );
71  void SetLocation( string const& _location );
72 
73  private:
74  NodeNaming( uint32 const _homeId, uint8 const _nodeId ): CommandClass( _homeId, _nodeId ){}
75  };
76 
77 } // namespace OpenZWave
78 
79 #endif
80 
Definition: Bitfield.h:34
MsgQueue
Definition: Driver.h:575
virtual ~NodeNaming()
Definition: NodeNaming.h:58
unsigned short uint16
Definition: Defs.h:93
void SetLocation(string const &_location)
Definition: NodeNaming.cpp:367
uint32 ConvertUFT16ToUTF8(uint16 _utf16, char *_buffer, uint32 pos)
Convert from UTF16 to UTF8this function is used by the NodeNaming CC as well as the Alarm CC...
Definition: NodeNaming.cpp:475
virtual string const GetCommandClassName() const
Definition: NodeNaming.h:67
Base class for all Z-Wave command classes.
Definition: CommandClass.h:54
CommandClass(uint32 const _homeId, uint8 const _nodeId)
Definition: CommandClass.cpp:55
virtual bool RequestState(uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue)
Definition: NodeNaming.cpp:202
static uint8 const StaticGetCommandClassId()
Definition: NodeNaming.h:60
string ExtractString(uint8 const *_data, uint32 const _length)
Extract a String from a Z-Wave Encoded Packetthis function is used by the NodeNaming CC as well as th...
Definition: NodeNaming.cpp:399
virtual bool RequestValue(uint32 const _requestFlags, uint16 const _index, uint8 const _instance, Driver::MsgQueue const _queue)
Definition: NodeNaming.cpp:235
static CommandClass * Create(uint32 const _homeId, uint8 const _nodeId)
Definition: NodeNaming.h:57
unsigned int uint32
Definition: Defs.h:96
void SetName(string const &_name)
Definition: NodeNaming.cpp:335
virtual bool HandleMsg(uint8 const *_data, uint32 const _length, uint32 const _instance=1)
Definition: NodeNaming.cpp:287
virtual uint8 const GetCommandClassId() const
Definition: NodeNaming.h:66
static string const StaticGetCommandClassName()
Definition: NodeNaming.h:61
Implements COMMAND_CLASS_NODE_NAMING (0x77), a Z-Wave device command class.
Definition: NodeNaming.h:54
unsigned char uint8
Definition: Defs.h:90