[#BloombergLP-bslfmt-TestSpecificationGenerator_BoolOption]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bslfmt.adoc[bslfmt]::TestSpecificationGenerator_BoolOption
:relfileprefix: ../../
:mrdocs:

This class is an implementation of the `TestSpecificationGenerator_Option` for options that have only two states: they are either present or not.

== Synopsis

Declared in `<bslfmt_testspecificationgenerator.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class TestSpecificationGenerator_BoolOption
    : public xref:BloombergLP/bslfmt/TestSpecificationGenerator_Option.adoc[TestSpecificationGenerator_Option]
----

== Base Classes

[cols="1,4"]
|===
| Name| Description
| `xref:BloombergLP/bslfmt/TestSpecificationGenerator_Option.adoc[TestSpecificationGenerator_Option]`
| Base class for linked option nodes in a `TestSpecificationGenerator`.
|===

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslfmt/TestSpecificationGenerator_BoolOption/2constructor.adoc[`TestSpecificationGenerator_BoolOption`]         [.small]#[constructor]#
| Create an object that displays its state through the specified `value`.
| xref:BloombergLP/bslfmt/TestSpecificationGenerator_BoolOption/2destructor.adoc[`~TestSpecificationGenerator_BoolOption`] [.small]#[destructor]# [.small]#[virtual]#
| Destroy this object.
| xref:BloombergLP/bslfmt/TestSpecificationGenerator_Option/lastOption.adoc[`lastOption`] 
| Return the pointer to the last item in the list of generator options (this object can also be one).
| xref:BloombergLP/bslfmt/TestSpecificationGenerator_Option/nextOption.adoc[`nextOption`] 
| Return the pointer to the next item in the list of generator options if such an object exists and null otherwise.
| xref:BloombergLP/bslfmt/TestSpecificationGenerator_BoolOption/nextState.adoc[`nextState`]  [.small]#[virtual]#
| Switch the state of this object to the next one.
| xref:BloombergLP/bslfmt/TestSpecificationGenerator_Option/setNextOption.adoc[`setNextOption`] 
| Set the specified `nextOption` as a successor in the list of generator options. Use the specified `allocator` to supply memory.
|===



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