Cpl::Text::Frame::Encoder_ Class Reference

This Private Namespace partially concrete class implements common/helper method for supporting the Encoder API. More...

Detailed Description

This Private Namespace partially concrete class implements common/helper method for supporting the Encoder API.

There is no checking/enforcement of the content of the Frame (e.g. it will accept non-ASCII character) except for the SOF, EOF, and ESC characters.

#include <Encoder_.h>

Inheritance diagram for Cpl::Text::Frame::Encoder_:

Collaboration diagram for Cpl::Text::Frame::Encoder_:

Public Member Functions
bool	startFrame (void) noexcept
	See Cpl::Text::Frame::Encoder.
bool	output (char src) noexcept
	See Cpl::Text::Frame::Encoder.
bool	output (const char *src) noexcept
	See Cpl::Text::Frame::Encoder.
bool	output (const char *src, size_t numBytes) noexcept
	See Cpl::Text::Frame::Encoder.
bool	endFrame (void) noexcept
	See Cpl::Text::Frame::Encoder.
Public Member Functions inherited from Cpl::Text::Frame::Encoder
virtual	~Encoder ()
	Virtual Destructor.

Protected Member Functions
	Encoder_ (char startOfFrame, char endOfFrame, char escapeChar, bool appendNewline=true)
	Constructor.
virtual bool	start (char src) noexcept=0
	Helper method - implemented by the child class.
virtual bool	start () noexcept=0
	Helper method - implemented by the child class.
virtual bool	append (char src) noexcept=0
	Helper method - implemented by the child class.
virtual char	encodeChar (char charToBeEscaped)
	Returns the encoded/escaped value for the specified special character.

Protected Attributes
bool	m_inFrame
	Output/Frame state.
const char	m_sof
	SOF character.
const char	m_eof
	EOF character.
const char	m_esc
	Escape character.
const bool	m_appendNewline
	Remember my newline option.

Constructor & Destructor Documentation

Encoder_()

Cpl::Text::Frame::Encoder_::Encoder_ ( char  startOfFrame, char  endOfFrame, char  escapeChar, bool  appendNewline = true  )

protected

Constructor.

The 'appendNewline' argument when set to true will append a newline character to the output stream AFTER the EOF character (this can make for more human readable output stream).

NOTES:

o If 'startOfFrame' is '\0', then Encoder will begin the
  frame WITHOUT inserting a SOF character.  This is useful
  when there application desires/has multiple start-of-frame
  characters for a given frame.

o If 'escapeChar' is '\0', then Encoder will NOT escape any
  characters - buyers beware when using this feature!

Member Function Documentation

append()

virtual bool Cpl::Text::Frame::Encoder_::append ( char  src )

protectedpure virtualnoexcept

Helper method - implemented by the child class.

Implemented in Cpl::Text::Frame::BlockEncoder, Cpl::Text::Frame::StreamEncoder, and Cpl::Text::Frame::StringEncoder.

encodeChar()

virtual char Cpl::Text::Frame::Encoder_::encodeChar ( char  charToBeEscaped )

protectedvirtual

Returns the encoded/escaped value for the specified special character.

The default implementation simply returns 'charToBeEscaped'

endFrame()

bool Cpl::Text::Frame::Encoder_::endFrame ( void  )

virtualnoexcept

See Cpl::Text::Frame::Encoder.

Implements Cpl::Text::Frame::Encoder.

output() [1/3]

bool Cpl::Text::Frame::Encoder_::output ( char  src )

virtualnoexcept

See Cpl::Text::Frame::Encoder.

Implements Cpl::Text::Frame::Encoder.

output() [2/3]

bool Cpl::Text::Frame::Encoder_::output ( const char *  src )

virtualnoexcept

See Cpl::Text::Frame::Encoder.

Implements Cpl::Text::Frame::Encoder.

output() [3/3]

bool Cpl::Text::Frame::Encoder_::output ( const char *  src, size_t  numBytes  )

virtualnoexcept

See Cpl::Text::Frame::Encoder.

Implements Cpl::Text::Frame::Encoder.

start() [1/2]

virtual bool Cpl::Text::Frame::Encoder_::start ( )

protectedpure virtualnoexcept

Helper method - implemented by the child class.

Implemented in Cpl::Text::Frame::BlockEncoder, Cpl::Text::Frame::StreamEncoder, and Cpl::Text::Frame::StringEncoder.

start() [2/2]

virtual bool Cpl::Text::Frame::Encoder_::start ( char  src )

protectedpure virtualnoexcept

Helper method - implemented by the child class.

Implemented in Cpl::Text::Frame::BlockEncoder, Cpl::Text::Frame::StreamEncoder, and Cpl::Text::Frame::StringEncoder.

startFrame()

bool Cpl::Text::Frame::Encoder_::startFrame ( void  )

virtualnoexcept

See Cpl::Text::Frame::Encoder.

Implements Cpl::Text::Frame::Encoder.

Member Data Documentation

m_appendNewline

const bool Cpl::Text::Frame::Encoder_::m_appendNewline

protected

Remember my newline option.

m_eof

const char Cpl::Text::Frame::Encoder_::m_eof

protected

EOF character.

m_esc

const char Cpl::Text::Frame::Encoder_::m_esc

protected

Escape character.

m_inFrame

bool Cpl::Text::Frame::Encoder_::m_inFrame

protected

Output/Frame state.

m_sof

const char Cpl::Text::Frame::Encoder_::m_sof

protected

SOF character.

---

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

• Cpl/Text/Frame/Encoder_.h