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

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

== Synopsis

Declared in `&lt;baltzo&lowbar;localtimedescriptor&period;h&gt;`

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

== Type Aliases

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


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/baltzo/LocalTimeDescriptor/2constructor-0b.adoc[`LocalTimeDescriptor`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/baltzo/LocalTimeDescriptor/2destructor.adoc[`&#126;LocalTimeDescriptor`] [.small]#[destructor]#
| Destroy this object&period;
| xref:BloombergLP/baltzo/LocalTimeDescriptor/operator_assign-0b.adoc[`operator&equals;`] 
| Assignment operators
| xref:BloombergLP/baltzo/LocalTimeDescriptor/allocator.adoc[`allocator`] 
| Return `get&lowbar;allocator()&period;mechanism()`&period;
| xref:BloombergLP/baltzo/LocalTimeDescriptor/description.adoc[`description`] 
| Return a `const` reference to the `description` attribute of this object&period; Note that `description` is not canonical, and is intended for debugging only&period;
| xref:BloombergLP/baltzo/LocalTimeDescriptor/dstInEffectFlag.adoc[`dstInEffectFlag`] 
| Return the value of the `dstInEffectFlag` attribute of this object&period; Note that `true` implies Daylight&hyphen;Saving Time (DST) is in effect&period;
| xref:BloombergLP/baltzo/LocalTimeDescriptor/get_allocator.adoc[`get&lowbar;allocator`] 
| Return the allocator used by this object to supply memory&period; Note that if no allocator was supplied at construction the default allocator in effect at construction is used&period;
| xref:BloombergLP/baltzo/LocalTimeDescriptor/print.adoc[`print`] 
| Write the value of this object to the specified output `stream` in a human&hyphen;readable format, and return a non&hyphen;`const` reference to `stream`&period; Optionally specify an initial indentation `level`, whose absolute value is incremented recursively for nested objects&period; 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&period; If `level` is negative, suppress indentation of the first line&period; If `spacesPerLevel` is negative, format the entire output on one line, suppressing all but the initial indentation (as governed by `level`)&period; If `stream` is not valid on entry, this operation has no effect&period; Note that the format is not fully specified, and can change without notice&period;
| xref:BloombergLP/baltzo/LocalTimeDescriptor/setDescription.adoc[`setDescription`] 
| Set the `description` attribute of this object to the specified `value`&period; Note that `value` is not canonical, and is intended for debugging only&period;
| xref:BloombergLP/baltzo/LocalTimeDescriptor/setDstInEffectFlag.adoc[`setDstInEffectFlag`] 
| Set the `dstInEffectFlag` attribute of this object to the specified `value`&period; Note that `true` implies Daylight&hyphen;Saving Time (DST) is in effect&period;
| xref:BloombergLP/baltzo/LocalTimeDescriptor/setUtcOffsetInSeconds.adoc[`setUtcOffsetInSeconds`] 
| Set the `utcOffsetInSeconds` attribute of this object to the specified `value`&period; The behavior is undefined unless `&hyphen;86399 &lt;&equals; value &lt;&equals; 86399`&period;
| xref:BloombergLP/baltzo/LocalTimeDescriptor/swap.adoc[`swap`] 
| Efficiently exchange the value of this object with the value of the specified `other` object&period; This method provides the no&hyphen;throw exception&hyphen;safety guarantee&period; The behavior is undefined unless this object was created with the same allocator as `other`&period;
| xref:BloombergLP/baltzo/LocalTimeDescriptor/utcOffsetInSeconds.adoc[`utcOffsetInSeconds`] 
| Return the value of the `utcOffsetInSeconds` attribute of this object&period; Note that this value is in the range `&lsqb;&hyphen;86399 &period;&period; 86399&rsqb;`&period;
| xref:BloombergLP/baltzo/LocalTimeDescriptor/2conversion.adoc[`operator BloombergLP::bslmf::NestedTraitDeclaration&lt;LocalTimeDescriptor, IsBitwiseMoveable&gt;`] 
| Nested trait declaration for `bslmf&colon;&colon;IsBitwiseMoveable`&period;
|===


== 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 `&lsqb;&hyphen;86399 &period;&period; 86399&rsqb;`, and `false` otherwise&period;
|===


== 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&period; This function provides the no&hyphen;throw exception&hyphen;safety guarantee if the two objects were created with the same allocator and the basic guarantee otherwise&period;
|===

== Non-Member Functions

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


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