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

This class is a generator that provides a set of formatting specifications obtained by exhaustive search of all combinations of standard options. Its use allows easy and thorough testing of formatters for standard types. The generator is a state machine, each state of which corresponds to a separate specification.

== Synopsis

Declared in `<bslfmt_testspecificationgenerator.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<class t_CHAR>
class TestSpecificationGenerator;
----

== Enums

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslfmt/TestSpecificationGenerator/Alignment-06.adoc[`Alignment`] 
| Alignment option values corresponding to format alignment characters.
| xref:BloombergLP/bslfmt/TestSpecificationGenerator/FormatType.adoc[`FormatType`] 
| Format presentation types corresponding to standard format type chars.
| xref:BloombergLP/bslfmt/TestSpecificationGenerator/NestedVariant.adoc[`NestedVariant`] 
| Nested width or precision argument‐id variants.
| xref:BloombergLP/bslfmt/TestSpecificationGenerator/Sign-0c.adoc[`Sign`] 
| Sign option values corresponding to format sign characters.
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslfmt/TestSpecificationGenerator/2constructor.adoc[`TestSpecificationGenerator`]         [.small]#[constructor]#
| Create a generator object. Optionally specify the `basicAllocator` to supply memory.
| xref:BloombergLP/bslfmt/TestSpecificationGenerator/addFillCharacter.adoc[`addFillCharacter`] 
| Add the specified `character` to the set of fill characters. Note that generated instructions will contain the `character` only if this function is called before the `setup` method invocation.
| xref:BloombergLP/bslfmt/TestSpecificationGenerator/addPrecision.adoc[`addPrecision`] 
| Add the specified `precision` to the set of precision values. Note that generated instructions will contain the `precision` only if this function is called before the `setup` method invocation.
| xref:BloombergLP/bslfmt/TestSpecificationGenerator/addWidth.adoc[`addWidth`] 
| Add the specified `width` to the set of width values. Note that generated instructions will contain the `width` only if this function is called before the `setup` method invocation.
| xref:BloombergLP/bslfmt/TestSpecificationGenerator/alignment-0d.adoc[`alignment`] 
| Return the current alignment type.
| xref:BloombergLP/bslfmt/TestSpecificationGenerator/fillCharacter.adoc[`fillCharacter`] 
| Return the current fill character.
| xref:BloombergLP/bslfmt/TestSpecificationGenerator/formatSpec.adoc[`formatSpec`] 
| Return the specification for the formatters `format` method based on the current state of this object.
| xref:BloombergLP/bslfmt/TestSpecificationGenerator/isAlignOptionPresent.adoc[`isAlignOptionPresent`] 
| Return `true` if the align option is present in the current state of this object, and `false` otherwise.
| xref:BloombergLP/bslfmt/TestSpecificationGenerator/isFillCharacterPresent.adoc[`isFillCharacterPresent`] 
| Return `true` if the value id option is present in the current state of this object, and `false` otherwise.
| xref:BloombergLP/bslfmt/TestSpecificationGenerator/isHashOptionPresent.adoc[`isHashOptionPresent`] 
| Return `true` if the alternative form option is present in the current state of this object, and `false` otherwise.
| xref:BloombergLP/bslfmt/TestSpecificationGenerator/isLocaleOptionPresent.adoc[`isLocaleOptionPresent`] 
| Return `true` if the locale option is present in the current state of this object, and `false` otherwise.
| xref:BloombergLP/bslfmt/TestSpecificationGenerator/isNestedPrecisionPresent.adoc[`isNestedPrecisionPresent`] 
| Return `true` if the nested precision option is present in the current state of this object, and `false` otherwise.
| xref:BloombergLP/bslfmt/TestSpecificationGenerator/isNestedWidthPresent.adoc[`isNestedWidthPresent`] 
| Return `true` if the nested width option is present in the current state of this object, and `false` otherwise.
| xref:BloombergLP/bslfmt/TestSpecificationGenerator/isPrecisionOptionPresent.adoc[`isPrecisionOptionPresent`] 
| Return `true` if the precision option is present in the current state of this object, and `false` otherwise.
| xref:BloombergLP/bslfmt/TestSpecificationGenerator/isSignOptionPresent.adoc[`isSignOptionPresent`] 
| Return `true` if the sign option is present in the current state of this object, and `false` otherwise.
| xref:BloombergLP/bslfmt/TestSpecificationGenerator/isStateValidForFormat.adoc[`isStateValidForFormat`] 
| Return `true` if the generated specification based on the current state of this object is valid for the formatters `format` method, and `false` otherwise.
| xref:BloombergLP/bslfmt/TestSpecificationGenerator/isStateValidForParse.adoc[`isStateValidForParse`] 
| Return `true` if the generated specification based on the current state of this object is valid for the formatters `parse` method, and `false` otherwise.
| xref:BloombergLP/bslfmt/TestSpecificationGenerator/isTypeOptionPresent.adoc[`isTypeOptionPresent`] 
| Return `true` if the presentation type option is present in the current state of this object, and `false` otherwise.
| xref:BloombergLP/bslfmt/TestSpecificationGenerator/isValueIdOptionPresent.adoc[`isValueIdOptionPresent`] 
| Return `true` if the value id option is present in the current state of this object, and `false` otherwise.
| xref:BloombergLP/bslfmt/TestSpecificationGenerator/isWidthOptionPresent.adoc[`isWidthOptionPresent`] 
| Return `true` if the width option is present in the current state of this object, and `false` otherwise.
| xref:BloombergLP/bslfmt/TestSpecificationGenerator/isZeroOptionPresent.adoc[`isZeroOptionPresent`] 
| Return `true` if the zero option is present in the current state of this object, and `false` otherwise.
| xref:BloombergLP/bslfmt/TestSpecificationGenerator/nestedPrecisionVariant.adoc[`nestedPrecisionVariant`] 
| Return the current nested precision variant.
| xref:BloombergLP/bslfmt/TestSpecificationGenerator/nestedWidthVariant.adoc[`nestedWidthVariant`] 
| Return the current nested width variant.
| xref:BloombergLP/bslfmt/TestSpecificationGenerator/next.adoc[`next`] 
| Switch this object to the next state and generate specification based on the new state.
| xref:BloombergLP/bslfmt/TestSpecificationGenerator/nextValidForFormat.adoc[`nextValidForFormat`] 
| Switch this object to the next state appropriate for generating a specification valid for formatters `format` method and generate specification based on the new state.
| xref:BloombergLP/bslfmt/TestSpecificationGenerator/nextValidForParse.adoc[`nextValidForParse`] 
| Switch this object to the next state appropriate for generating a specification valid for formatters `parse` method and generate specification based on the new state.
| xref:BloombergLP/bslfmt/TestSpecificationGenerator/precision.adoc[`precision`] 
| Return the current precision value.
| xref:BloombergLP/bslfmt/TestSpecificationGenerator/setup.adoc[`setup`] 
| Setup the sequence of this object's states based on the optionally specified `instruction`.
| xref:BloombergLP/bslfmt/TestSpecificationGenerator/sign-0b.adoc[`sign`] 
| Return the current sign option value.
| xref:BloombergLP/bslfmt/TestSpecificationGenerator/spec.adoc[`spec`] 
| Return the specification for the formatters `parse` method based on the current state of this object.
| xref:BloombergLP/bslfmt/TestSpecificationGenerator/type.adoc[`type`] 
| Return the current presentation type value.
| xref:BloombergLP/bslfmt/TestSpecificationGenerator/width.adoc[`width`] 
| Return the current width value.
| xref:BloombergLP/bslfmt/TestSpecificationGenerator/2conversion.adoc[`operator BloombergLP::bslmf::NestedTraitDeclaration<TestSpecificationGenerator, UsesBslmaAllocator>`] 
| Declare `TestSpecificationGenerator` as using bslma allocator.
|===



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