Engine for decoding value‐semantic objects in XML format. 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.

Synopsis

Declared in <balxml_decoder.h>

class Decoder;

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 the modifiable error‐reporting structure associated with this decoder (i.e., the errInfo pointer provided at construction). The value stored in the error structure is reset to indicate no error on a successful call to open.

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 a string containing any error, warning, or trace messages that were logged during the last call to the decode method. The log is reset each time decode is called.

numUnknownElementsSkipped

Return the number of unknown elements that were skipped during the previous decoding operation. Note that unknown elements are skipped only if true == options()‐>skipUnknownElements().

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).

setNumUnknownElementsSkipped

Set the number of unknown elements skipped by the decoder during the current decoding operation to the specified value. The behavior is undefined unless 0 <= value.

warningCount

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

warningStream

Return pointer to the warning stream.

Friends

Name

Description

BloombergLP::balxml::Decoder_ParseObject

COMPONENT‐PRIVATE CLASS. DO NOT USE OUTSIDE OF THIS COMPONENT.

BloombergLP::balxml::Decoder_ErrorLogger

COMPONENT‐PRIVATE CLASS. DO NOT USE OUTSIDE OF THIS COMPONENT.

BloombergLP::balxml::Decoder_decodeImpProxy

COMPONENT‐PRIVATE CLASS. DO NOT USE OUTSIDE OF THIS COMPONENT.

BloombergLP::balxml::Decoder_ElementContext

COMPONENT‐PRIVATE CLASS. DO NOT USE OUTSIDE OF THIS COMPONENT.

Created with MrDocs