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

This simply constrained (value‐semantic) attribute class characterizes a subset of local time values. See the  section for information on the class attributes. Note that the class invariants are identically the constraints on the individual attributes.

== Synopsis

Declared in `<baltzo_localtimedescriptor.h>`

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

== Type Aliases

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


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/baltzo/LocalTimeDescriptor/2constructor-0b.adoc[`LocalTimeDescriptor`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/baltzo/LocalTimeDescriptor/2destructor.adoc[`~LocalTimeDescriptor`] [.small]#[destructor]#
| Destroy this object.
| xref:BloombergLP/baltzo/LocalTimeDescriptor/operator_assign-0b.adoc[`operator=`] 
| Assignment operators
| xref:BloombergLP/baltzo/LocalTimeDescriptor/allocator.adoc[`allocator`] 
| Return `get_allocator().mechanism()`.
| xref:BloombergLP/baltzo/LocalTimeDescriptor/description.adoc[`description`] 
| Return a `const` reference to the `description` attribute of this object. Note that `description` is not canonical, and is intended for debugging only.
| xref:BloombergLP/baltzo/LocalTimeDescriptor/dstInEffectFlag.adoc[`dstInEffectFlag`] 
| Return the value of the `dstInEffectFlag` attribute of this object. Note that `true` implies Daylight‐Saving Time (DST) is in effect.
| xref:BloombergLP/baltzo/LocalTimeDescriptor/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/LocalTimeDescriptor/print.adoc[`print`] 
| Write the value of this object to the specified output `stream` in a human‐readable format, and return a non‐`const` reference 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/LocalTimeDescriptor/setDescription.adoc[`setDescription`] 
| Set the `description` attribute of this object to the specified `value`. Note that `value` is not canonical, and is intended for debugging only.
| xref:BloombergLP/baltzo/LocalTimeDescriptor/setDstInEffectFlag.adoc[`setDstInEffectFlag`] 
| Set the `dstInEffectFlag` attribute of this object to the specified `value`. Note that `true` implies Daylight‐Saving Time (DST) is in effect.
| xref:BloombergLP/baltzo/LocalTimeDescriptor/setUtcOffsetInSeconds.adoc[`setUtcOffsetInSeconds`] 
| Set the `utcOffsetInSeconds` attribute of this object to the specified `value`. The behavior is undefined unless `‐86399 <= value <= 86399`.
| xref:BloombergLP/baltzo/LocalTimeDescriptor/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 `other`.
| xref:BloombergLP/baltzo/LocalTimeDescriptor/utcOffsetInSeconds.adoc[`utcOffsetInSeconds`] 
| Return the value of the `utcOffsetInSeconds` attribute of this object. Note that this value is in the range `[‐86399 .. 86399]`.
| xref:BloombergLP/baltzo/LocalTimeDescriptor/2conversion.adoc[`operator BloombergLP::bslmf::NestedTraitDeclaration<LocalTimeDescriptor, IsBitwiseMoveable>`] 
| Nested trait declaration for `bslmf::IsBitwiseMoveable`.
|===


== Static Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/baltzo/LocalTimeDescriptor/isValidUtcOffsetInSeconds.adoc[`isValidUtcOffsetInSeconds`] 
| Return `true` if the specified `value` is in the range `[‐86399 .. 86399]`, and `false` otherwise.
|===


== Friends

[cols="1,4"]
|===
| Name| Description
| `xref:BloombergLP/baltzo/swap-01.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-07.adoc[`operator!=`]
| Return `true` if the specified `lhs` and `rhs` objects do not have the same value, and `false` otherwise. Two `LocalTimeDescriptor` objects do not have the same value if any of the corresponding values of their `utcOffsetInSeconds`, `dstInEffectFlag`, or `description` attributes are not the same.
| xref:BloombergLP/baltzo/operator_eq-00.adoc[`operator==`]
| Return `true` if the specified `lhs` and `rhs` objects have the same value, and `false` otherwise. Two `LocalTimeDescriptor` objects have the same value if all of the corresponding values of their `utcOffsetInSeconds`, `dstInEffectFlag`, and `description` attributes are the same.
|===


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