This class implements Windows specific methods for 32-bit communication over a Serial Port(RS-232 connection). More...
#include <igstkSerialCommunicationForWindows.h>
Protected Types | |
| typedef HANDLE | HandleType |
| Macro with standard traits declarations. | |
Protected Member Functions | |
| SerialCommunicationForWindows () | |
| Constructor. | |
| ~SerialCommunicationForWindows () | |
| Destructor. | |
| virtual ResultType | InternalOpenPort (void) |
| Opens serial port for communication;. | |
| virtual ResultType | InternalUpdateParameters (void) |
| Sets up communication on the open port as per the communication parameters. | |
| virtual ResultType | InternalClosePort (void) |
| Closes serial port. | |
| virtual ResultType | InternalSendBreak (void) |
| Send a serial break. | |
| virtual void | InternalSleep (int milliseconds) |
| Sleep for the number of milliseconds specified. | |
| virtual ResultType | InternalPurgeBuffers (void) |
| Purge the input and output buffers. | |
| virtual ResultType | InternalWrite (const char *message, unsigned int numberOfBytes) |
| Write data. | |
| virtual ResultType | InternalRead (char *data, unsigned int numberOfBytes, unsigned int &bytesRead) |
| Read data. | |
| virtual ResultType | InternalSetRTS (unsigned int signal) |
| Set the RTS value 0 : Clear the RTS (request-to-send) signal 1 : Sends the RTS signal. | |
| virtual ResultType | InternalSetTimeout (unsigned int timeoutPeriod) |
| Set the timeout. | |
| virtual void | PrintSelf (std::ostream &os, itk::Indent indent) const |
| Print object information. | |
Detailed Description
This class implements Windows specific methods for 32-bit communication over a Serial Port(RS-232 connection).
"SerialCommunicationForWindows State Machine Diagram" "SerialCommunicationForWindows State Machine Diagram"
Definition at line 44 of file igstkSerialCommunicationForWindows.h.
Member Typedef Documentation
typedef HANDLE igstk::SerialCommunicationForWindows::HandleType [protected] |
Macro with standard traits declarations.
Return value type for interface functions Windows file handle type
Definition at line 49 of file igstkSerialCommunicationForWindows.h.
Constructor & Destructor Documentation
| igstk::SerialCommunicationForWindows::SerialCommunicationForWindows | ( | ) | [protected] |
Constructor.
| igstk::SerialCommunicationForWindows::~SerialCommunicationForWindows | ( | ) | [protected] |
Destructor.
Member Function Documentation
| virtual ResultType igstk::SerialCommunicationForWindows::InternalOpenPort | ( | void | ) | [protected, virtual] |
Opens serial port for communication;.
Reimplemented from igstk::SerialCommunication.
| virtual ResultType igstk::SerialCommunicationForWindows::InternalUpdateParameters | ( | void | ) | [protected, virtual] |
Sets up communication on the open port as per the communication parameters.
Reimplemented from igstk::SerialCommunication.
| virtual ResultType igstk::SerialCommunicationForWindows::InternalClosePort | ( | void | ) | [protected, virtual] |
Closes serial port.
Reimplemented from igstk::SerialCommunication.
| virtual ResultType igstk::SerialCommunicationForWindows::InternalSendBreak | ( | void | ) | [protected, virtual] |
Send a serial break.
Reimplemented from igstk::SerialCommunication.
| virtual void igstk::SerialCommunicationForWindows::InternalSleep | ( | int | milliseconds | ) | [protected, virtual] |
Sleep for the number of milliseconds specified.
| virtual ResultType igstk::SerialCommunicationForWindows::InternalPurgeBuffers | ( | void | ) | [protected, virtual] |
Purge the input and output buffers.
Reimplemented from igstk::SerialCommunication.
| virtual ResultType igstk::SerialCommunicationForWindows::InternalWrite | ( | const char * | message, |
| unsigned int | numberOfBytes | ||
| ) | [protected, virtual] |
Write data.
Reimplemented from igstk::SerialCommunication.
| virtual ResultType igstk::SerialCommunicationForWindows::InternalRead | ( | char * | data, |
| unsigned int | numberOfBytes, | ||
| unsigned int & | bytesRead | ||
| ) | [protected, virtual] |
Read data.
Reimplemented from igstk::SerialCommunication.
| virtual ResultType igstk::SerialCommunicationForWindows::InternalSetRTS | ( | unsigned int | signal | ) | [protected, virtual] |
Set the RTS value 0 : Clear the RTS (request-to-send) signal 1 : Sends the RTS signal.
Reimplemented from igstk::SerialCommunication.
| virtual ResultType igstk::SerialCommunicationForWindows::InternalSetTimeout | ( | unsigned int | timeoutPeriod | ) | [protected, virtual] |
Set the timeout.
| virtual void igstk::SerialCommunicationForWindows::PrintSelf | ( | std::ostream & | os, |
| itk::Indent | indent | ||
| ) | const [protected, virtual] |
Print object information.
Reimplemented from igstk::SerialCommunication.
The documentation for this class was generated from the following file:
- /tmp/buildd/igstk-4.4.0/Source/igstkSerialCommunicationForWindows.h
