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

This complex‐constrained (value‐semantic) attribute class describes a range of time in which a particular local time description is in effect.

== Synopsis

Declared in `<baltzo_localtimeperiod.h>`

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

== Description

See the  section for information on the class attributes. Note that the class invariants are identically the constraints on the attributes.

== Type Aliases

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


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/baltzo/LocalTimePeriod/2constructor-00.adoc[`LocalTimePeriod`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/baltzo/LocalTimePeriod/2destructor.adoc[`~LocalTimePeriod`] [.small]#[destructor]#
| Destroy this object.
| xref:BloombergLP/baltzo/LocalTimePeriod/operator_assign-03.adoc[`operator=`] 
| Assignment operators
| xref:BloombergLP/baltzo/LocalTimePeriod/allocator.adoc[`allocator`] 
| Return `get_allocator().mechanism()`.
| xref:BloombergLP/baltzo/LocalTimePeriod/descriptor.adoc[`descriptor`] 
| Return a reference providing non‐modifiable access to the `descriptor` attribute of this object.
| xref:BloombergLP/baltzo/LocalTimePeriod/get_allocator.adoc[`get_allocator`] 
| Return the allocator used by this object to supply memory.
| xref:BloombergLP/baltzo/LocalTimePeriod/print.adoc[`print`] 
| Write the value of this object to the specified output `stream`.
| xref:BloombergLP/baltzo/LocalTimePeriod/setDescriptor.adoc[`setDescriptor`] 
| Set the `descriptor` attribute to the specified `value`.
| xref:BloombergLP/baltzo/LocalTimePeriod/setUtcStartAndEndTime.adoc[`setUtcStartAndEndTime`] 
| Use the specified `utcStartTime` and `utcEndTime` to set the corresponding attributes of this object.
| xref:BloombergLP/baltzo/LocalTimePeriod/swap.adoc[`swap`] 
| Efficiently exchange the value of this object with the value of the specified `other` object.
| xref:BloombergLP/baltzo/LocalTimePeriod/utcEndTime.adoc[`utcEndTime`] 
| Return a reference providing non‐modifiable access to the `utcEndTime` attribute of this object.
| xref:BloombergLP/baltzo/LocalTimePeriod/utcStartTime.adoc[`utcStartTime`] 
| Return a reference providing non‐modifiable access to the `utcStartTime` attribute of this object.
| xref:BloombergLP/baltzo/LocalTimePeriod/2conversion.adoc[`operator BloombergLP::bslmf::NestedTraitDeclaration<LocalTimePeriod, IsBitwiseMoveable>`] 
| Nested trait declaration for `bslma::UsesBslmaAllocator`.
|===


== Static Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/baltzo/LocalTimePeriod/isValidUtcStartAndEndTime.adoc[`isValidUtcStartAndEndTime`] 
| Return `true` if `utcStartTime` and `utcEndTime` form a valid range.
|===


== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/baltzo/operator_not_eq-05.adoc[`operator!=`]
| Return `true` if the specified `lhs` and `rhs` objects do not have the same value, and `false` otherwise.
| xref:BloombergLP/baltzo/operator_eq-06.adoc[`operator==`]
| Return `true` if the specified `lhs` and `rhs` objects have the same value, and `false` otherwise.
| xref:BloombergLP/baltzo/swap-0c.adoc[`swap`]
| Exchange the values of the specified `a` and `b` objects.
|===


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