Options for performing XML encodings. Encoding style is either COMPACT or PRETTY. If encoding style is COMPACT, no whitespace will be added between elements. If encoding style is PRETTY, then the InitialIndentLevel, SpacesPerLevel, and WrapColumn parameters are used to specify the formatting of the output. Note that InitialIndentLevel, SpacesPerLevel, and WrapColumn are ignored when EncodingStyle is COMPACT (this is the default). 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_encoderoptions.h>

class EncoderOptions;

Enums

Name

Description

Unnamed enum

Attribute identifiers 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

EncoderOptions [constructor]

Constructors

~EncoderOptions [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).

allowControlCharacters

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

datetimeFractionalSecondPrecision

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

encodingStyle

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

formattingMode

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

initialIndentLevel

Return the value of the "InitialIndentLevel" 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).

maxDecimalFractionDigits

Return a reference offering non‐modifiable access to the "MaxDecimalFractionDigits" attribute of this object.

maxDecimalTotalDigits

Return a reference offering non‐modifiable access to the "MaxDecimalTotalDigits" attribute of this object.

objectNamespace

Return a reference offering non‐modifiable access to the "ObjectNamespace" attribute of this object.

outputXMLHeader

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

outputXSIAlias

Return the value of the "OutputXSIAlias" 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).

schemaLocation

Return a reference offering non‐modifiable access to the "SchemaLocation" attribute of this object.

setAllowControlCharacters

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

setDatetimeFractionalSecondPrecision

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

setEncodingStyle

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

setFormattingMode

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

setInitialIndentLevel

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

setMaxDecimalFractionDigits

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

setMaxDecimalTotalDigits

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

setObjectNamespace

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

setOutputXMLHeader

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

setOutputXSIAlias

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

setSchemaLocation

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

setSignificantDoubleDigits

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

setSpacesPerLevel

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

setTag

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

setUseZAbbreviationForUtc

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

setWrapColumn

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

significantDoubleDigits

Return a reference offering non‐modifiable access to the "SignificantDoubleDigits" attribute of this object.

spacesPerLevel

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

tag

Return a reference offering non‐modifiable access to the "Tag" attribute of this object.

useZAbbreviationForUtc

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

wrapColumn

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

Static Member Functions

Name

Description

lookupAttributeInfo

lookupAttributeInfo overloads

Static Data Members

Name

Description

ATTRIBUTE_INFO_ARRAY

Attribute metadata array used by bdlat attribute lookup for this type.

CLASS_NAME

Name of this class for use in XML serialization.

DEFAULT_INITIALIZER_ALLOW_CONTROL_CHARACTERS

Default initial value for allowControlCharacters.

DEFAULT_INITIALIZER_DATETIME_FRACTIONAL_SECOND_PRECISION

Default initial value for dateTimeFractionalSecondPrecision.

DEFAULT_INITIALIZER_ENCODING_STYLE

Default initial value for encodingStyle.

DEFAULT_INITIALIZER_FORMATTING_MODE

Default initial value for formattingMode.

DEFAULT_INITIALIZER_INITIAL_INDENT_LEVEL

Default initial value for initialIndentLevel.

DEFAULT_INITIALIZER_OUTPUT_X_M_L_HEADER

Default initial value for outputXMLHeader (true).

DEFAULT_INITIALIZER_OUTPUT_X_S_I_ALIAS

Default initial value for outputXSIAlias.

DEFAULT_INITIALIZER_SPACES_PER_LEVEL

Default initial value for spacesPerLevel.

DEFAULT_INITIALIZER_USE_Z_ABBREVIATION_FOR_UTC

Default initial value for useZAbbreviationForUtc.

DEFAULT_INITIALIZER_WRAP_COLUMN

Default initial value for wrapColumn.

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