bdlt_datetimeimputil.h

Go to the documentation of this file.

/// @file bdlt_datetimeimputil.h
///
/// The content of this file has been pre-processed for Doxygen.
///
 
 
// bdlt_datetimeimputil.h                                             -*-C++-*-
#ifndef INCLUDED_BDLT_DATETIMEIMPUTIL
#define INCLUDED_BDLT_DATETIMEIMPUTIL
 
#include <bsls_ident.h>
BSLS_IDENT("$Id: $")
 
/// @defgroup bdlt_datetimeimputil bdlt_datetimeimputil
/// @brief  Provide constants useful for encoding datetimes.
/// @addtogroup bdl
/// @{
/// @addtogroup bdlt
/// @{
/// @addtogroup bdlt_datetimeimputil
/// @{
///
/// <h1> Outline </h1>
/// * <a href="#bdlt_datetimeimputil-purpose"> Purpose</a>
/// * <a href="#bdlt_datetimeimputil-classes"> Classes </a>
/// * <a href="#bdlt_datetimeimputil-description"> Description </a>
///   * <a href="#bdlt_datetimeimputil-usage"> Usage </a>
///     * <a href="#bdlt_datetimeimputil-example-1-basic-syntax"> Example 1: Basic Syntax </a>
///
/// # Purpose {#bdlt_datetimeimputil-purpose}
/// Provide constants useful for encoding datetimes.
///
/// # Classes {#bdlt_datetimeimputil-classes}
///
/// -  bdlt::DatetimeImpUtil: namespace for datetime encoding constants
///
/// # Description {#bdlt_datetimeimputil-description}
/// This component implements a utility `struct`,
/// `bdlt::DatetimeImpUtil`, that defines a namespace for obtaining constants
/// and `bdlt::Datetime *` to constant values that are useful to encoding
/// datetimes at static-initilaization time.  The assumptions for this encoding
/// are that a collection of unset values, one per day over the valid range of
/// `bdlt::Date`, are encoded in the lowest values, and then microsecond
/// resolution over the entire `bdlt::Date` range.
///
/// ## Usage {#bdlt_datetimeimputil-usage}
///
///
/// This section illustrates intended use of this component.
///
/// ### Example 1: Basic Syntax {#bdlt_datetimeimputil-example-1-basic-syntax}
///
///
/// To obtain the `bdlt::Datetime` internal value for 0001/01/01 at
/// static-initialization time:
/// @code
/// static const bdlt::Datetime *firstDatetime =
///                                  bdlt::DatetimeImpUtil::epoch_0001_01_01();
///
/// assert(reinterpret_cast<const bdlt::Datetime *>(
///              &bdlt::DatetimeImpUtil::k_0001_01_01_VALUE) == firstDatetime);
/// @endcode
/// @}
/** @} */
/** @} */
 
/** @addtogroup bdl
 * @{
 */
/** @addtogroup bdlt
 * @{
 */
/** @addtogroup bdlt_datetimeimputil
 * @{
 */
 
#include <bdlscm_version.h>
 
#include <bsls_types.h>
 
 
namespace bdlt {
 
class Datetime;
 
                          // ======================
                          // struct DatetimeImpUtil
                          // ======================
 
/// This `struct` provides a namespace for datetime encoding constants.
///
/// See @ref bdlt_datetimeimputil 
struct DatetimeImpUtil {
 
    // CLASS DATA
    static const bsls::Types::Uint64 k_0001_01_01_VALUE;
    static const bsls::Types::Uint64 k_1970_01_01_VALUE;
    static const bsls::Types::Uint64 k_MAX_VALUE;
 
    // CLASS METHODS
 
    /// Return a pointer to a `bdlt::Datetime` with value
    /// `bdlt::Datetime(1, 1, 1)` suitable for use during static
    /// initialization.
    static const Datetime *epoch_0001_01_01();
 
    /// Return a pointer to a `bdlt::Datetime` with value
    /// `bdlt::Datetime(1970, 1, 1)` suitable for use during static
    /// initialization.
    static const Datetime *epoch_1970_01_01();
 
    /// Return a pointer to a `bdlt::Datetime` with value
    /// `bdlt::Datetime(9999, 12, 31, 24)` suitable for use during static
    /// initialization.
    static const Datetime *epoch_max();
};
 
}  // close package namespace
 
 
#endif
 
// ----------------------------------------------------------------------------
// Copyright 2016 Bloomberg Finance L.P.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// ----------------------------- END-OF-FILE ----------------------------------
 
/** @} */
/** @} */
/** @} */