BloombergLP::balxml::Decoder

Engine for decoding value‐semantic objects in XML format.

Synopsis

Declared in <balxml_decoder.h>

class Decoder;

Description

The decode methods are function templates that will decode any object that meets the requirements of a sequence or choice object as defined in the bdlat_sequencefunctions and bdlat_choicefunctions components. These generic frameworks provide a common compile‐time interface for manipulating struct‐like and union‐like objects.

Member Functions

Name

Description

Decoder [constructor]

Constructors

~Decoder [destructor]

Call close and destroy this object.

close

Put the associated Reader object (i.e., the reader specified at construction) into a closed state.

decode

decode overloads

decodeAny

decodeAny overloads

errorCount

Return the number of errors that occurred during decoding. This number is reset to zero on a call to open.

errorInfo

Return a pointer to this decoder's error‐reporting structure.

errorSeverity

Return the severity of the most severe warning or error encountered during the last call to the decode method. The severity is reset each time decode is called.

errorStream

Return pointer to the error stream.

loggedMessages

Return logged error, warning, and trace messages from the last decode.

numUnknownElementsSkipped

Return the number of unknown elements skipped during the last decode.

open

open overloads

options

Return a pointer to the non‐modifiable decoder options provided at construction.

reader

Return the a pointer to the modifiable reader associated with this decoder (i.e., the reader pointer provided at construction).