balber.h

Go to the documentation of this file.

/// @file balber.h
///
///
/// @defgroup balber Package balber
/// @brief  Basic Application Library BER (balber)
/// @addtogroup bal
/// @{
/// @addtogroup balber
/// [balber]: group__balber.html
/// @{
///
/// # Purpose {#balber-purpose}
/// Provide encoding/decoding of data per the (binary) BER rules.
///
/// # Mnemonic {#balber-mnemonic}
/// Basic Application Library BER (balber)
///
/// # Description {#balber-description}
/// The 'balber' ("Basic Application BER") package defines classes
/// that can encode and decode data per the X.690 BER (Basic Encoding Rules)
/// specification.  These classes can be used only for types supported by the
/// 'bdlat' framework.  Typical usage is illustrated in
/// {@ref balber_berdecoder |Example 1: Decoding an Employee Record} and
/// {@ref balber_berencoder |Example 1: Encoding an Employee Record}.
///
/// ## Hierarchical Synopsis
///
/// The 'balber' package currently has 7 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. balber_berdecoder
///
///  3. balber_berencoder
///
///  2. balber_beruniversaltagnumber
///     balber_berutil
///
///  1. balber_berconstants
///     balber_berdecoderoptions
///     balber_berencoderoptions
/// @endcode
///
/// ## Component Synopsis
///
///  @ref balber_berconstants :
///       Provide namespace for BER-related constants.
/// 
///  @ref balber_berdecoder :
///       Provide a BER decoder class.
/// 
///  @ref balber_berdecoderoptions :
///       Provide an attribute class for specifying BER decoding options.
/// 
///  @ref balber_berencoder :
///       Provide a BER encoder class.
/// 
///  @ref balber_berencoderoptions :
///       Provide value-semantic attribute classes
/// 
///  @ref balber_beruniversaltagnumber :
///       Enumerate the set of BER universal tag numbers.
/// 
///  @ref balber_berutil :
///       Provide functions to encode and decode simple types in BER format.
///
/// @}
/** @} */