OpenZWave Library: SerialController.h Source File

| OpenZWave Library 1.6.0

Loading...
Searching...
No Matches
SerialController.h
Go to the documentation of this file.
1//-----------------------------------------------------------------------------
2//
3// SerialController.h
4//
5// Cross-platform serial port handler
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 _SerialController_H
29#define _SerialController_H
30
31#include <string>
32#include "Defs.h"
33#include "platform/Controller.h"
34
35namespace OpenZWave
36{
37 class Driver;
38 class Msg;
39 class SerialControllerImpl;
40
44 class SerialController: public Controller
45 {
46 friend class SerialControllerImpl;
47
48 public:
49 enum Parity
50 {
51 Parity_None = 0,
52 Parity_Odd,
53 Parity_Even,
54 Parity_Mark,
55 Parity_Space
56 };
57
58 enum StopBits
59 {
60 StopBits_One = 0,
61 StopBits_OneAndAHalf = 1,
62 StopBits_Two = 2
63 };
64
69 SerialController();
70
75 virtual ~SerialController();
76
83 bool SetBaud( uint32 const _baud );
84
91 bool SetParity( Parity const _parity );
92
99 bool SetStopBits( StopBits const _stopBits );
100
108 bool Open( string const& _SerialControllerName );
109
116 bool Close();
117
126 uint32 Write( uint8* _buffer, uint32 _length );
127
128 private:
129 uint32 m_baud;
130 SerialController::Parity m_parity;
131 SerialController::StopBits m_stopBits;
132 string m_serialControllerName;
133
134 SerialControllerImpl* m_pImpl; // Pointer to an object that encapsulates the platform-specific implementation of the serial port.
135 bool m_bOpen;
136 };
137
138} // namespace OpenZWave
139
140#endif //_SerialController_H
141
Controller.h
Defs.h
uint32
unsigned int uint32
Definition Defs.h:95
uint8
unsigned char uint8
Definition Defs.h:89
OpenZWave::Controller
Represents a USB Controller.
Definition Controller.h:56
OpenZWave::SerialController
Interface for controllers that implement a Serial Interface (USB Serial Port Emulation)
Definition SerialController.h:45
OpenZWave::SerialController::Write
uint32 Write(uint8 *_buffer, uint32 _length)
Definition SerialController.cpp:170
OpenZWave::SerialController::Close
bool Close()
Definition SerialController.cpp:152
OpenZWave::SerialController::SetBaud
bool SetBaud(uint32 const _baud)
Definition SerialController.cpp:77
OpenZWave::SerialController::Parity
Parity
Definition SerialController.h:50
OpenZWave::SerialController::Parity_Even
@ Parity_Even
Definition SerialController.h:53
OpenZWave::SerialController::Parity_Odd
@ Parity_Odd
Definition SerialController.h:52
OpenZWave::SerialController::Parity_Mark
@ Parity_Mark
Definition SerialController.h:54
OpenZWave::SerialController::Parity_Space
@ Parity_Space
Definition SerialController.h:55
OpenZWave::SerialController::Parity_None
@ Parity_None
Definition SerialController.h:51
OpenZWave::SerialController::~SerialController
virtual ~SerialController()
Definition SerialController.cpp:65
OpenZWave::SerialController::SerialControllerImpl
friend class SerialControllerImpl
Definition SerialController.h:46
OpenZWave::SerialController::StopBits
StopBits
Definition SerialController.h:59
OpenZWave::SerialController::StopBits_OneAndAHalf
@ StopBits_OneAndAHalf
Definition SerialController.h:61
OpenZWave::SerialController::StopBits_One
@ StopBits_One
Definition SerialController.h:60
OpenZWave::SerialController::StopBits_Two
@ StopBits_Two
Definition SerialController.h:62
OpenZWave::SerialController::SetStopBits
bool SetStopBits(StopBits const _stopBits)
Definition SerialController.cpp:115
OpenZWave::SerialController::SetParity
bool SetParity(Parity const _parity)
Definition SerialController.cpp:96
OpenZWave::SerialController::Open
bool Open(string const &_SerialControllerName)
Definition SerialController.cpp:133
OpenZWave::SerialController::SerialController
SerialController()
Definition SerialController.cpp:50
OpenZWave
Definition Bitfield.h:35