OpenZWave Library
1.6.1768
src
platform
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
37
namespace
OpenZWave
38
{
39
namespace
Internal
40
{
41
namespace
Platform
42
{
43
58
class
Controller
:
public
Stream
59
{
60
61
public
:
66
Controller
() :
67
Stream
(2048)
68
{
69
}
70
75
virtual
~Controller
()
76
{
77
}
78
85
virtual
bool
Open
(
string
const
& _controllerName) = 0;
86
93
virtual
bool
Close
() = 0;
94
103
virtual
uint32
Write
(
uint8
* _buffer,
uint32
_length) = 0;
104
113
uint32
Read
(
uint8
* _buffer,
uint32
_length);
114
};
115
}
// namespace Platform
116
}
// namespace Internal
117
}
// namespace OpenZWave
118
119
#endif //_Controller_H
120
OpenZWave
Definition:
Bitfield.cpp:30
Stream.h
OpenZWave::Internal::Platform::Controller::Open
virtual bool Open(string const &_controllerName)=0
OpenZWave::Internal::Platform::Controller::~Controller
virtual ~Controller()
Definition:
Controller.h:75
OpenZWave::Internal::Platform::Stream
Platform-independent definition of a circular buffer.
Definition:
Stream.h:47
Defs.h
Driver.h
OpenZWave::Internal::Platform::Controller::Close
virtual bool Close()=0
uint32
unsigned int uint32
Definition:
Defs.h:91
OpenZWave::Internal::Platform::Controller
Represents a USB ControllerController is derived from Stream rather than containing one,...
Definition:
Controller.h:58
OpenZWave::Internal::Platform::Controller::Read
uint32 Read(uint8 *_buffer, uint32 _length)
Definition:
Controller.cpp:42
OpenZWave::Internal::Platform::Controller::Controller
Controller()
Definition:
Controller.h:66
OpenZWave::Internal::Platform::Controller::Write
virtual uint32 Write(uint8 *_buffer, uint32 _length)=0
uint8
unsigned char uint8
Definition:
Defs.h:85
Generated on Tue Jan 19 2021 04:21:09 for OpenZWave Library by
1.8.15