baltzo_dstpolicy.h

Go to the documentation of this file.

/// @file baltzo_dstpolicy.h
///
/// The content of this file has been pre-processed for Doxygen.
///
 
 
// baltzo_dstpolicy.h                                                 -*-C++-*-
#ifndef INCLUDED_BALTZO_DSTPOLICY
#define INCLUDED_BALTZO_DSTPOLICY
 
#include <bsls_ident.h>
BSLS_IDENT("$Id: $")
 
/// @defgroup baltzo_dstpolicy baltzo_dstpolicy
/// @brief  Enumerate the set of daylight-saving time (DST) policy values.
/// @addtogroup bal
/// @{
/// @addtogroup baltzo
/// @{
/// @addtogroup baltzo_dstpolicy
/// @{
///
/// <h1> Outline </h1>
/// * <a href="#baltzo_dstpolicy-purpose"> Purpose</a>
/// * <a href="#baltzo_dstpolicy-classes"> Classes </a>
/// * <a href="#baltzo_dstpolicy-description"> Description </a>
///   * <a href="#baltzo_dstpolicy-enumerators"> Enumerators </a>
///   * <a href="#baltzo_dstpolicy-usage"> Usage </a>
///     * <a href="#baltzo_dstpolicy-example-1-basic-syntax"> Example 1: Basic Syntax </a>
///
/// # Purpose {#baltzo_dstpolicy-purpose}
/// Enumerate the set of daylight-saving time (DST) policy values.
///
/// # Classes {#baltzo_dstpolicy-classes}
///
/// -  baltzo::DstPolicy: namespace for a daylight-saving time policy `enum`
///
/// @see  baltzo_localtimevalidity, baltzo_timezoneutil
///
/// # Description {#baltzo_dstpolicy-description}
/// This component provides a namespace for the `enum` type
/// `baltzo::DstPolicy::Enum`, which enumerates the set of policies for
/// interpreting whether an associated local time is a daylight-saving time
/// value.  A `baltzo::DstPolicy` is particularly important when interpreting a
/// local time that is not associated with a UTC offset (e.g., a
/// `bdlt::Datetime` object), as such a representation may be ambiguous or
/// invalid (see @ref baltzo_localtimevalidity ).
///
/// ## Enumerators {#baltzo_dstpolicy-enumerators}
///
///
/// @code
/// Name            Description
/// -------------   ---------------------------------------------------
/// e_DST           Local time is interpreted as daylight-saving time.
///
/// e_STANDARD      Local time is interpreted as standard time.
///
/// e_UNSPECIFIED   Local time is interpreted as either daylight-saving time or
///                 standard time (as appropriate).
/// @endcode
///
/// ## Usage {#baltzo_dstpolicy-usage}
///
///
/// This section illustrates intended use of this component.
///
/// ### Example 1: Basic Syntax {#baltzo_dstpolicy-example-1-basic-syntax}
///
///
/// The following snippets of code provide a simple illustration of using
/// `baltzo::DstPolicy`.
///
/// First, we create a variable `value` of type `baltzo::DstPolicy::Enum` and
/// initialize it with the enumerator value
/// `baltzo::DstPolicy::e_STANDARD`:
/// @code
/// baltzo::DstPolicy::Enum value = baltzo::DstPolicy::e_STANDARD;
/// @endcode
/// Now, we store the address of its ASCII representation in a pointer variable,
/// `asciiValue`, of type `const char *`:
/// @code
/// const char *asciiValue = baltzo::DstPolicy::toAscii(value);
/// assert(0 == bsl::strcmp(asciiValue, "STANDARD"));
/// @endcode
/// Finally, we print `value` to `bsl::cout`.
/// @code
/// bsl::cout << value << bsl::endl;
/// @endcode
/// This statement produces the following output on `stdout`:
/// @code
/// STANDARD
/// @endcode
/// @}
/** @} */
/** @} */
 
/** @addtogroup bal
 * @{
 */
/** @addtogroup baltzo
 * @{
 */
/** @addtogroup baltzo_dstpolicy
 * @{
 */
 
