[#BloombergLP-ball-ObserverFormatterImp]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/ball.adoc[ball]::ObserverFormatterImp
:relfileprefix: ../../
:mrdocs:

Provide shared formatting support for scheme‐based log observers.

== Synopsis

Declared in `<ball_observerformatterimp.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class ObserverFormatterImp;
----

== Description

This class provides a common implementation of formatting‐related methods for observer components that support scheme‐based log record formatting. It manages a log record formatter, format configuration strings, and time zone preferences. This implementation is intended to be used as a data member in concrete observer classes to provide consistent formatting behavior across different observer types.

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/ball/ObserverFormatterImp/RecordFormatter.adoc[`RecordFormatter`] 
| `RecordFormatter` is an alias for the type of the functor used for formatting log records to a stream.
| xref:BloombergLP/ball/ObserverFormatterImp/allocator_type.adoc[`allocator_type`] 
| This `typedef` is an alias for the allocator used by this object.
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/ball/ObserverFormatterImp/2constructor.adoc[`ObserverFormatterImp`]         [.small]#[constructor]#
| Create a `ObserverFormatterImp` instance that formats log records using the specified `format` and `timezoneDefault`.
| xref:BloombergLP/ball/ObserverFormatterImp/formatLogRecord.adoc[`formatLogRecord`] 
| Format the specified log `record` into the specified output `stream` using the current record formatter functor.
| xref:BloombergLP/ball/ObserverFormatterImp/getFormat.adoc[`getFormat`] 
| Return the currently active format configuration string of this object.
| xref:BloombergLP/ball/ObserverFormatterImp/getTimezoneDefault.adoc[`getTimezoneDefault`] 
| Return the currently active time zone default of this object.
| xref:BloombergLP/ball/ObserverFormatterImp/get_allocator.adoc[`get_allocator`] 
| Return the allocator used by this object to supply memory.
| xref:BloombergLP/ball/ObserverFormatterImp/setFormat.adoc[`setFormat`] 
| Set the log record format specifications for this object according to the specified `format`.
| xref:BloombergLP/ball/ObserverFormatterImp/setFormatFunctor.adoc[`setFormatFunctor`] 
| Set the formatting functor used when writing records to the specified `formatter` functor.
| xref:BloombergLP/ball/ObserverFormatterImp/setTimezoneDefault.adoc[`setTimezoneDefault`] 
| Set the default time zone used for timestamps that have no timezone preference specified in the format config string.
|===



[.small]#Created with https://www.mrdocs.com[MrDocs]#