[#BloombergLP-bdlar-EnumRef]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlar.adoc[bdlar]::EnumRef
:relfileprefix: ../../
:mrdocs:

Type&hyphen;erased non&hyphen;const reference to an object in the `bdlat` enumeration type category&period;

== Synopsis

Declared in `&lt;bdlar&lowbar;enumref&period;h&gt;`

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

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlar/EnumRef/2constructor-02.adoc[`EnumRef`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/bdlar/EnumRef/fromInt.adoc[`fromInt`] 
| Assign the enumerator value matching the specified `number`&period;
| xref:BloombergLP/bdlar/EnumRef/fromString.adoc[`fromString`] 
| Assign the enumerator value matching the specified `string` of the specified `stringLength`&period;
| xref:BloombergLP/bdlar/EnumRef/hasFallback.adoc[`hasFallback`] 
| Return `true` if the specified enumerator held by this object supports a fallback enumerator, and `false` otherwise&period;
| xref:BloombergLP/bdlar/EnumRef/isFallback.adoc[`isFallback`] 
| Return `true` if the specified enumerator held by this object is equal to a fallback enumerator, and `false` otherwise&period;
| xref:BloombergLP/bdlar/EnumRef/makeFallback.adoc[`makeFallback`] 
| Assign the fallback enumerator value&period;
| xref:BloombergLP/bdlar/EnumRef/objectAddress.adoc[`objectAddress`] 
| Return a pointer to the wrapped object&period;
| xref:BloombergLP/bdlar/EnumRef/reset.adoc[`reset`] 
| Reset the referred object to the default value&period;
| xref:BloombergLP/bdlar/EnumRef/toInt.adoc[`toInt`] 
| Load into the specified `result` the integer representation of the enumerator value held by this object&period;
| xref:BloombergLP/bdlar/EnumRef/toString.adoc[`toString`] 
| Load into the specified `result` the string representation of the enumerator value held by this object&period;
| xref:BloombergLP/bdlar/EnumRef/vtable.adoc[`vtable`] 
| Return a pointer to the vtable&period;
|===


== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlar/bdlat_enumFromInt.adoc[`bdlat&lowbar;enumFromInt`]
| Assign the enumerator value matching the specified `number` to the specified `result`&period;
| xref:BloombergLP/bdlar/bdlat_enumFromString.adoc[`bdlat&lowbar;enumFromString`]
| Assign the enumerator value matching the specified `string` of the specified `stringLength` to the specified `result`&period;
| xref:BloombergLP/bdlar/bdlat_enumHasFallback-00.adoc[`bdlat&lowbar;enumHasFallback`]
| Return `true` if the specified `value` supports a fallback enumerator, and `false` otherwise&period;
| xref:BloombergLP/bdlar/bdlat_enumIsFallback-01.adoc[`bdlat&lowbar;enumIsFallback`]
| Return `true` if the specified `value` is a fallback enumerator&period;
| xref:BloombergLP/bdlar/bdlat_enumMakeFallback.adoc[`bdlat&lowbar;enumMakeFallback`]
| Assign the fallback enumerator value to the specified `result`&period;
| xref:BloombergLP/bdlar/bdlat_valueTypeReset-0d0.adoc[`bdlat&lowbar;valueTypeReset`]
| Reset the specified `ref` to the default value&period;
|===


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