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

This value‐semantic class describes a date value in a particular time zone, which is indicated using an offset from UTC (in minutes).

== Synopsis

Declared in `<bdlt_datetz.h>`

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

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlt/DateTz/2constructor-07.adoc[`DateTz`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/bdlt/DateTz/2destructor.adoc[`~DateTz`] [.small]#[destructor]#
| Destroy this object.
| xref:BloombergLP/bdlt/DateTz/operator_assign.adoc[`operator=`] 
| Assign to this object the value of the specified `rhs` object, and return a reference providing modifiable access to this object.
| xref:BloombergLP/bdlt/DateTz/bdexStreamIn.adoc[`bdexStreamIn`] 
| Assign to this object the value read from the specified input stream.
| xref:BloombergLP/bdlt/DateTz/bdexStreamOut.adoc[`bdexStreamOut`] 
| Write this object to the specified output stream using BDEX.
| xref:BloombergLP/bdlt/DateTz/gmtStartTime.adoc[`gmtStartTime`] 
| Return the UTC datetime when this object's local date starts.
| xref:BloombergLP/bdlt/DateTz/localDate.adoc[`localDate`] 
| Return the local date represented by this object.
| xref:BloombergLP/bdlt/DateTz/offset.adoc[`offset`] 
| Return the time zone offset of this `DateTz` object. Note that the offset is in minutes from UTC.
| xref:BloombergLP/bdlt/DateTz/print.adoc[`print`] 
| Write this object to the specified stream in a human‐readable format.
| xref:BloombergLP/bdlt/DateTz/setDateTz.adoc[`setDateTz`] 
| Set this object's local date and time zone offset.
| xref:BloombergLP/bdlt/DateTz/setDateTzIfValid.adoc[`setDateTzIfValid`] 
| Set this object's date and offset if they form a valid `DateTz`.
| xref:BloombergLP/bdlt/DateTz/utcStartTime.adoc[`utcStartTime`] 
| Return the UTC datetime when this object's local date starts.
| xref:BloombergLP/bdlt/DateTz/validateAndSetDateTz.adoc[`validateAndSetDateTz`] 
| Set this object's date and offset if they form a valid `DateTz`.
|===


== Static Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlt/DateTz/isValid.adoc[`isValid`] 
| Return whether `localDate` and `offset` form a valid `DateTz`.
| xref:BloombergLP/bdlt/DateTz/maxSupportedBdexVersion-03.adoc[`maxSupportedBdexVersion`] 
| `maxSupportedBdexVersion` overloads
|===


== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlt/operator_not_eq-098.adoc[`operator!=`]
| Return whether the specified `lhs` and `rhs` do not have the same value.
| xref:BloombergLP/bdlt/operator_eq-000.adoc[`operator==`]
| Return whether the specified `lhs` and `rhs` have the same value.
|===


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