Options for controlling the XML decoding process. The generated C++ code for this schema element is created by using bas_codegen.pl, run by balxml/code_from_xsd.pl with no hand‐editing.

Synopsis

Declared in <balxml_decoderoptions.h>

class DecoderOptions;

Enums

Name

Description

Unnamed enum

Attribute ids used by bdlat attribute lookup for this type.

Unnamed enum

The number of attributes in this type.

Unnamed enum

Attribute indices used by bdlat attribute lookup for this type.

Member Functions

Name

Description

DecoderOptions [constructor]

Constructors

~DecoderOptions [destructor]

Destroy this object.

operator=

Assignment operators

accessAttribute

accessAttribute overloads

accessAttributes

Invoke the specified accessor sequentially on each (non‐modifiable) attribute of this object, supplying accessor with the corresponding attribute information structure until such invocation returns a non‐zero value. Return the value from the last invocation of accessor (i.e., the invocation that terminated the sequence).

formattingMode

Return the value of the "FormattingMode" attribute of this object.

manipulateAttribute

manipulateAttribute overloads

manipulateAttributes

Invoke the specified manipulator sequentially on the address of each (modifiable) attribute of this object, supplying manipulator with the corresponding attribute information structure until such invocation returns a non‐zero value. Return the value from the last invocation of manipulator (i.e., the invocation that terminated the sequence).

maxDepth

Return the value of the "MaxDepth" attribute of this object.

print

Format this object to the specified output stream at the optionally specified indentation level and return a reference to the modifiable stream. If level is specified, optionally specify spacesPerLevel, the number of spaces per indentation level for this and all of its nested objects. Each line is indented by the absolute value of level * spacesPerLevel. If level is negative, suppress indentation of the first line. If spacesPerLevel is negative, suppress line breaks and format the entire output on one line. If stream is initially invalid, this operation has no effect. Note that a trailing newline is provided in multiline mode only.

reset

Reset this object to the default value (i.e., its value upon default construction).

setFormattingMode

Set the "FormattingMode" attribute of this object to the specified value.

setMaxDepth

Set the "MaxDepth" attribute of this object to the specified value.

setSkipUnknownElements

Set the "SkipUnknownElements" attribute of this object to the specified value.

setValidateInputIsUtf8

Set the "ValidateInputIsUtf8" attribute of this object to the specified value.

setValidateRootTag

Set the "ValidateRootTag" attribute of this object to the specified value.

skipUnknownElements

Return the value of the "SkipUnknownElements" attribute of this object.

validateInputIsUtf8

Return the value of the "ValidateInputIsUtf8" attribute of this object.

validateRootTag

Return the value of the "ValidateRootTag" attribute of this object.

Static Member Functions

Name

Description

lookupAttributeInfo

lookupAttributeInfo overloads

Static Data Members

Name

Description

ATTRIBUTE_INFO_ARRAY

Attribute metadata array for bdlat serialization of this type.

CLASS_NAME

Name of this class for use in XML serialization.

DEFAULT_INITIALIZER_FORMATTING_MODE

Default initial value for formattingMode (0).

DEFAULT_INITIALIZER_MAX_DEPTH

Default initial value for maxDepth (512).

DEFAULT_INITIALIZER_SKIP_UNKNOWN_ELEMENTS

Default initial value for skipUnknownElements.

DEFAULT_INITIALIZER_VALIDATE_INPUT_IS_UTF8

Default initial value for validateInputIsUtf8.

DEFAULT_INITIALIZER_VALIDATE_ROOT_TAG

Default initial value for validateRootTag.

Non-Member Functions

Name

Description

operator!=

Return true if the specified lhs and rhs attribute objects do not have the same value, and false otherwise. Two attribute objects do not have the same value if one or more respective attributes differ in values.

operator==

Return true if the specified lhs and rhs attribute objects have the same value, and false otherwise. Two attribute objects have the same value if each respective attribute has the same value.

Created with MrDocs