igstk::SerialCommunicationSimulator Class Reference

This class simulates serial communication via a file. More...

#include <igstkSerialCommunicationSimulator.h>

Inheritance diagram for igstk::SerialCommunicationSimulator:

Collaboration diagram for igstk::SerialCommunicationSimulator:

List of all members.

Public Member Functions
const char *	GetFileName () const
	Get the file name for the recorded data.
Protected Types
typedef SerialCommunication::ResultType	ResultType
Protected Member Functions
	SerialCommunicationSimulator ()
	Constructor.
	~SerialCommunicationSimulator ()
	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 (unsigned int milliseconds)
	Sleep for the amount of time specified in 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 void	PrintSelf (std::ostream &os, itk::Indent indent) const
	Print object information.

---

Detailed Description

This class simulates serial communication via a file.

Definition at line 39 of file igstkSerialCommunicationSimulator.h.

---

Member Typedef Documentation

typedef SerialCommunication::ResultType igstk::SerialCommunicationSimulator::ResultType [protected]

Reimplemented from igstk::SerialCommunication.

Definition at line 60 of file igstkSerialCommunicationSimulator.h.

---

Constructor & Destructor Documentation

igstk::SerialCommunicationSimulator::SerialCommunicationSimulator

(

)

[protected]

Constructor.

igstk::SerialCommunicationSimulator::~SerialCommunicationSimulator

(

)

[protected]

Destructor.

---

Member Function Documentation

const char* igstk::SerialCommunicationSimulator::GetFileName

(

)

const

Get the file name for the recorded data.

virtual ResultType igstk::SerialCommunicationSimulator::InternalOpenPort

(

void

)

[protected, virtual]

Opens serial port for communication;.

Reimplemented from igstk::SerialCommunication.

virtual ResultType igstk::SerialCommunicationSimulator::InternalUpdateParameters

(

void

)

[protected, virtual]

Sets up communication on the open port as per the communication parameters.

Reimplemented from igstk::SerialCommunication.

virtual ResultType igstk::SerialCommunicationSimulator::InternalClosePort

(

void

)

[protected, virtual]

Closes serial port.

Reimplemented from igstk::SerialCommunication.

virtual ResultType igstk::SerialCommunicationSimulator::InternalSendBreak

(

void

)

[protected, virtual]

Send a serial break.

Reimplemented from igstk::SerialCommunication.

virtual void igstk::SerialCommunicationSimulator::InternalSleep

(

unsigned int

milliseconds

)

[protected, virtual]

Sleep for the amount of time specified in milliseconds.

Reimplemented from igstk::SerialCommunication.

virtual ResultType igstk::SerialCommunicationSimulator::InternalPurgeBuffers

(

void

)

[protected, virtual]

Purge the input and output buffers.

Reimplemented from igstk::SerialCommunication.

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

Write data.

Reimplemented from igstk::SerialCommunication.

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

Read data.

Reimplemented from igstk::SerialCommunication.

virtual void igstk::SerialCommunicationSimulator::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/igstkSerialCommunicationSimulator.h