baltzo.h

Go to the documentation of this file.

/// @file baltzo.h
///
///
/// @defgroup baltzo Package baltzo
/// @brief  Basic Application Library TimeZone (Olson) (baltzo)
/// @addtogroup bal
/// @{
/// @addtogroup baltzo
/// @{
/// * <a href="#baltzo-purpose"> Purpose</a>
/// * <a href="#baltzo-mnemonic"> Mnemonic </a>
/// * <a href="#baltzo-description"> Description </a>
///   * <a href="#baltzo-hierarchical-synopsis"> Hierarchical Synopsis </a>
///   * <a href="#baltzo-component-synopsis"> Component Synopsis </a>
///
/// # Purpose {#baltzo-purpose}
/// Provide timezone data for use with timezone-enabled vocabulary types.
///
/// # Mnemonic {#baltzo-mnemonic}
/// Basic Application Library TimeZone (Olson) (baltzo)
///
/// # Description {#baltzo-description}
/// The 'baltzo' package provides facilities to convert a local time
/// representation for one time zone into a local time representation for another
/// time zone.  Local time zone representations can be any of several time
/// vocabulary types (e.g., 'balt_LocalDatetime', 'bdlt_Datetime').  Time zones
/// are here specified using *time* *zone* *identifiers* (e.g.,
/// "America/New_York", "America/Indiana/Indianapolis", "Europe/Rome",
/// "Pacific/Honolulu").
///
/// The @ref baltzo_timezoneutil  component provides functions that, given a time
/// zone identifier, can provide information about the timezone, can initialize
/// various datetime objects (e.g., 'baltzo::LocalDatetime', 'bdlt::Datetime',
/// 'bdlt::DatetimeTz), and can convert between local datetime values and UTC
/// values.  These functions address the most common usage scenarios.
///
/// ## Hierarchical Synopsis {#baltzo-hierarchical-synopsis}
///
/// The 'baltzo' package currently has 19 components having 8 levels of physical
/// dependency.  The list below shows the hierarchical ordering of the components.
/// The order of components within each level is not architecturally significant,
/// just alphabetical.
/// @code
///  8. baltzo_localtimeoffsetutil
///     baltzo_windowstimezoneutil
///
///  7. baltzo_timezoneutil
///
///  6. baltzo_timezoneutilimp
///
///  5. baltzo_defaultzoneinfocache
///
///  4. baltzo_datafileloader
///     baltzo_testloader
///     baltzo_zoneinfocache
///
///  3. baltzo_loader
///     baltzo_zoneinfobinaryreader
///     baltzo_zoneinfoutil
///
///  2. baltzo_localtimeperiod
///     baltzo_zoneinfo
///
///  1. baltzo_dstpolicy
///     baltzo_errorcode
///     baltzo_localdatetime
///     baltzo_localtimedescriptor
///     baltzo_localtimevalidity
///     baltzo_zoneinfobinaryheader
/// @endcode
///
/// ## Component Synopsis {#baltzo-component-synopsis}
///
///  @ref baltzo_datafileloader :
///       Provide a concrete `baltzo::Loader` for Zoneinfo binary files.
/// 
///  @ref baltzo_defaultzoneinfocache :
///       Provide facilities to manage a default Zoneinfo cache object.
/// 
///  @ref baltzo_dstpolicy :
///       Enumerate the set of daylight-saving time (DST) policy values.
/// 
///  @ref baltzo_errorcode :
///       Enumerate the set of named errors for the `baltzo` package.
/// 
///  @ref baltzo_loader :
///       Provide a protocol for obtaining information about a time zone.
/// 
///  @ref baltzo_localdatetime :
///       Provide an attribute class for time-zone-aware datetime values.
/// 
///  @ref baltzo_localtimedescriptor :
///       Provide an attribute class for characterizing local time values.
/// 
///  @ref baltzo_localtimeoffsetutil :
///       Provide utilities for a @ref bdlt_localtimeoffset  local time callback.
/// 
///  @ref baltzo_localtimeperiod :
///       Provide a type describing local time over a time period.
/// 
///  @ref baltzo_localtimevalidity :
///       Enumerate the set of local time validity codes.
/// 
///  @ref baltzo_testloader :
///       Provide a test implementation of the `baltzo::Loader` protocol.
/// 
///  @ref baltzo_timezoneutil :
///       Provide utilities for converting times among different time zones.
/// 
///  @ref baltzo_timezoneutilimp :
///       Implement utilities for converting times between time zones.
/// 
///  @ref baltzo_windowstimezoneutil :
///       Provide utilities to map Zoneinfo identifiers to other systems.
/// 
///  @ref baltzo_zoneinfo :
///       Provide a value type to represent a time zone.
/// 
///  @ref baltzo_zoneinfobinaryheader :
///       Provide an attribute class for Zoneinfo binary-file header data.
/// 
///  @ref baltzo_zoneinfobinaryreader :
///       Provide utilities for reading the Zoneinfo binary data format.
/// 
///  @ref baltzo_zoneinfocache :
///       Provide a cache for time-zone information.
/// 
///  @ref baltzo_zoneinfoutil :
///       Provide utility operations on `baltzo::Zoneinfo` objects.
///
/// @}
/** @} */