[#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.

== Synopsis

Declared in `<balb_testmessages.h>`

[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.
| xref:BloombergLP/balb/Enumerated/Value.adoc[`Value`] 
| Test enumeration values.
|===


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


== Static Data Members

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balb/Enumerated/CLASS_NAME.adoc[`CLASS_NAME`] 
| Name of this class.
| xref:BloombergLP/balb/Enumerated/ENUMERATOR_INFO_ARRAY.adoc[`ENUMERATOR_INFO_ARRAY`] 
| Enumerator information array for this enumeration.
|===


== Derived Classes

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlat_BasicEnumerationWrapper-05.adoc[`bdlat_BasicEnumerationWrapper<balb::Enumerated::Value>`] 
| 
|===


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