ALib C++ Library
Library Version: 2412 R0
Documentation generated by doxygen
Loading...
Searching...
No Matches
ObjectConverter Class Referenceabstract

Description:

This abstract class represents a plug-in for the TextLogger class which converts the list of logables into a textual representation.

See also
StandardConverter for further information.

Definition at line 40 of file textlogger.hpp.

#include <textlogger.hpp>

Inheritance diagram for ObjectConverter:
[legend]

Public Method Index:

virtual ~ObjectConverter ()
 Destructs an object of this class.
 
virtual void ConvertObjects (AString &target, BoxesMA &logables)=0
 
virtual AutoSizesGetAutoSizes ()=0
 
virtual void ResetAutoSizes ()=0
 
virtual ALIB_API void SetAutoSizes (AutoSizes *autoSizes)=0
 

Constructor(s) / Destructor Details:

◆ ~ObjectConverter()

virtual ~ObjectConverter ( )
inlinevirtual

Destructs an object of this class.

Definition at line 46 of file textlogger.hpp.

Method Details:

◆ ConvertObjects()

virtual void ConvertObjects ( AString & target,
BoxesMA & logables )
pure virtual

The conversion method.

Parameters
targetAn AString that takes the result.
logablesThe objects to convert.

Implemented in StandardConverter.

◆ GetAutoSizes()

virtual AutoSizes * GetAutoSizes ( )
pure virtual

If this converter uses an AutoSizes object, this method returns such object.

Returns
The auto sizes used, nullptr if not applicable.

Implemented in StandardConverter.

◆ ResetAutoSizes()

virtual void ResetAutoSizes ( )
pure virtual

If this converter uses an AutoSizes object, values of this field are reset.

Implemented in StandardConverter.

◆ SetAutoSizes()

virtual ALIB_API void SetAutoSizes ( AutoSizes * autoSizes)
pure virtual

If this converter uses an AutoSizes object, this method passes an external object to use.

Parameters
autoSizesThe instance to use.

Implemented in StandardConverter.


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