[#BloombergLP-balber-BerUtil_DateAndTimeHeader]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/balber.adoc[balber]::BerUtil_DateAndTimeHeader
:relfileprefix: ../../
:mrdocs:

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

== Synopsis

Declared in `<balber_berutil.h>`

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

== 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‐zone offset values.
| xref:BloombergLP/balber/BerUtil_DateAndTimeHeader/Type.adoc[`Type`] 
| `Type` is an alias to a namespace for enumerating the set of "header type" values that may be encoded in the 2‐byte header of an extended‐binary‐encoding formatted date‐and‐time value.
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balber/BerUtil_DateAndTimeHeader/2constructor.adoc[`BerUtil_DateAndTimeHeader`]         [.small]#[constructor]#
| Create a `BerUtil_DateAndTimeHeader` object having a `type` attribute with the `Type::e_NOT_EXTENDED_BINARY` value and a `timezoneOffsetInMinutes` attribute with the 0 value.
| xref:BloombergLP/balber/BerUtil_DateAndTimeHeader/isExtendedBinary.adoc[`isExtendedBinary`] 
| Return `true` if the `type` attribute of this object is `Type::e_EXTENDED_BINARY_WITH_TIMEZONE` or `Type::e_EXTENDED_BINARY_WITHOUT_TIMEZONE`, and `false` otherwise.
| xref:BloombergLP/balber/BerUtil_DateAndTimeHeader/isExtendedBinaryWithTimezone.adoc[`isExtendedBinaryWithTimezone`] 
| Return `true` if the `type` attribute of this object is `Type::e_EXTENDED_BINARY_WITH_TIMEZONE`, and `false` otherwise.
| xref:BloombergLP/balber/BerUtil_DateAndTimeHeader/isExtendedBinaryWithoutTimezone.adoc[`isExtendedBinaryWithoutTimezone`] 
| Return `true` if the `type` attribute of this object is `Type::e_EXTENDED_BINARY_WITHOUT_TIMEZONE`, and `false` otherwise.
| xref:BloombergLP/balber/BerUtil_DateAndTimeHeader/makeExtendedBinaryWithTimezone.adoc[`makeExtendedBinaryWithTimezone`] 
| Set the `type` attribute of this object to the `Type::e_EXTENDED_BINARY_WITH_TIMEZONE` value and the `timezoneOffsetInMinutes` attribute of this object to the specified `offset`. The behavior is undefined unless `TimezoneUtil::k_MIN_OFFSET <= offset` and `TimezoneUtil::k_MAX_OFFSET >= offset`.
| xref:BloombergLP/balber/BerUtil_DateAndTimeHeader/makeExtendedBinaryWithoutTimezone.adoc[`makeExtendedBinaryWithoutTimezone`] 
| Set the `type` attribute of this object to the `Type::e_EXTENDED_BINARY_WITHOUT_TIMEZONE` value and the `timezoneOffsetInMinutes` attribute of this object to the 0 value.
| xref:BloombergLP/balber/BerUtil_DateAndTimeHeader/makeNotExtendedBinary.adoc[`makeNotExtendedBinary`] 
| Set the `type` attribute of this object to the `Type::e_NOT_EXTENDED_BINARY` value and the `timezoneOffsetInMinutes` attribute of this object to the 0 value.
| xref:BloombergLP/balber/BerUtil_DateAndTimeHeader/timezoneOffsetInMinutes.adoc[`timezoneOffsetInMinutes`] 
| Return the value of the `timezoneOffsetInMinutes` attribute of this object.
|===



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