OpenZWave Library: Controller.h Source File

| OpenZWave Library 1.6.0

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
55 class Controller: public Stream
56 {
57
58 public:
63 Controller():Stream( 2048 ){}
64
69 virtual ~Controller(){}
70
76 void PlayInitSequence( Driver* _driver );
77
84 virtual bool Open( string const& _controllerName ) = 0;
85
92 virtual bool Close() = 0;
93
102 virtual uint32 Write( uint8* _buffer, uint32 _length ) = 0;
103
112 uint32 Read( uint8* _buffer, uint32 _length );
113 };
114
115} // namespace OpenZWave
116
117#endif //_Controller_H
118
Defs.h
uint32
unsigned int uint32
Definition: Defs.h:95
uint8
unsigned char uint8
Definition: Defs.h:89
Driver.h
Stream.h
OpenZWave::Controller
Represents a USB Controller.
Definition: Controller.h:56
OpenZWave::Controller::Close
virtual bool Close()=0
OpenZWave::Controller::Open
virtual bool Open(string const &_controllerName)=0
OpenZWave::Controller::PlayInitSequence
void PlayInitSequence(Driver *_driver)
Definition: Controller.cpp:38
OpenZWave::Controller::Read
uint32 Read(uint8 *_buffer, uint32 _length)
Definition: Controller.cpp:55
OpenZWave::Controller::Controller
Controller()
Definition: Controller.h:63
OpenZWave::Controller::~Controller
virtual ~Controller()
Definition: Controller.h:69
OpenZWave::Controller::Write
virtual uint32 Write(uint8 *_buffer, uint32 _length)=0
OpenZWave::Driver
The Driver class handles communication between OpenZWave and a device attached via a serial port (typ...
Definition: Driver.h:65
OpenZWave::Stream
Platform-independent definition of a circular buffer.
Definition: Stream.h:44
OpenZWave
Definition: Bitfield.h:35