[#BloombergLP-balb-Enumerated]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/balb.adoc[balb]::Enumerated
:relfileprefix: ../../
:mrdocs:

This struct provides a test enumeration type used by test messages&period;

== Synopsis

Declared in `&lt;balb&lowbar;testmessages&period;h&gt;`

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

== Enums

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balb/Enumerated/_04enum.adoc[`Unnamed enum`] 
| Enumerator count constant&period;
| xref:BloombergLP/balb/Enumerated/Value.adoc[`Value`] 
| Test enumeration values&period;
|===


== Static Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balb/Enumerated/bdexStreamIn.adoc[`bdexStreamIn`] 
| Assign to the specified `value` the value read from the specified input `stream` using the specified `version` format and return a reference to the modifiable `stream`&period; If `stream` is initially invalid, this operation has no effect&period; If `stream` becomes invalid during this operation, the `value` is valid, but its value is undefined&period; If the specified `version` is not supported, `stream` is marked invalid, but `value` is unaltered&period; Note that no version is read from `stream`&period; (See the package&hyphen;group&hyphen;level documentation for more information on `bdex` streaming of container types&period;)
| xref:BloombergLP/balb/Enumerated/bdexStreamOut.adoc[`bdexStreamOut`] 
| Write the specified `value` to the specified output `stream` and return a reference to the modifiable `stream`&period; Optionally specify an explicit `version` format&semi; by default, the maximum supported version is written to `stream` and used as the format&period; If `version` is specified, that format is used but _not_ written to `stream`&period; If `version` is not supported, `stream` is left unmodified&period; (See the package&hyphen;group&hyphen;level documentation for more information on `bdex` streaming of container types)&period;
| xref:BloombergLP/balb/Enumerated/fromInt.adoc[`fromInt`] 
| Load into the specified `result` the enumerator matching the specified `number`&period; Return 0 on success, and a non&hyphen;zero value with no effect on `result` otherwise (i&period;e&period;, `number` does not match any enumerator)&period;
| xref:BloombergLP/balb/Enumerated/fromString-01.adoc[`fromString`] 
| `fromString` overloads
| xref:BloombergLP/balb/Enumerated/maxSupportedBdexVersion.adoc[`maxSupportedBdexVersion`] 
| Return the most current `bdex` streaming version number supported by this class&period; See the `bslx` package&hyphen;level documentation for more information on `bdex` streaming of value&hyphen;semantic types and containers&period;
| xref:BloombergLP/balb/Enumerated/print.adoc[`print`] 
| Write to the specified `stream` the string representation of the specified enumeration `value`&period; Return a reference to the modifiable `stream`&period;
| xref:BloombergLP/balb/Enumerated/toString.adoc[`toString`] 
| Return the string representation exactly matching the enumerator name corresponding to the specified enumeration `value`&period;
|===


== Static Data Members

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balb/Enumerated/CLASS_NAME.adoc[`CLASS&lowbar;NAME`] 
| Name of this class&period;
| xref:BloombergLP/balb/Enumerated/ENUMERATOR_INFO_ARRAY.adoc[`ENUMERATOR&lowbar;INFO&lowbar;ARRAY`] 
| Enumerator information array for this enumeration&period;
|===


== Derived Classes

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlat_BasicEnumerationWrapper-05.adoc[`bdlat&lowbar;BasicEnumerationWrapper&lt;balb::Enumerated::Value&gt;`] 
| 
|===


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