#include <balscm_version.h>
 
#include <bsl_iosfwd.h>
 
#ifndef BDE_OMIT_INTERNAL_DEPRECATED
#include <bsla_deprecated.h>
#endif
 
 
namespace baltzo {
                              // ================
                              // struct DstPolicy
                              // ================
 
/// This `struct` provides a namespace for enumerating the set of policies
/// for interpreting whether a local time is a daylight-saving time.  See
/// `Enum` in the TYPES sub-section for details.
///
/// This class:
/// * supports a complete set of *enumeration* operations
///   - except for `bdex` serialization
/// * is `const` *thread-safe*
/// For terminology see @ref bsldoc_glossary .
///
/// See @ref baltzo_dstpolicy 
struct DstPolicy {
 
  public:
    // TYPES
    enum Enum {
        e_DST,         // Local time is interpreted as daylight-saving
                       // time.
 
        e_STANDARD,    // Local time is interpreted as standard time.
 
        e_UNSPECIFIED  // Local time is interpreted as either
                       // daylight-saving time or standard time (as
                       // appropriate).
 
#ifndef BDE_OMIT_INTERNAL_DEPRECATED
      , BALTZO_DST         BSLA_DEPRECATED = e_DST
      , BALTZO_STANDARD    BSLA_DEPRECATED = e_STANDARD
      , BALTZO_UNSPECIFIED BSLA_DEPRECATED = e_UNSPECIFIED
      , BAETZO_DST         BSLA_DEPRECATED = e_DST
      , BAETZO_STANDARD    BSLA_DEPRECATED = e_STANDARD
      , BAETZO_UNSPECIFIED BSLA_DEPRECATED = e_UNSPECIFIED
#endif  // BDE_OMIT_INTERNAL_DEPRECATED
 
    };
 
  public:
    // CLASS METHODS
 
    /// Write the string representation of the specified enumeration `value`
    /// to the specified output `stream`, 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`).  See `toAscii` for
    /// what constitutes the string representation of a `DstPolicy::Enum`
    /// value.
    static bsl::ostream& print(bsl::ostream&   stream,
                               DstPolicy::Enum value,
                               int             level          = 0,
                               int             spacesPerLevel = 4);
 
    /// Return the non-modifiable string representation corresponding to the
    /// specified enumeration `value`, if it exists, and a unique (error)
    /// string otherwise.  The string representation of `value` matches its
    /// corresponding enumerator name with the "e_" prefix elided.  For
    /// example:
    /// @code
    /// bsl::cout << DstPolicy::toAscii(DstPolicy::e_STANDARD);
    /// @endcode
    /// will print the following on standard output:
    /// @code
    /// STANDARD
    /// @endcode 
    /// 
    /// \note Note that   specifying a `value` that does not match any of the
    /// enumerators will result in a string representation that is distinct
    /// from any of those corresponding to the enumerators, but is otherwise
    /// unspecified.
    static const char *toAscii(DstPolicy::Enum value);
};
 
// FREE OPERATORS
 
/// Write the string representation of the specified enumeration `value` to
/// the specified output `stream` in a single-line format, and return a
/// reference to `stream`.  See `toAscii` for what constitutes the string representation of a `baltzo::DstPolicy::Enum` value.  
/// 
/// \note Note that   this
/// method has the same behavior as
/// @code
/// baltzo::DstPolicy::print(stream, value, 0, -1);
/// @endcode
bsl::ostream& operator<<(bsl::ostream& stream, DstPolicy::Enum value);
 
}  // close package namespace
 
// ============================================================================
//                            INLINE DEFINITIONS
// ============================================================================
 
                              // ----------------
                              // struct DstPolicy
                              // ----------------
 
// FREE OPERATORS
inline
bsl::ostream& baltzo::operator<<(bsl::ostream& stream, DstPolicy::Enum value)
{
    return DstPolicy::print(stream, value, 0, -1);
}
 
 
 
#endif
 
// ----------------------------------------------------------------------------
// Copyright 2015 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 ----------------------------------
 
/** @} */
/** @} */
/** @} */