Component bdlat_formattingmode [Package bdlat]

Provide formatting mode constants. More...

Classes
struct	bdlat_FormattingMode
	scope for formatting mode constants More...

---

Detailed Description

Outline

• Purpose
• Classes
• Description
  • Original Type (Schema Type)
  • Formatting Flags
  • Usage

Purpose:

Provide formatting mode constants.

Classes:

bdlat_FormattingMode

scope for formatting mode constants

See also:

Component balxml_typesprintutil Component balxml_typesparserutil

Description:

The bdlat_FormattingMode struct provided in this component defines the symbolic constants for all the formatting modes supported by the bdlat framework. The formatting modes are separated into two categories: a bit-field for the original type (i.e., schema type), and a number of flags.

Original Type (Schema Type):

This bit-field defines the formatting modes that are derived based on the type of an element, as defined in the schema. The available modes are:

  Formatting Mode         Description
  ---------------         -----------
  e_DEFAULT               Use a default formatting mode.
  e_DEC                   Use the decimal format.
  e_HEX                   Use the hexadecimal format.
  e_BASE64                Use the base64 format.
  e_TEXT                  Use the text format.

Formatting Flags:

The following bitwise flags can be applied to a schema element:

  Formatting Mode         Description
  ---------------         -----------
  e_UNTAGGED              Use untagged formatting (for anonymous choices).
  e_ATTRIBUTE             Use attribute formatting (for XSD attributes).
  e_SIMPLE_CONTENT        Use simple content formatting (for XSD simple
                          content types).
  e_NILLABLE              Use nillable formatting (for XSD 'nillable'
                          option).
  e_LIST                  Use the list format (this is used for arrays).

Usage:

Due to the low-level nature of this component, a usage example is not necessary.