[#BloombergLP-bdlat_ChoiceFunctions-IsChoice-04]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlat_ChoiceFunctions.adoc[bdlat_ChoiceFunctions]::IsChoice
:relfileprefix: ../../
:mrdocs:

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

== Synopsis

Declared in `<bdlat_choicefunctions.h>`

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

== Base Classes

[cols="1,4"]
|===
| Name| Description
| `xref:bsl/integral_constant-02.adoc[bsl::integral_constant<bool, bslalg::HasTrait<TYPE, bdlat_TypeTraitBasicChoice>::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`] 
| Alias for the (template parameter) `t_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 t_TYPE`] 
| Return a copy of the template argument `t_VALUE`.
|===


== Static Data Members

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


== Specializations

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlat_ChoiceFunctions/IsChoice-03.adoc[`IsChoice<bdlar::ChoiceConstRef>`] 
| Trait indicating that `bdlar::ChoiceConstRef` is a `bdlat` choice type.
| xref:BloombergLP/bdlat_ChoiceFunctions/IsChoice-05.adoc[`IsChoice<bdlar::ChoiceRef>`] 
| Trait indicating that `bdlar::ChoiceRef` is a `bdlat` choice type.
|===



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