[#BloombergLP-bdlt-TimeZoneFormatter]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlt.adoc[bdlt]::TimeZoneFormatter
:relfileprefix: ../../
:mrdocs:

This `class` provides a specifier formatter for printing time zones&period;

== Synopsis

Declared in `&lt;bdlt&lowbar;timezoneformatter&period;h&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template&lt;class t&lowbar;CHAR&gt;
class TimeZoneFormatter;
----

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlt/TimeZoneFormatter/2constructor.adoc[`TimeZoneFormatter`]         [.small]#[constructor]#
| Create an object in its default initial state&period;
| xref:BloombergLP/bdlt/TimeZoneFormatter/extraSections.adoc[`extraSections`] 
| Return the `bslfmt&colon;&colon;FormatSpecificationParser&colon;&colon;Sections` flags that apply to this value type&period;
| xref:BloombergLP/bdlt/TimeZoneFormatter/formatDefault.adoc[`formatDefault`] 
| Format the time zone indicated by the specified `offset` to the specified `out` using the default format and return `out`&period;
| xref:BloombergLP/bdlt/TimeZoneFormatter/formatIso8601.adoc[`formatIso8601`] 
| Format the time zone indicated by the specified `offset` to the specified `out` using the Iso8601 format and return `out`&period;
| xref:BloombergLP/bdlt/TimeZoneFormatter/formatNextSpecifier.adoc[`formatNextSpecifier`] 
| If the first character of the specified `&ast;specInOut` is recognized by this specifier formatter, use it to format the time zone indicated by the specified `offset` to `&ast;outIt`, remove the character from `&ast;specInOut`, and return `true`, otherwise return `false` with no modification to `&ast;specInOut`&period;
| xref:BloombergLP/bdlt/TimeZoneFormatter/parseDefault.adoc[`parseDefault`] 
| Parse a time zone that will be formatted in default mode&period;
| xref:BloombergLP/bdlt/TimeZoneFormatter/parseIso8601.adoc[`parseIso8601`] 
| Parse a time zone that will be formatted in Iso8601 mode&period;
| xref:BloombergLP/bdlt/TimeZoneFormatter/parseNextModifier.adoc[`parseNextModifier`] 
| Examine the first character of the specified `&ast;specInOut` and if it is recognized as a modifier by this object, update this object&apos;s state to reflect it and pop it off the front of `&ast;specInOut` and return `true`, and if not, return `false` with no modification to `&ast;specInOut`&period;
| xref:BloombergLP/bdlt/TimeZoneFormatter/parseNextSpecifier.adoc[`parseNextSpecifier`] 
| If the first character of the specified `&ast;specInOut` is recognized by this specifier formatter, parse it, remove it from `&ast;specInOut`, and return `true`, otherwise return `false` with no modification to `&ast;specInOut`&period; The behavior is undefined if `&ast;specInOut` is empty&period;
| xref:BloombergLP/bdlt/TimeZoneFormatter/postprocess.adoc[`postprocess`] 
| Read post&hyphen;processed fields from the specified `spec` that are relevant to this specifier formatter&period;
| xref:BloombergLP/bdlt/TimeZoneFormatter/totalWidth.adoc[`totalWidth`] 
| Return the anticipated width of output given all the `parse&ast;` calls that have been happened thus far and the time zone indicated by the specified `offset`&period;
|===



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