bdlat.h

Go to the documentation of this file.

/// @file bdlat.h
///
///
/// @defgroup bdlat Package bdlat
/// @brief  Basic Development Library Attribute Types (bdlat)
/// @addtogroup bdl
/// @{
/// @addtogroup bdlat
/// [bdlat]: group__bdlat.html
/// @{
///
/// # Purpose {#bdlat-purpose}
/// Provide generic functions to manipulate attribute types
///
/// # Mnemonic {#bdlat-mnemonic}
/// Basic Development Library Attribute Types (bdlat)
///
/// # Description {#bdlat-description}
/// The 'bdlat' package provides generic functions to work with the
/// different concepts of attribute types.  These concepts group common behaviors
/// ("array", "choice", "enumeration", "nullable", "sequence", or "value type").
/// Once a type is made a model of one of these concepts, it can be used
/// seamlessly by generic code such as the xml/ber encoders and decoders.
/// Therefore, whenever a new type needs to be encodable, the codecs themselves do
/// not need to be modified, but the type just needs to implement the necessary
/// functions to expose the concept.
///
/// ## Hierarchical Synopsis
///
/// The 'bdlat' package currently has 20 components having 6 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
///  6. bdlat_arrayiterators
///     bdlat_symbolicconverter
///
///  5. bdlat_arrayutil
///     bdlat_nullablevalueutil
///     bdlat_valuetypefunctions
///
///  4. bdlat_enumutil
///     bdlat_typecategory
///
///  3. bdlat_arrayfunctions
///     bdlat_choicefunctions
///     bdlat_customizedtypefunctions
///     bdlat_enumfunctions
///     bdlat_sequencefunctions
///     bdlat_typename
///
///  2. bdlat_attributeinfo
///     bdlat_enumeratorinfo
///     bdlat_formattingmode
///     bdlat_nullablevaluefunctions
///     bdlat_selectioninfo
///     bdlat_typetraits
///
///  1. bdlat_bdeatoverrides
/// @endcode
///
/// ## Component Synopsis
///
///  @ref bdlat_arrayfunctions :
///       Provide a namespace defining "array" functions.
/// 
///  @ref bdlat_arrayiterators :
///       Provide iterator support for bdlat_ArrayFunction-conformant types.
/// 
///  @ref bdlat_arrayutil :
///       Provide utilities for operating on `bdlat` "array" types.
/// 
///  @ref bdlat_attributeinfo :
///       Provide a container for attribute information.
/// 
///  @ref bdlat_bdeatoverrides :
///       Provide macros to map `bdeat` names to `bdlat` names.
/// 
///  @ref bdlat_choicefunctions :
///       Provide a namespace defining choice functions.
/// 
///  @ref bdlat_customizedtypefunctions :
///       Provide a namespace defining customized type functions.
/// 
///  @ref bdlat_enumeratorinfo :
///       Provide a container for enumerator information.
/// 
///  @ref bdlat_enumfunctions :
///       Provide a namespace defining enumeration functions.
/// 
///  @ref bdlat_enumutil :
///       Provide functions for decoding enumerations with fallback values.
/// 
///  @ref bdlat_formattingmode :
///       Provide formatting mode constants.
/// 
///  @ref bdlat_nullablevaluefunctions :
///       Provide a namespace defining nullable value functions.
/// 
///  @ref bdlat_nullablevalueutil :
///       Provide utilities for operating on `bdlat` "nullable value" types.
/// 
///  @ref bdlat_selectioninfo :
///       Provide a container for selection information.
/// 
///  @ref bdlat_sequencefunctions :
///       Provide a namespace defining sequence functions.
/// 
///  @ref bdlat_symbolicconverter :
///       Provide a utility for convert types with matching member symbols.
/// 
///  @ref bdlat_typecategory :
///       Provide type category tags and a tag selection meta-function.
/// 
///  @ref bdlat_typename :
///       Provide string representations for data type names.
/// 
///  @ref bdlat_typetraits :
///       Provide compile-time traits for generated types.
/// 
///  @ref bdlat_valuetypefunctions :
///       Provide a namespace for "value type" functions.
///
/// @}
/** @} */