[#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 (offset, DST status, and a descriptive string) is in effect. See the  section for information on the class attributes. Note that the class invariants are identically the constraints on the attributes.

== Synopsis

Declared in `<baltzo_localtimeperiod.h>`

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

== 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. Note that if no allocator was supplied at construction the default allocator in effect at construction is used.
| xref:BloombergLP/baltzo/LocalTimePeriod/print.adoc[`print`] 
| Write the value of this object to the specified output `stream` in a human‐readable format, and return a 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/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 `utcStartTime` and `utcEndTime` attributes of this object respectively. The behavior is undefined unless `utcStartTime == utcEndTime`, or if `utcStartTime` and `utcEndTime` are comparable (i.e., neither equals a default constructed `bdlt::DateTime` object) unless `utcStartTime < utcEndTime`. (See the `isValidUtcStartAndEndTime` method.)
| xref:BloombergLP/baltzo/LocalTimePeriod/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/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 the specified `utcStartTime` and `utcEndTime` have the same value, or if `utcStartTime` and `utcEndTime` are comparable (i.e., neither has the value of a default‐constructed `bdlt::DateTime` object) and `utcStartTime < utcEndTime`; return `false` otherwise.
|===


== 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. Two `LocalTimePeriod` objects do not have the same value if the corresponding values of their `descriptor`, `utcStartTime`, or `utcEndTime` attributes are not the same.
| xref:BloombergLP/baltzo/operator_eq-06.adoc[`operator==`]
| Return `true` if the specified `lhs` and `rhs` objects have the same value, and `false` otherwise. Two `LocalTimePeriod` objects have the same value if each of their corresponding `descriptor`, `utcStartTime`, and `utcEndTime` attributes have the same value.
| xref:BloombergLP/baltzo/swap-0c.adoc[`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.
|===


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