DUDS
Distributed Update of Data from Something
duds::hardware::display::TextDisplayBasicStream< Char, Traits > Class Template Reference

An output stream for immediately writing data to TextDisplay objects. More...

#include <TextDisplayStream.hpp>

Inheritance diagram for duds::hardware::display::TextDisplayBasicStream< Char, Traits >:
Collaboration diagram for duds::hardware::display::TextDisplayBasicStream< Char, Traits >:

Public Member Functions

 TextDisplayBasicStream (const std::shared_ptr< TextDisplay > &d)
 Makes an output stream that immediately writes to the given display. More...
 
- Public Member Functions inherited from duds::hardware::display::TextDisplayBaseStream< Char, Traits >
 TextDisplayBaseStream (TextDisplayBasicStreambuf< Char, Traits > *tbuf)
 Makes an output stream that writes to the given display. More...
 
void clearDisplay ()
 Remove all text from the display and place the cursor in the upper left corner. More...
 
void clearTo (unsigned int c, unsigned int r)
 Clear text from the current cursor position to the given position, inclusive. More...
 
const std::shared_ptr< TextDisplay > & display () const
 Returns the output display. More...
 
void moveCursor (unsigned int c, unsigned int r)
 Moves the display's cursor to the given location. More...
 
void startLine ()
 Moves the cursor to the start of a line clearing text along the way. More...
 

Private Attributes

TextDisplayBasicStreambuf< Char, Traits > buff
 The buffer handling the output. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from duds::hardware::display::TextDisplayBaseStream< Char, Traits >
static int xallocIndex ()
 Returns the index from xalloc(); needed by the stream manipulators. More...
 

Detailed Description

template<class Char, class Traits = std::char_traits<Char>>
class duds::hardware::display::TextDisplayBasicStream< Char, Traits >

An output stream for immediately writing data to TextDisplay objects.

It supports the use of stream modifiers intended specifically for use with TextDisplay. Stream seeking is not supported, but repositioning the display's cursor is supported.

Author
Jeff Jackowski

Definition at line 508 of file TextDisplayStream.hpp.

Constructor & Destructor Documentation

◆ TextDisplayBasicStream()

template<class Char , class Traits = std::char_traits<Char>>
duds::hardware::display::TextDisplayBasicStream< Char, Traits >::TextDisplayBasicStream ( const std::shared_ptr< TextDisplay > &  d)
inline

Makes an output stream that immediately writes to the given display.

Parameters
dThe display that will receive output.
Precondition
The display is initialzied and ready to accept data.

Definition at line 519 of file TextDisplayStream.hpp.

Member Data Documentation

◆ buff

template<class Char , class Traits = std::char_traits<Char>>
TextDisplayBasicStreambuf<Char, Traits> duds::hardware::display::TextDisplayBasicStream< Char, Traits >::buff
private

The buffer handling the output.

Definition at line 512 of file TextDisplayStream.hpp.


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