bdlt_serialdateimputil.h

Go to the documentation of this file.

/// @file bdlt_serialdateimputil.h
///
/// The content of this file has been pre-processed for Doxygen.
///
 
 
// bdlt_serialdateimputil.h                                           -*-C++-*-
#ifndef INCLUDED_BDLT_SERIALDATEIMPUTIL
#define INCLUDED_BDLT_SERIALDATEIMPUTIL
 
#include <bsls_ident.h>
BSLS_IDENT("$Id: $")
 
/// @defgroup bdlt_serialdateimputil bdlt_serialdateimputil
/// @brief  Provide low-level support functions for date-value manipulation.
/// @addtogroup bdl
/// @{
/// @addtogroup bdlt
/// @{
/// @addtogroup bdlt_serialdateimputil
/// @{
///
/// <h1> Outline </h1>
/// * <a href="#bdlt_serialdateimputil-purpose"> Purpose</a>
/// * <a href="#bdlt_serialdateimputil-classes"> Classes </a>
/// * <a href="#bdlt_serialdateimputil-description"> Description </a>
///
/// # Purpose {#bdlt_serialdateimputil-purpose}
/// Provide low-level support functions for date-value manipulation.
///
/// # Classes {#bdlt_serialdateimputil-classes}
///
/// - bdlt::SerialDateImpUtil: suite of low-level date-related stateless functions
///
/// @see  bdlt_posixdateimputil, bdlt_prolepticdateimputil
///
/// # Description {#bdlt_serialdateimputil-description}
/// This component defines a `typedef` to a class that implements
/// the (documentation-only) protocol for serial date implementation utilities
/// -- each class implements a common set of methods, each having the same
/// signature, and each having the same contract.  Currently, two
/// implementations are allowed: @ref bdlt_posixdateimputil  (required in Bloomberg
/// code) and @ref bdlt_prolepticdateimputil  (an option for open source code).
/// @}
/** @} */
/** @} */
 
/** @addtogroup bdl
 * @{
 */
/** @addtogroup bdlt
 * @{
 */
/** @addtogroup bdlt_serialdateimputil
 * @{
 */
 
#include <bdlscm_version.h>
 
#ifndef BDE_OPENSOURCE_PUBLICATION
    #ifdef BDE_USE_PROLEPTIC_DATES
    #error 'BDE_USE_PROLEPTIC_DATES' option disallowed for Bloomberg code.
    #endif
#endif
 
#ifdef BDE_USE_PROLEPTIC_DATES
#include <bdlt_prolepticdateimputil.h>
#else
#include <bdlt_posixdateimputil.h>
#endif
 
 
namespace bdlt {
 
                           // ========================
                           // struct SerialDateImpUtil
                           // ========================
 
#ifdef BDE_USE_PROLEPTIC_DATES
    typedef ProlepticDateImpUtil SerialDateImpUtil;
#else
    typedef     PosixDateImpUtil SerialDateImpUtil;
 
    /// @deprecated  typedef to temporarily support residual uses of
    /// `DelegatingDateImpUtil`.
    typedef     PosixDateImpUtil DelegatingDateImpUtil;
#endif
 
// ============================================================================
//                              INLINE DEFINITIONS
// ============================================================================
 
 
}  // close package namespace
 
 
#endif
 
// ----------------------------------------------------------------------------
// Copyright 2014 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 ----------------------------------
 
/** @} */
/** @} */
/** @} */