Class BooleanParameter

Class for a Parameter that has only true and false as possible value.

hrm\param\base\Parameter

Extended by

hrm\param\base\ChoiceParameter

Extended by

hrm\param\base\BooleanParameter

Direct known subclasses

hrm\param\AberrationCorrectionNecessary, hrm\param\IsMultiChannel, hrm\param\MultiChannelOutput

Namespace: hrm\param\base
Package: hrm
Located at param/base/BooleanParameter.php

Methods summary

`public`	# `__construct( string $name )` Constructor: creates an empty Parameter Constructor: creates an empty Parameter Parameters `$name` Name of the new Parameter.
`public boolean`	# `isTrue( )` Checks whether the value is true. Checks whether the value is true. Returns boolean True if the value of the BooleanParameter is "True", false otherwise.
`public boolean`	# `isBoolean( )` Checks whether the Parameter is a BooleanParameter. Checks whether the Parameter is a BooleanParameter. Returns boolean True if the Parameter is a BooleanParameter, false otherwise. Overrides `hrm\param\base\Parameter::isBoolean`
`public string`	# `displayString( integer $numberOfChannels = 0 )` Returns the string representation of the BooleanParameter. Returns the string representation of the BooleanParameter. Parameters `$numberOfChannels` Number of channels (ignored). Returns string String representation of the BooleanParameter. Overrides `hrm\param\base\ChoiceParameter::displayString`
`public boolean`	# `check( )` Checks whether the BooleanParameter is valid. Checks whether the BooleanParameter is valid. Returns boolean True if the BooleanParameter is valid, false otherwise. Overrides `hrm\param\base\ChoiceParameter::check`

Methods inherited from hrm\param\base\ChoiceParameter

defaultValue(), possibleValues(), possibleValuesString()

Methods inherited from hrm\param\base\Parameter

confidenceLevel(), getJsonData(), internalPossibleValues(), internalValue(), isForCapture(), isForCorrection(), isForImage(), isForMicroscope(), isForPixelSizeCalculation(), isForSpim(), isForSted(), isTaskParameter(), isVariableChannel(), message(), mustProvide(), name(), notSet(), reset(), setConfidenceLevel(), setValue(), translatedValue(), translatedValueFor(), value()

Constants summary

Constants inherited from hrm\param\base\Parameter