bdld.h

Go to the documentation of this file.

/// @file bdld.h
///
///
/// @defgroup bdld Package bdld
/// @brief  Basic Development Library Datum (bdld)
/// @addtogroup bdl
/// @{
/// @addtogroup bdld
/// @{
/// * <a href="#bdld-purpose"> Purpose</a>
/// * <a href="#bdld-mnemonic"> Mnemonic </a>
/// * <a href="#bdld-description"> Description </a>
///   * <a href="#bdld-hierarchical-synopsis"> Hierarchical Synopsis </a>
///   * <a href="#bdld-component-synopsis"> Component Synopsis </a>
///
/// # Purpose {#bdld-purpose}
/// Provide a variant type ('Datum') and supporting utilities.
///
/// # Mnemonic {#bdld-mnemonic}
/// Basic Development Library Datum (bdld)
///
/// # Description {#bdld-description}
/// The 'bdld' package defines in @ref bdld_datum  a type that can
/// contain an assortment of different value types, including user-defined types.
/// Other components provide utilities for assembling arrays and maps of 'Datum'
/// objects.
///
/// Note that 'bdld::Datum' has many features of value-semantic types (including
/// an 'operator=='), but is not a VST.  See @ref bdld_datum  component
/// documentation.
///
/// ## Hierarchical Synopsis {#bdld-hierarchical-synopsis}
///
/// The 'bdld' package currently has 11 components having 4 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
///  4. bdld_datummaker
///
///  3. bdld_datumarraybuilder
///     bdld_datumintmapbuilder
///     bdld_datummapbuilder
///     bdld_datummapowningkeysbuilder
///     bdld_datumutil
///     bdld_manageddatum
///
///  2. bdld_datum
///
///  1. bdld_datumbinaryref
///     bdld_datumerror
///     bdld_datumudt
/// @endcode
///
/// ## Component Synopsis {#bdld-component-synopsis}
///
///  @ref bdld_datum :
///       Provide a discriminated variant type with a small footprint.
/// 
///  @ref bdld_datumarraybuilder :
///       Provide a utility to build a `Datum` object holding an array.
/// 
///  @ref bdld_datumbinaryref :
///       Provide a type to represent binary data and its size.
/// 
///  @ref bdld_datumerror :
///       Provide a type for an error code with an optional error message.
/// 
///  @ref bdld_datumintmapbuilder :
///       Provide a utility to build a `Datum` object holding an int-map.
/// 
///  @ref bdld_datummaker :
///       Provide a mechanism for easily creating `bdld::Datum` objects.
/// 
///  @ref bdld_datummapbuilder :
///       Provide a utility to build a `Datum` object holding a map.
/// 
///  @ref bdld_datummapowningkeysbuilder :
///       Provide a utility to build a `Datum` object holding a map.
/// 
///  @ref bdld_datumudt :
///       Provide a type to represent a user-defined type.
/// 
///  @ref bdld_datumutil :
///       Provide extra functions that operate on `bdld::Datum` objects.
/// 
///  @ref bdld_manageddatum :
///       Provide a smart-pointer-like manager for a `Datum` object.
///
/// @}
/** @} */