[#BloombergLP-bdlat_EnumFunctions-IsEnumeration-0c]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlat_EnumFunctions.adoc[bdlat&lowbar;EnumFunctions]::IsEnumeration
:relfileprefix: ../../
:mrdocs:

Meta&hyphen;function that detects whether `TYPE` exposes enumeration behavior&period;

== Synopsis

Declared in `&lt;bdlat&lowbar;enumfunctions&period;h&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template&lt;class TYPE&gt;
struct IsEnumeration
    : xref:bsl/integral_constant-02.adoc[bsl::integral&lowbar;constant&lt;bool, bslalg&colon;&colon;HasTrait&lt;TYPE, bdlat&lowbar;TypeTraitBasicEnumeration&gt;&colon;&colon;value&gt;]
----

== Description

This `struct` should be specialized for third&hyphen;party types that need to expose &quot;enumeration&quot; behavior&period; See the component&hyphen;level documentation for further information&period;

== Base Classes

[cols="1,4"]
|===
| Name| Description
| `xref:bsl/integral_constant-02.adoc[bsl::integral&lowbar;constant&lt;bool, bslalg&colon;&colon;HasTrait&lt;TYPE, bdlat&lowbar;TypeTraitBasicEnumeration&gt;&colon;&colon;value&gt;]`
| Metafunction representing a compile&hyphen;time constant of the specified (template parameter) `t&lowbar;TYPE` with the specified (template parameter) `t&lowbar;VALUE`&period;
|===

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:bsl/integral_constant-02/type.adoc[`type`] 
| Alias for this `integral&lowbar;constant` specialization&period;
| xref:bsl/integral_constant-02/value_type.adoc[`value&lowbar;type`] 
| Alias for the (template parameter) `t&lowbar;TYPE`&period;
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:bsl/integral_constant-02/operator_call.adoc[`operator()`] 
| Return a copy of the template argument `t&lowbar;VALUE`&period;
| xref:bsl/integral_constant-02/2conversion.adoc[`operator t&lowbar;TYPE`] 
| Return a copy of the template argument `t&lowbar;VALUE`&period;
|===


== Static Data Members

[cols="1,4"]
|===
| Name| Description
| xref:bsl/integral_constant-02/value.adoc[`value`] 
| The compile&hyphen;time constant value of this metafunction&period;
|===


== Specializations

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlat_EnumFunctions/IsEnumeration-0b.adoc[`IsEnumeration&lt;bdlar::EnumConstRef&gt;`] 
| Trait indicating that `bdlar&colon;&colon;EnumConstRef` is a `bdlat` enumeration type&period;
| xref:BloombergLP/bdlat_EnumFunctions/IsEnumeration-0a.adoc[`IsEnumeration&lt;bdlar::EnumRef&gt;`] 
| Trait indicating that `bdlar&colon;&colon;EnumRef` is a `bdlat` enumeration type&period;
|===


== Derived Classes

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlar/IsEnum.adoc[`IsEnum`] 
| Meta&hyphen;function indicating whether the specified `t&lowbar;TYPE` is an enumeration type&period;
|===


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