[#BloombergLP-bdldfp-DecimalFormatConfig]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdldfp.adoc[bdldfp]::DecimalFormatConfig
:relfileprefix: ../../
:mrdocs:

This attribute class characterizes how to configure certain behavior of `bdldfp::DecimalUtil::format` functions.

== Synopsis

Declared in `<bdldfp_decimalformatconfig.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class DecimalFormatConfig;
----

== Enums

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdldfp/DecimalFormatConfig/Sign-0a.adoc[`Sign`] 
| Sign characters used when formatting decimal values.
| xref:BloombergLP/bdldfp/DecimalFormatConfig/Style-06.adoc[`Style`] 
| Output style used when formatting decimal values.
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdldfp/DecimalFormatConfig/2constructor-0c.adoc[`DecimalFormatConfig`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/bdldfp/DecimalFormatConfig/decimalPoint.adoc[`decimalPoint`] 
| Return point character.
| xref:BloombergLP/bdldfp/DecimalFormatConfig/expWidth.adoc[`expWidth`] 
| Return the minimum exponent width.
| xref:BloombergLP/bdldfp/DecimalFormatConfig/exponent.adoc[`exponent`] 
| Return exponent character.
| xref:BloombergLP/bdldfp/DecimalFormatConfig/infinity.adoc[`infinity`] 
| Return infinity string representation.
| xref:BloombergLP/bdldfp/DecimalFormatConfig/nan.adoc[`nan`] 
| Return NaN string representation.
| xref:BloombergLP/bdldfp/DecimalFormatConfig/precision.adoc[`precision`] 
| Return the number of digits of precision in the outputs.
| xref:BloombergLP/bdldfp/DecimalFormatConfig/sNan.adoc[`sNan`] 
| Return sNaN string representation.
| xref:BloombergLP/bdldfp/DecimalFormatConfig/setDecimalPoint.adoc[`setDecimalPoint`] 
| Set the `point` attribute of this object to the specified `value`.
| xref:BloombergLP/bdldfp/DecimalFormatConfig/setExpWidth.adoc[`setExpWidth`] 
| Set the `expwidth` attribute of this object to the specified `value`. The behavior is undefined unless `value` is 1, 2, 3, or 4.
| xref:BloombergLP/bdldfp/DecimalFormatConfig/setExponent.adoc[`setExponent`] 
| Set the `exponent` attribute of this object to the specified `value`.
| xref:BloombergLP/bdldfp/DecimalFormatConfig/setInfinity.adoc[`setInfinity`] 
| Set the `infinity` attribute of this object to the specified `value`. The behavior is undefined unless the pointer to the `value` remains valid for the lifetime of this object.
| xref:BloombergLP/bdldfp/DecimalFormatConfig/setNan.adoc[`setNan`] 
| Set the `nan` attribute of this object to the specified `value`. The behavior is undefined unless the pointer to the `value` remains valid for the lifetime of this object.
| xref:BloombergLP/bdldfp/DecimalFormatConfig/setPrecision.adoc[`setPrecision`] 
| Set the `precision` attribute of this object to the specified `value`. Behavior is undefined unless `value >= ‐1`.
| xref:BloombergLP/bdldfp/DecimalFormatConfig/setSNan.adoc[`setSNan`] 
| Set the `snan` attribute of this object to the specified `value`. The behavior is undefined unless the pointer to the `value` remains valid for the lifetime of this object.
| xref:BloombergLP/bdldfp/DecimalFormatConfig/setShowpoint.adoc[`setShowpoint`] 
| Set the `showpoint` attribute of this object to the specified `value`.
| xref:BloombergLP/bdldfp/DecimalFormatConfig/setSign.adoc[`setSign`] 
| Set the `sign` attribute of this object to the specified `value`.
| xref:BloombergLP/bdldfp/DecimalFormatConfig/setStyle.adoc[`setStyle`] 
| Set the `style` attribute of this object to the specified `value`.
| xref:BloombergLP/bdldfp/DecimalFormatConfig/showpoint.adoc[`showpoint`] 
| Return the `showpoint` attribute.
| xref:BloombergLP/bdldfp/DecimalFormatConfig/sign-09.adoc[`sign`] 
| Return the sign attribute.
| xref:BloombergLP/bdldfp/DecimalFormatConfig/style-00.adoc[`style`] 
| Return the style of output format.
|===


== Friends

[cols="1,4"]
|===
| Name| Description
| `xref:BloombergLP/bdldfp/operator_not_eq-0f.adoc[BloombergLP::bdldfp::operator!=]`
| Return `true` if the specified `lhs` and `rhs` objects do not have the same value, and `false` otherwise. Two `DecimalFormatConfig` objects do not have the same value if any of their attributes (respectively) do not have the same value. Note that comparison of two string type attributes are done via 'bsl::strcmp() function.
| `xref:BloombergLP/bdldfp/operator_eq-0b5.adoc[BloombergLP::bdldfp::operator==]`
| Return `true` if the specified `lhs` and `rhs` objects have the same value, and `false` otherwise. Two `DecimalFormatConfig` objects have the same value if each of their attributes (respectively) have the same value. Note that comparison of two string type attributes are done via 'bsl::strcmp() function.
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#