[#BloombergLP-bdlat_EnumFunctions-IsEnumeration-0c]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlat_EnumFunctions.adoc[bdlat_EnumFunctions]::IsEnumeration
:relfileprefix: ../../
:mrdocs:

This `struct` should be specialized for third‐party types that need to expose "enumeration" behavior. See the component‐level documentation for further information.

== Synopsis

Declared in `<bdlat_enumfunctions.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<class TYPE>
struct IsEnumeration
    : xref:bsl/integral_constant-02.adoc[bsl::integral_constant<bool, bslalg::HasTrait<TYPE, bdlat_TypeTraitBasicEnumeration>::value>]
----

== Base Classes

[cols="1,4"]
|===
| Name| Description
| `xref:bsl/integral_constant-02.adoc[bsl::integral_constant<bool, bslalg::HasTrait<TYPE, bdlat_TypeTraitBasicEnumeration>::value>]`
| Metafunction representing a compile‐time constant of the specified (template parameter) `t_TYPE` with the specified (template parameter) `t_VALUE`.
|===

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:bsl/integral_constant-02/type.adoc[`type`] 
| Alias for this `integral_constant` specialization.
| xref:bsl/integral_constant-02/value_type.adoc[`value_type`] 
| 
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:bsl/integral_constant-02/operator_call.adoc[`operator()`] 
| Return a copy of the template argument `t_VALUE`.
| xref:bsl/integral_constant-02/2conversion.adoc[`operator value_type`] 
| 
|===


== Static Data Members

[cols="1"]
|===
| Name
| xref:bsl/integral_constant-02/value.adoc[`value`] 
|===


== Specializations

[cols="1"]
|===
| Name
| xref:BloombergLP/bdlat_EnumFunctions/IsEnumeration-0b.adoc[`IsEnumeration<bdlar::EnumConstRef>`] 
| xref:BloombergLP/bdlat_EnumFunctions/IsEnumeration-0a.adoc[`IsEnumeration<bdlar::EnumRef>`] 
|===


== Derived Classes

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlar/IsEnum.adoc[`IsEnum`] 
| Meta‐function indicating whether the specified `t_TYPE` is an enumeration type.
|===


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