Public Member Functions | Static Public Attributes | Private Attributes | List of all members
ecl::devices::CharBuffer Class Reference

Simple char string buffer class for use internally by the devices. More...

#include <character_buffer.hpp>

Public Member Functions

long append (const char &c)
 
long append (const char *s, unsigned long n)
 
char * c_ptr ()
 
 CharBuffer ()
 
void clear ()
 
bool full () const
 
unsigned int remaining ()
 
unsigned int size () const
 
virtual ~CharBuffer ()
 

Static Public Attributes

static const unsigned int buffer_size = 4096
 

Private Attributes

char contents [buffer_size]
 
unsigned int fill_point_marker
 

Detailed Description

Simple char string buffer class for use internally by the devices.

This accommodates buffers which always reserve at least one extra byte for the end of string character.

See also
OConsole.

Definition at line 51 of file character_buffer.hpp.

Constructor & Destructor Documentation

◆ CharBuffer()

ecl::devices::CharBuffer::CharBuffer ( )
inline

Definition at line 69 of file character_buffer.hpp.

◆ ~CharBuffer()

virtual ecl::devices::CharBuffer::~CharBuffer ( )
inlinevirtual

Definition at line 70 of file character_buffer.hpp.

Member Function Documentation

◆ append() [1/2]

long ecl::devices::CharBuffer::append ( const char &  c)

Definition at line 42 of file character_buffer.cpp.

◆ append() [2/2]

long ecl::devices::CharBuffer::append ( const char *  s,
unsigned long  n 
)

Definition at line 53 of file character_buffer.cpp.

◆ c_ptr()

char* ecl::devices::CharBuffer::c_ptr ( )
inline

Definition at line 78 of file character_buffer.hpp.

◆ clear()

void ecl::devices::CharBuffer::clear ( )

Definition at line 67 of file character_buffer.cpp.

◆ full()

bool ecl::devices::CharBuffer::full ( ) const

Definition at line 34 of file character_buffer.cpp.

◆ remaining()

unsigned int ecl::devices::CharBuffer::remaining ( )
inline

Definition at line 72 of file character_buffer.hpp.

◆ size()

unsigned int ecl::devices::CharBuffer::size ( ) const
inline

Definition at line 73 of file character_buffer.hpp.

Member Data Documentation

◆ buffer_size

const unsigned int ecl::devices::CharBuffer::buffer_size = 4096
static

Definition at line 64 of file character_buffer.hpp.

◆ contents

char ecl::devices::CharBuffer::contents[buffer_size]
private

Definition at line 85 of file character_buffer.hpp.

◆ fill_point_marker

unsigned int ecl::devices::CharBuffer::fill_point_marker
private

Definition at line 84 of file character_buffer.hpp.


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


ecl_devices
Author(s): Daniel Stonier
autogenerated on Sun Aug 2 2020 03:12:18