Class ChoiceParameter

The ChoiceParameter can assume a limited number of possible values.

hrm\param\base\Parameter

Extended by

hrm\param\base\ChoiceParameter

Direct known subclasses

hrm\param\AberrationCorrectionMode, hrm\param\AdvancedCorrectionOptions, hrm\param\MicroscopeType, hrm\param\NumberOfChannels, hrm\param\ObjectiveMagnification, hrm\param\ObjectiveType, hrm\param\OutputFileFormat, hrm\param\PerformAberrationCorrection, hrm\param\PointSpreadFunction, hrm\param\SampleMedium, hrm\param\ZStabilization, hrm\param\Autocrop, hrm\param\base\BooleanParameter, hrm\param\base\SingleOrMultiChannelParameter, hrm\param\Binning, hrm\param\ColocAnalysis, hrm\param\ColocMap, hrm\param\CoverslipRelativePosition, hrm\param\DeconvolutionAlgorithm

Indirect known subclasses

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

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

Methods summary

`public array`	# `possibleValues( )` Returns the possible values for the Parameter. Returns the possible values for the Parameter. Returns array The possible values. Overrides `hrm\param\base\Parameter::possibleValues`
`public string`	# `possibleValuesString( )` Returns the possible values for the Parameter as a comma-separated string. Returns the possible values for the Parameter as a comma-separated string. Returns string The possible values as a comma-separated string.
`public boolean`	# `check( )` Checks whether the Parameter is valid. Checks whether the Parameter is valid. Returns boolean True if the Parameter is valid, false otherwise.
`public string`	# `displayString( integer $numberOfChannels = 0 )` Returns the string representation of the Parameter. Returns the string representation of the Parameter. Parameters `$numberOfChannels` Number of channels (default 0). Returns string String representation of the Parameter.
`public mixed`	# `defaultValue( )` Returns the default value for the Parameters that have a default value ot NULL for those that don't. Returns the default value for the Parameters that have a default value ot NULL for those that don't. This function should be overloaded by the subclasses Returns mixed The default value or NULL. Overrides `hrm\param\base\Parameter::defaultValue`

Methods inherited from hrm\param\base\Parameter

confidenceLevel(), getJsonData(), internalPossibleValues(), internalValue(), isBoolean(), 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