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

Type‐erased const reference to an object in the `bdlat` enumeration type category.

== Synopsis

Declared in `<bdlar_enumref.h>`

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

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlar/EnumConstRef/2constructor-06.adoc[`EnumConstRef`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/bdlar/EnumConstRef/hasFallback.adoc[`hasFallback`] 
| Return `true` if the specified enumerator held by this object supports a fallback enumerator, and `false` otherwise.
| xref:BloombergLP/bdlar/EnumConstRef/isFallback.adoc[`isFallback`] 
| Return `true` if the specified enumerator held by this object is equal to a fallback enumerator, and `false` otherwise.
| xref:BloombergLP/bdlar/EnumConstRef/objectAddress.adoc[`objectAddress`] 
| Return a pointer to the wrapped object.
| xref:BloombergLP/bdlar/EnumConstRef/toInt.adoc[`toInt`] 
| Load into the specified `result` the integer representation of the enumerator value held by this object.
| xref:BloombergLP/bdlar/EnumConstRef/toString.adoc[`toString`] 
| Load into the specified `result` the string representation of the enumerator value held by this object.
| xref:BloombergLP/bdlar/EnumConstRef/vtable.adoc[`vtable`] 
| Return a pointer to the vtable.
| xref:BloombergLP/bdlar/EnumConstRef/xsdName.adoc[`xsdName`] 
| Return the `bdlat_TypeName::xsdName` value for the underlying object.
|===


== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlar/bdlat_TypeName_xsdName-0e0.adoc[`bdlat_TypeName_xsdName`]
| Return the `bdlat_TypeName::xsdName` value for the specified `ref`.
| xref:BloombergLP/bdlar/bdlat_enumHasFallback-02.adoc[`bdlat_enumHasFallback`]
| Return `true` if the specified `value` has a fallback enumerator, and `false` otherwise.
| xref:BloombergLP/bdlar/bdlat_enumIsFallback-0b.adoc[`bdlat_enumIsFallback`]
| Return `true` if the specified `value` is equal to a fallback enumerator, and `false` otherwise.
|===


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