igstk::SerialCommunicationForPosix Class Reference

This class implements Posix specific methods for 32-bit communication over a Serial Port(RS-232 connection). More...

#include <igstkSerialCommunicationForPosix.h>

Inheritance diagram for igstk::SerialCommunicationForPosix:
Inheritance graph
[legend]
Collaboration diagram for igstk::SerialCommunicationForPosix:
Collaboration graph
[legend]

List of all members.

Protected Member Functions

 SerialCommunicationForPosix ()
 Macro with standard traits declarations.
 ~SerialCommunicationForPosix ()
 Destructor.
virtual ResultType InternalOpenPort (void)
 Opens serial port for communication;.
virtual ResultType InternalUpdateParameters (void)
 Set 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 (unsigned int milliseconds)
 Sleep for the specified number of milliseconds.
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 (ready-to-send) value 0 : Clear the RTS (request-to-send) signal 1 : Sends the RTS signal.
virtual void PrintSelf (std::ostream &os, itk::Indent indent) const
 Print object information.

Detailed Description

This class implements Posix specific methods for 32-bit communication over a Serial Port(RS-232 connection).

igstkSerialCommunicationForPosix.png

"SerialCommunicationForPosix State Machine Diagram" "SerialCommunicationForPosix State Machine Diagram"

Definition at line 41 of file igstkSerialCommunicationForPosix.h.


Constructor & Destructor Documentation

igstk::SerialCommunicationForPosix::SerialCommunicationForPosix (  )  [protected]

Macro with standard traits declarations.

Return value type for interface functions Constructor

igstk::SerialCommunicationForPosix::~SerialCommunicationForPosix (  )  [protected]

Destructor.


Member Function Documentation

virtual ResultType igstk::SerialCommunicationForPosix::InternalOpenPort ( void   )  [protected, virtual]

Opens serial port for communication;.

Reimplemented from igstk::SerialCommunication.

virtual ResultType igstk::SerialCommunicationForPosix::InternalUpdateParameters ( void   )  [protected, virtual]

Set communication on the open port as per the communication parameters.

Reimplemented from igstk::SerialCommunication.

virtual ResultType igstk::SerialCommunicationForPosix::InternalClosePort ( void   )  [protected, virtual]

Closes serial port.

Reimplemented from igstk::SerialCommunication.

virtual ResultType igstk::SerialCommunicationForPosix::InternalSendBreak ( void   )  [protected, virtual]

Send a serial break.

Reimplemented from igstk::SerialCommunication.

virtual void igstk::SerialCommunicationForPosix::InternalSleep ( unsigned int  milliseconds  )  [protected, virtual]

Sleep for the specified number of milliseconds.

Reimplemented from igstk::SerialCommunication.

virtual ResultType igstk::SerialCommunicationForPosix::InternalPurgeBuffers ( void   )  [protected, virtual]

Purge the input and output buffers.

Reimplemented from igstk::SerialCommunication.

virtual ResultType igstk::SerialCommunicationForPosix::InternalWrite ( const char *  message,
unsigned int  numberOfBytes 
) [protected, virtual]

Write data.

Reimplemented from igstk::SerialCommunication.

virtual ResultType igstk::SerialCommunicationForPosix::InternalRead ( char *  data,
unsigned int  numberOfBytes,
unsigned int &  bytesRead 
) [protected, virtual]

Read data.

Reimplemented from igstk::SerialCommunication.

virtual ResultType igstk::SerialCommunicationForPosix::InternalSetRTS ( unsigned int  signal  )  [protected, virtual]

Set the RTS (ready-to-send) value 0 : Clear the RTS (request-to-send) signal 1 : Sends the RTS signal.

Reimplemented from igstk::SerialCommunication.

virtual void igstk::SerialCommunicationForPosix::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:

Generated by  doxygen 1.6.2