#include <string_device.h>

Inheritance diagram for StringDevice:

Public Member Functions
	StringDevice (const unsigned int UI_OutputMaxLen, const bool B_AutoDelete)
	Regular constructor. More...

virtual	~StringDevice (void)
	Destructor. More...

virtual const bool	OpenDevice (void)
	Device opening handler. More...

virtual const bool	CloseDevice (void)
	Device closure handler. More...

virtual void	PutString (const char *const STR_Out) const
	Output handler. More...

virtual void	Beep (void) const
	Beep handler. More...

virtual void	CleanScreen (void) const
	Clean screen. More...

const tk::String &	GetString (void) const
	String accessor. More...

StringDevice &	Reset (void)
	Reset. More...

Public Member Functions inherited from OutputDevice
const tk::String	GetDebugName (void) const
	Debug name accessor. More...

const int	UseInstance (const CallInfo &CLI_CallInfo)
	Ensures instance validity. More...

const int	FreeInstance (const CallInfo &CLI_CallInfo)
	Releases the instance. More...

const int	GetInstanceUsers (void) const
	Instance user count accessor. More...

const bool	OpenUp (const CallInfo &CLI_CallInfo)
	Checks the device is opened. More...

const bool	CloseDown (const CallInfo &CLI_CallInfo)
	Indicates the device the client does not need the device to opened anymore. More...

const int	GetOpenUsers (void) const
	Open state user count accessor. More...

const OutputDevice &	operator<< (const std::string &STR_Out) const
	Output operator. More...

const OutputDevice &	operator<< (const tk::String &STR_Out) const
	Output operator. More...

const OutputDevice &	operator<< (const char *const STR_Out) const
	Output operator. More...

const OutputDevice &	operator<< (const char C_Out) const
	Output operator. More...

const OutputDevice &	operator<< (const KEY E_Key) const
	Output operator. More...

const OutputDevice &	operator<< (const uint8_t UI8_Out) const
	Output operator. More...

const OutputDevice &	operator<< (const int16_t I16_Out) const
	Output operator. More...

const OutputDevice &	operator<< (const uint16_t UI16_Out) const
	Output operator. More...

const OutputDevice &	operator<< (const int32_t I32_Out) const
	Output operator. More...

const OutputDevice &	operator<< (const uint32_t UI32_Out) const
	Output operator. More...

const OutputDevice &	operator<< (const int64_t I64_Out) const
	Output operator. More...

const OutputDevice &	operator<< (const uint64_t UI64_Out) const
	Output operator. More...

const OutputDevice &	operator<< (const float F_Out) const
	Output operator. More...

const OutputDevice &	operator<< (const double D_Out) const
	Output operator. More...

const OutputDevice &	operator<< (const void *const PV_Out) const
	Output operator. More...

const OutputDevice &	operator<< (const IOEndl &CLI_IOEndl) const
	Output operator. More...

const ResourceString	GetLastError (void) const
	Last error accessor. More...

virtual const ScreenInfo	GetScreenInfo (void) const
	Screen info accessor. More...

virtual const bool	WouldOutput (const OutputDevice &CLI_Device) const
	Stack overflow protection. More...

Public Member Functions inherited from Object
virtual	~Object (void)=0
	Pure virtual destructor. More...

Additional Inherited Members
Static Public Member Functions inherited from OutputDevice
static OutputDevice &	GetNullDevice (void)
	Null device singleton. More...

static OutputDevice &	GetStdOut (void)
	Standard output device singleton. More...

static OutputDevice &	GetStdErr (void)
	Standard error device singleton. More...

Protected Member Functions inherited from OutputDevice
	OutputDevice (const char *const STR_DbgName, const bool B_AutoDelete)
	Constructor. More...

virtual	~OutputDevice (void)
	Destructor. More...

Protected Member Functions inherited from Object
	Object (void)
	Default constructor only available to sub-classes. More...

Protected Attributes inherited from OutputDevice
ResourceString	m_cliLastError

Detailed Description

String device.

Unless for unit tests purpose, I don't really know yet what this device could be useful for. However, if one would need to receive the result of commands in strings to analyze them, this device would fit this kind of need. That's the reason why I'm exposing it in the public visibility like the other classes of the library.

Definition at line 46 of file string_device.h.

Constructor & Destructor Documentation

◆ StringDevice()

StringDevice::StringDevice	(	const unsigned int	UI_OutputMaxLen,
		const bool	B_AutoDelete
	)

explicit

Regular constructor.

Parameters

UI_OutputMaxLen	Output maximum length.
B_AutoDelete	Auto-deletion flag.

◆ ~StringDevice()

virtual StringDevice::~StringDevice ( void )

virtual

Destructor.

Member Function Documentation

◆ Beep()

virtual void StringDevice::Beep ( void ) const

virtual

Beep handler.

Reimplemented from OutputDevice.

◆ CleanScreen()

virtual void StringDevice::CleanScreen ( void ) const

virtual

Clean screen.

Reimplemented from OutputDevice.

◆ CloseDevice()

virtual const bool StringDevice::CloseDevice ( void )

virtual

Device closure handler.

Returns: true for success, false otherwise.

Note: Devices have to be prepared to be called several times through this method. They should do the closure once only (unless they have been opened between CloseDevice() calls), and indicate no failure thereafter.

Implements OutputDevice.

◆ GetString()

const tk::String& StringDevice::GetString ( void ) const

String accessor.

Returns: Output string.

Referenced by More::OnKey(), and More::ResetToDefault().

◆ OpenDevice()

virtual const bool StringDevice::OpenDevice ( void )

virtual

Device opening handler.

Returns: true for success, false otherwise.

Note: Devices have to be prepared to be called several times through this method. They should do the opening once only (unless they have been closed between OpendDevice() calls), and indicate no failure thereafter.

Implements OutputDevice.

◆ PutString()

virtual void StringDevice::PutString ( const char *const STR_Out ) const

virtual

Output handler.

Parameters

STR_Out Output string.

Implements OutputDevice.

◆ Reset()

StringDevice& StringDevice::Reset ( void )

Reset.

Returns: The StringDevice instance itself.

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

string_device.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ StringDevice()

◆ ~StringDevice()

Member Function Documentation

◆ Beep()

◆ CleanScreen()

◆ CloseDevice()

◆ GetString()

◆ OpenDevice()

◆ PutString()

◆ Reset()