This abstract class defines the 'Transmit Command' interface for the TPipe. More...

Detailed Description

This abstract class defines the 'Transmit Command' interface for the TPipe.

#include <Tx.h>

Inheritance diagram for Driver::TPipe::Tx:

Public Member Functions
virtual bool	sendCommand (const char *completeCommandText, size_t numBytes) noexcept=0
	Synchronously transmits a complete 'text command'.

bool	sendCommand (Cpl::Text::String &command) noexcept
	Convenience method to send a command that is contain in Text string object.

bool	sendCommand (const char *commandString) noexcept
	Convenience method to send a command that is a contained in a null terminated string.

virtual bool	sendRawCommand (const char *completeCommandText, size_t numBytes) noexcept=0
	This is an OPTIMIZATION - use with care!!

virtual	~Tx ()
	Virtual destructor.

Constructor & Destructor Documentation

◆ ~Tx()

virtual Driver::TPipe::Tx::~Tx ( )

inlinevirtual

Virtual destructor.

Member Function Documentation

◆ sendCommand() [1/3]

bool Driver::TPipe::Tx::sendCommand ( const char * commandString )

inlinenoexcept

Convenience method to send a command that is a contained in a null terminated string.

◆ sendCommand() [2/3]

virtual bool Driver::TPipe::Tx::sendCommand	(	const char *	completeCommandText,
		size_t	numBytes
	)

pure virtualnoexcept

Synchronously transmits a complete 'text command'.

The method will provide the proper TPipe framing and send the framed contents through the pipe.

The method returns true once the frame data has been transferred to the TPipe's outbound stream. If an a Stream error occurred the method returns false.

NOTE: The method will block if there is currently a transmission of a frame in progress.

Implemented in Driver::TPipe::Pipe.

◆ sendCommand() [3/3]

bool Driver::TPipe::Tx::sendCommand ( Cpl::Text::String & command )

inlinenoexcept

Convenience method to send a command that is contain in Text string object.

◆ sendRawCommand()

virtual bool Driver::TPipe::Tx::sendRawCommand	(	const char *	completeCommandText,
		size_t	numBytes
	)