[#BloombergLP-baltzo-LocalDatetime]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/baltzo.adoc[baltzo]::LocalDatetime
:relfileprefix: ../../
:mrdocs:

This unconstrained (value‐semantic) attribute class characterizes a date time, offset from UTC, and a time zone identifier represented by a string. See the  section for information on the class attributes.

== Synopsis

Declared in `<baltzo_localdatetime.h>`

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

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/baltzo/LocalDatetime/allocator_type.adoc[`allocator_type`] 
| Allocator type used by this class.
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/baltzo/LocalDatetime/2constructor-06d.adoc[`LocalDatetime`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/baltzo/LocalDatetime/2destructor.adoc[`~LocalDatetime`] [.small]#[destructor]#
| Destroy this object.
| xref:BloombergLP/baltzo/LocalDatetime/operator_assign-01.adoc[`operator=`] 
| Assignment operators
| xref:BloombergLP/baltzo/LocalDatetime/allocator.adoc[`allocator`] 
| Return `get_allocator().mechanism()`.
| xref:BloombergLP/baltzo/LocalDatetime/bdexStreamIn.adoc[`bdexStreamIn`] 
| Assign to this object the value read from the specified input `stream` using the specified `version` format, and return a reference to `stream`. If `stream` is initially invalid, this operation has no effect. If `version` is not supported, this object is unaltered and `stream` is invalidated, but otherwise unmodified. If `version` is supported but `stream` becomes invalid during this operation, this object has an undefined, but valid, state. Note that no version is read from `stream`. See the `bslx` package‐level documentation for more information on BDEX streaming of value‐semantic types and containers.
| xref:BloombergLP/baltzo/LocalDatetime/bdexStreamOut.adoc[`bdexStreamOut`] 
| Write this object to the specified output `stream`.
| xref:BloombergLP/baltzo/LocalDatetime/datetimeTz.adoc[`datetimeTz`] 
| Return a reference providing non‐modifiable access to the `datetimeTz` attribute of this object.
| xref:BloombergLP/baltzo/LocalDatetime/get_allocator.adoc[`get_allocator`] 
| Return the allocator used by this object to supply memory. Note that if no allocator was supplied at construction the default allocator in effect at construction is used.
| xref:BloombergLP/baltzo/LocalDatetime/print.adoc[`print`] 
| Write the value of this object to the specified output `stream` in a human‐readable format, and return a reference providing modifiable access to `stream`. Optionally specify an initial indentation `level`, whose absolute value is incremented recursively for nested objects. If `level` is specified, optionally specify `spacesPerLevel`, whose absolute value indicates the number of spaces per indentation level for this and all of its nested objects. If `level` is negative, suppress indentation of the first line. If `spacesPerLevel` is negative, format the entire output on one line, suppressing all but the initial indentation (as governed by `level`). If `stream` is not valid on entry, this operation has no effect. Note that the format is not fully specified, and can change without notice.
| xref:BloombergLP/baltzo/LocalDatetime/setDatetimeTz.adoc[`setDatetimeTz`] 
| Set the `datetimeTz` attribute of this object to the specified `value`.
| xref:BloombergLP/baltzo/LocalDatetime/setTimeZoneId-0d.adoc[`setTimeZoneId`] 
| `setTimeZoneId` overloads
| xref:BloombergLP/baltzo/LocalDatetime/swap.adoc[`swap`] 
| Efficiently exchange the value of this object with the value of the specified `other` object. This method provides the no‐throw exception‐safety guarantee. The behavior is undefined unless this object was created with the same allocator as was `other`.
| xref:BloombergLP/baltzo/LocalDatetime/timeZoneId.adoc[`timeZoneId`] 
| Return a reference providing non‐modifiable access to the `timeZoneId` attribute of this object.
| xref:BloombergLP/baltzo/LocalDatetime/2conversion.adoc[`operator BloombergLP::bslmf::NestedTraitDeclaration<LocalDatetime, IsBitwiseMoveable>`] 
| Nested trait declaration for `bslma::UsesBslmaAllocator`.
|===


== Static Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/baltzo/LocalDatetime/maxSupportedBdexVersion-08.adoc[`maxSupportedBdexVersion`] 
| `maxSupportedBdexVersion` overloads
|===


== Friends

[cols="1,4"]
|===
| Name| Description
| `xref:BloombergLP/baltzo/swap-02.adoc[BloombergLP::baltzo::swap]`
| Exchange the values of the specified `a` and `b` objects. This function provides the no‐throw exception‐safety guarantee if the two objects were created with the same allocator and the basic guarantee otherwise.
|===

== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/baltzo/operator_not_eq-04f.adoc[`operator!=`]
| Return `true` if the specified `lhs` and `rhs` objects do not have the same value, and `false` otherwise. Two `LocalDatetime` objects do not have the same value if any of the corresponding values of their `datetimeTz` or `timeZoneId` attributes are not the same.
| xref:BloombergLP/baltzo/operator_eq-04.adoc[`operator==`]
| Return `true` if the specified `lhs` and `rhs` objects have the same value, and `false` otherwise. Two `LocalDatetime` objects have the same value if all of the corresponding values of their `datetimeTz` and `timeZoneId` attributes are the same.
|===


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