OpenZWave Library: NodeNaming.h Source File

| OpenZWave Library 1.6.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
31 #include "command_classes/CommandClass.h"
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
uint32
unsigned int uint32
Definition: Defs.h:95
OpenZWave::NodeNaming::SetLocation
void SetLocation(string const &_location)
Definition: NodeNaming.cpp:367
OpenZWave::CommandClass
Base class for all Z-Wave command classes.
Definition: CommandClass.h:56
OpenZWave::NodeNaming::StaticGetCommandClassName
static string const StaticGetCommandClassName()
Definition: NodeNaming.h:61
uint8
unsigned char uint8
Definition: Defs.h:89
OpenZWave::ExtractString
string ExtractString(uint8 const *_data, uint32 const _length)
Extract a String from a Z-Wave Encoded Packet.
Definition: NodeNaming.cpp:399
OpenZWave::NodeNaming::StaticGetCommandClassId
static uint8 const StaticGetCommandClassId()
Definition: NodeNaming.h:60
OpenZWave::NodeNaming::RequestState
virtual bool RequestState(uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue)
Definition: NodeNaming.cpp:202
OpenZWave::NodeNaming::GetCommandClassId
virtual uint8 const GetCommandClassId() const
Definition: NodeNaming.h:66
CommandClass.h
OpenZWave::NodeNaming::RequestValue
virtual bool RequestValue(uint32 const _requestFlags, uint16 const _index, uint8 const _instance, Driver::MsgQueue const _queue)
Definition: NodeNaming.cpp:235
OpenZWave::NodeNaming
Implements COMMAND_CLASS_NODE_NAMING (0x77), a Z-Wave device command class.
Definition: NodeNaming.h:55
OpenZWave::NodeNaming::Create
static CommandClass * Create(uint32 const _homeId, uint8 const _nodeId)
Definition: NodeNaming.h:57
OpenZWave::NodeNaming::~NodeNaming
virtual ~NodeNaming()
Definition: NodeNaming.h:58
OpenZWave::NodeNaming::SetName
void SetName(string const &_name)
Definition: NodeNaming.cpp:335
OpenZWave::NodeNaming::HandleMsg
virtual bool HandleMsg(uint8 const *_data, uint32 const _length, uint32 const _instance=1)
Definition: NodeNaming.cpp:287
OpenZWave::Driver::MsgQueue
MsgQueue
Definition: Driver.h:592
uint16
unsigned short uint16
Definition: Defs.h:92
OpenZWave
Definition: Bitfield.h:35
OpenZWave::ConvertUFT16ToUTF8
uint32 ConvertUFT16ToUTF8(uint16 _utf16, char *_buffer, uint32 pos)
Convert from UTF16 to UTF8.
Definition: NodeNaming.cpp:475
OpenZWave::NodeNaming::GetCommandClassName
virtual string const GetCommandClassName() const
Definition: NodeNaming.h:67