MHV_Device_TX Class Reference

#include <MHV_Device_TX.h>

Inheritance diagram for MHV_Device_TX:

List of all members.

Public Member Functions
bool	canWrite ()
bool	write (const char *buffer)
bool	write (const char *buffer, uint16_t length)
bool	write (const char *buffer, void(*completeFunction)(const char *))
bool	write (const char *buffer, uint16_t length, void(*completeFunction)(const char *))
bool	write_P (PGM_P buffer)
bool	write_P (PGM_P buffer, uint16_t length)
bool	debug (const char *file, int line, const char *function, PGM_P format,...)
bool	printf (PGM_P format,...)
bool	write (uint8_t value)
bool	write (uint16_t value)
bool	write (uint32_t value)
bool	write (int8_t value)
bool	write (int16_t value)
bool	write (int32_t value)
Protected Member Functions
	MHV_Device_TX (MHV_RingBuffer &txPointers)
virtual void	runTxBuffers ()=0
bool	moreTX ()
int	nextCharacter ()
Protected Attributes
MHV_TX_BUFFER	_currentTx
MHV_RingBuffer &	_txPointers
const char *	_tx

---

Detailed Description

Definition at line 59 of file MHV_Device_TX.h.

---

Constructor & Destructor Documentation

MHV_Device_TX::MHV_Device_TX

(

MHV_RingBuffer &

txPointers

)

[protected]

Constructor

Parameters:

txPointers

A ringbuffer to store tx pointers in

Definition at line 41 of file MHV_Device_TX.cpp.

---

Member Function Documentation

bool MHV_Device_TX::canWrite

(

)

Definition at line 72 of file MHV_Device_TX.cpp.

bool MHV_Device_TX::debug	(	const char *	file,
		int	line,
		const char *	function,
		PGM_P	format,
			...
	)

Print a debug message

Parameters:

file	the filename
line	the line number
function	the function name
format	a printf format
...	the printf parms

Returns:

false on success true if the message was not sent

Definition at line 295 of file MHV_Device_TX.cpp.

bool MHV_Device_TX::moreTX

(

)

[protected]

Called when a buffer has been processed

Returns:

true if there is another buffer to process

Definition at line 54 of file MHV_Device_TX.cpp.

int MHV_Device_TX::nextCharacter

(

)

[protected]

Called by children to get a character to transmit

Returns:

the character, or -1 if there is nothing left

Definition at line 80 of file MHV_Device_TX.cpp.

bool MHV_Device_TX::printf	(	PGM_P	format,
			...
	)

Print a message

Parameters:

format	a printf format
...	the printf parms

Returns:

false on success true if there is already a string being sent

Definition at line 337 of file MHV_Device_TX.cpp.

virtual void MHV_Device_TX::runTxBuffers

(

)

[protected, pure virtual]

Implemented in MHV_HardwareSerial, MHV_Display_Character, MHV_Display_Monochrome, MHV_VusbConsole, and MHV_VusbTypist.

bool MHV_Device_TX::write

(

const char *

buffer

)

Write a string asynchronously

Parameters:

buffer

the string

Returns:

false on success true if there is already a string being sent

Definition at line 143 of file MHV_Device_TX.cpp.

bool MHV_Device_TX::write	(	const char *	buffer,
		uint16_t	length
	)

Write a buffer asynchronously

Parameters:

buffer	the buffer
length	the length of the buffer

Returns:

false on success true if there is already a string being sent

Definition at line 227 of file MHV_Device_TX.cpp.

bool MHV_Device_TX::write	(	const char *	buffer,
		void(*)(const char *)	completeFunction
	)

Write a string asynchronously

Parameters:

buffer	the string
completeFunction	a function to call when the string has been written (the string is passed as a parameter)

Returns:

false on success true if there is already a string being sent

Definition at line 171 of file MHV_Device_TX.cpp.

bool MHV_Device_TX::write	(	const char *	buffer,
		uint16_t	length,
		void(*)(const char *)	completeFunction
	)

Write a buffer asynchronously

Parameters:

buffer	the buffer
length	the length of the buffer
completeFunction	a function to call when the string has been written (the string is passed as a parameter)

Returns:

false on success true if there is already a string being sent

Definition at line 256 of file MHV_Device_TX.cpp.

bool MHV_Device_TX::write

(

uint8_t

value

)

Print an integer

Parameters:

value

the value to print

Returns:

false on success true if there is already a string being sent

Definition at line 369 of file MHV_Device_TX.cpp.

bool MHV_Device_TX::write

(

uint16_t

value

)

Print an integer

Parameters:

value

the value to print

Returns:

false on success true if there is already a string being sent

Definition at line 388 of file MHV_Device_TX.cpp.

bool MHV_Device_TX::write

(

uint32_t

value

)

Print an integer

Parameters:

value

the value to print

Returns:

false on success true if there is already a string being sent

Definition at line 407 of file MHV_Device_TX.cpp.

bool MHV_Device_TX::write

(

int8_t

value

)

Print an integer

Parameters:

value

the value to print

Returns:

false on success true if there is already a string being sent

Definition at line 426 of file MHV_Device_TX.cpp.

bool MHV_Device_TX::write

(

int16_t

value

)

Print an integer

Parameters:

value

the value to print

Returns:

false on success true if there is already a string being sent

Definition at line 445 of file MHV_Device_TX.cpp.

bool MHV_Device_TX::write

(

int32_t

value

)

Print an integer

Parameters:

value

the value to print

Returns:

false on success true if there is already a string being sent

Definition at line 464 of file MHV_Device_TX.cpp.

bool MHV_Device_TX::write_P

(

PGM_P

buffer

)

Write a progmem string asynchronously

Parameters:

buffer

the progmem string

Returns:

false on success true if there is already a string being sent

Definition at line 116 of file MHV_Device_TX.cpp.

bool MHV_Device_TX::write_P	(	PGM_P	buffer,
		uint16_t	length
	)

Write a buffer asynchronously

Parameters:

buffer	the buffer
length	the length of the buffer

Returns:

false on success true if there is already a string being sent

Definition at line 199 of file MHV_Device_TX.cpp.

---

Member Data Documentation

MHV_TX_BUFFER MHV_Device_TX::_currentTx [protected]

Definition at line 61 of file MHV_Device_TX.h.

const char* MHV_Device_TX::_tx [protected]

Definition at line 63 of file MHV_Device_TX.h.

MHV_RingBuffer& MHV_Device_TX::_txPointers [protected]

Definition at line 62 of file MHV_Device_TX.h.

---

The documentation for this class was generated from the following files:

• A:/eclipse/mhvlib/MHV_Device_TX.h
• A:/eclipse/mhvlib/MHV_Device_TX.cpp