ball::RecordFormatterOptions Class Reference

#include <ball_recordformatteroptions.h>

Detailed Description

This class provides a value-semantic type for representing options used to configure log record formatters. These options are supplemental to the format specification string and affect how certain fields in log records are rendered. Currently, the only supported option is timezoneDefault, which controls whether timestamps are displayed in UTC or local time.

See ball_recordformatteroptions

Public Member Functions
	RecordFormatterOptions ()
	RecordFormatterOptions (RecordFormatterTimezone::Enum timezoneDefault)
void	setTimezoneDefault (RecordFormatterTimezone::Enum timezoneDefault)
RecordFormatterTimezone::Enum	timezoneDefault () const

Constructor & Destructor Documentation

RecordFormatterOptions() [1/2]

ball::RecordFormatterOptions::RecordFormatterOptions ( )

inline

Create a default RecordFormatterOptions object with e_UTC as its timezoneDefault setting.

RecordFormatterOptions() [2/2]

ball::RecordFormatterOptions::RecordFormatterOptions ( RecordFormatterTimezone::Enum  timezoneDefault )

inlineexplicit

Create a RecordFormatterOptions object with the specified timezoneDefault setting.

Member Function Documentation

setTimezoneDefault()

void ball::RecordFormatterOptions::setTimezoneDefault ( RecordFormatterTimezone::Enum  timezoneDefault )

inline

Set the timezone default value attribute of this object to the specified timezoneDefault.

timezoneDefault()

RecordFormatterTimezone::Enum ball::RecordFormatterOptions::timezoneDefault ( ) const

inline

Return a non-modifiable reference to the timezone default attribute of this object.

---

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

• ball_recordformatteroptions.h