OpenZWave Library 1.2
Controller.h
Go to the documentation of this file.
1//-----------------------------------------------------------------------------
2//
3// Controller.h
4//
5// Cross-platform, hardware-abstracted controller data interface
6//
7// Copyright (c) 2010 Jason Frazier <frazierjason@gmail.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 _Controller_H
29#define _Controller_H
30
31#include <string>
32#include <list>
33#include "Defs.h"
34#include "Driver.h"
35#include "platform/Stream.h"
36
37namespace OpenZWave
38{
39 class Driver;
40
41 class Controller: public Stream
42 {
43 // Controller is derived from Stream rather than containing one, so that
44 // we can use its Wait abilities without having to duplicate them here.
45 // The stream is used for input. Buffering of output is handled by the OS.
46
47 public:
52 Controller():Stream( 2048 ){}
53
58 virtual ~Controller(){}
59
65 void PlayInitSequence( Driver* _driver );
66
73 virtual bool Open( string const& _controllerName ) = 0;
74
81 virtual bool Close() = 0;
82
91 virtual uint32 Write( uint8* _buffer, uint32 _length ) = 0;
92
101 uint32 Read( uint8* _buffer, uint32 _length );
102 };
103
104} // namespace OpenZWave
105
106#endif //_Controller_H
107
unsigned int uint32
Definition: Defs.h:69
unsigned char uint8
Definition: Defs.h:63
Definition: Controller.h:42
virtual bool Close()=0
virtual bool Open(string const &_controllerName)=0
void PlayInitSequence(Driver *_driver)
Definition: Controller.cpp:38
uint32 Read(uint8 *_buffer, uint32 _length)
Definition: Controller.cpp:55
Controller()
Definition: Controller.h:52
virtual ~Controller()
Definition: Controller.h:58
virtual uint32 Write(uint8 *_buffer, uint32 _length)=0
The Driver class handles communication between OpenZWave and a device attached via a serial port (typ...
Definition: Driver.h:57
Platform-independent definition of a circular buffer.
Definition: Stream.h:43
Definition: Bitfield.h:35