[#BloombergLP-bslfmt-FormatterSpecificationNumericValue]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bslfmt.adoc[bslfmt]::FormatterSpecificationNumericValue
:relfileprefix: ../../
:mrdocs:

Type holding a category plus an optional integral value. This is a value semantic type primarily used to represent width and precision of a format specification.

== Synopsis

Declared in `<bslfmt_formatterspecificationnumericvalue.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
struct FormatterSpecificationNumericValue;
----

== Enums

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslfmt/FormatterSpecificationNumericValue/Category-07.adoc[`Category`] 
| Categories for parsed numeric format‐specification values.
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslfmt/FormatterSpecificationNumericValue/2constructor-0b.adoc[`FormatterSpecificationNumericValue`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/bslfmt/FormatterSpecificationNumericValue/category-0e.adoc[`category`] 
| Return the `category` attribute of this object.
| xref:BloombergLP/bslfmt/FormatterSpecificationNumericValue/parse.adoc[`parse`] 
| Parse the string in the random‐access‐iterator range specified by `start` and `end` to extract either a hard‐coded integer or a nested argument specification. If the specified `needInitialDot` is true the string is only parsed if `*start == '.'` and a `format_error` exception is thrown if the string following the initial dot is empty. If an error occurs throw an exception of type `format_error`, otherwise update the output `start` iterator to point to the first unparsed character of the string and store the parsed result into this object.
| xref:BloombergLP/bslfmt/FormatterSpecificationNumericValue/postprocess.adoc[`postprocess`] 
| If this object holds a non‐dynamic nested value (i.e., `d_type` is `e_ARG_ID`) update its value using the arguments stored in the specified `context` and update the type to `e_VALUE`. If this object holds a dynamic nested value (i.e., `d_type` is `e_NEXT_ARG`) throw an exception of type `format_error`. Otherwise do nothing.
| xref:BloombergLP/bslfmt/FormatterSpecificationNumericValue/value.adoc[`value`] 
| Return the `value` attribute of this object. The behavior is undefined if `category` is either `e_DEFAULT` or `e_NEXT_ARG_ID`.
| xref:BloombergLP/bslfmt/FormatterSpecificationNumericValue/operator_eq.adoc[`operator==`] 
| Return `true` if this object is equal to the specified `other` object, otherwise return `false`. Two `FormatterSpecificationNumericValue` objects are considered equal if their `category` and `value` attributes are both equal.
|===


== Friends

[cols="1,4"]
|===
| Name| Description
| `xref:BloombergLP/bslfmt/FormatterSpecificationNumericValue_ArgVisitor.adoc[BloombergLP::bslfmt::FormatterSpecificationNumericValue_ArgVisitor]`
| Component‐private type to enable extraction of values held by format contexts during the postprocessing stage of determining the format specification (typically performed by the `FormatSpecificationParser`). This type exists so that `FormatSpecificationParser` can update FormatterSpecificationNumericValue to the value contained by a Standard `basic_format_arg` using the Standard `visit_format_arg` function.
|===


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