[#BloombergLP-balber-BerUtil_DateAndTimeHeader]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/balber.adoc[balber]::BerUtil&lowbar;DateAndTimeHeader
:relfileprefix: ../../
:mrdocs:

Two&hyphen;byte header for extended&hyphen;binary date&hyphen;and&hyphen;time encodings&period;

== Synopsis

Declared in `&lt;balber&lowbar;berutil&period;h&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class BerUtil&lowbar;DateAndTimeHeader;
----

== Description

This component&hyphen;private, in&hyphen;core, value&hyphen;semantic attribute class provides a representation of the information available in the first two bytes of any extended&hyphen;binary&hyphen;encoding formatted data&period; All extended&hyphen;binary encoding schemes for date&hyphen;and&hyphen;time types contain a 2&hyphen;byte header in the same format, which can be unambiguously distinguished from the first 2 bytes of a date&hyphen;and&hyphen;time type in its corresponding compact&hyphen;binary&hyphen;encoding format or its ISO 8601 format&period;

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balber/BerUtil_DateAndTimeHeader/TimezoneUtil.adoc[`TimezoneUtil`] 
| `TimezoneUtil` is an alias to a namespace for a suite of functions used to implement BER encoding and decoding operations for time&hyphen;zone offset values&period;
| xref:BloombergLP/balber/BerUtil_DateAndTimeHeader/Type.adoc[`Type`] 
| Alias for the extended&hyphen;binary header type enumeration&period;
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balber/BerUtil_DateAndTimeHeader/2constructor.adoc[`BerUtil&lowbar;DateAndTimeHeader`]         [.small]#[constructor]#
| Create a header with not&hyphen;extended&hyphen;binary type and zero offset&period;
| xref:BloombergLP/balber/BerUtil_DateAndTimeHeader/isExtendedBinary.adoc[`isExtendedBinary`] 
| Return `true` if the `type` attribute of this object is `Type&colon;&colon;e&lowbar;EXTENDED&lowbar;BINARY&lowbar;WITH&lowbar;TIMEZONE` or `Type&colon;&colon;e&lowbar;EXTENDED&lowbar;BINARY&lowbar;WITHOUT&lowbar;TIMEZONE`, and `false` otherwise&period;
| xref:BloombergLP/balber/BerUtil_DateAndTimeHeader/isExtendedBinaryWithTimezone.adoc[`isExtendedBinaryWithTimezone`] 
| Return `true` if the `type` attribute of this object is `Type&colon;&colon;e&lowbar;EXTENDED&lowbar;BINARY&lowbar;WITH&lowbar;TIMEZONE`, and `false` otherwise&period;
| xref:BloombergLP/balber/BerUtil_DateAndTimeHeader/isExtendedBinaryWithoutTimezone.adoc[`isExtendedBinaryWithoutTimezone`] 
| Return `true` if the `type` attribute of this object is `Type&colon;&colon;e&lowbar;EXTENDED&lowbar;BINARY&lowbar;WITHOUT&lowbar;TIMEZONE`, and `false` otherwise&period;
| xref:BloombergLP/balber/BerUtil_DateAndTimeHeader/makeExtendedBinaryWithTimezone.adoc[`makeExtendedBinaryWithTimezone`] 
| Set the `type` attribute of this object to the `Type&colon;&colon;e&lowbar;EXTENDED&lowbar;BINARY&lowbar;WITH&lowbar;TIMEZONE` value and the `timezoneOffsetInMinutes` attribute of this object to the&period;
| xref:BloombergLP/balber/BerUtil_DateAndTimeHeader/makeExtendedBinaryWithoutTimezone.adoc[`makeExtendedBinaryWithoutTimezone`] 
| Set this header to extended&hyphen;binary without a time&hyphen;zone offset&period;
| xref:BloombergLP/balber/BerUtil_DateAndTimeHeader/makeNotExtendedBinary.adoc[`makeNotExtendedBinary`] 
| Set the `type` attribute of this object to the `Type&colon;&colon;e&lowbar;NOT&lowbar;EXTENDED&lowbar;BINARY` value and the `timezoneOffsetInMinutes` attribute of this object to the 0 value&period;
| xref:BloombergLP/balber/BerUtil_DateAndTimeHeader/timezoneOffsetInMinutes.adoc[`timezoneOffsetInMinutes`] 
| Return the value of the `timezoneOffsetInMinutes` attribute of this object&period;
|===



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