Class MicroscopeType

A ChoiceParameter to represent the microscope type.

hrm\param\base\Parameter

Extended by

hrm\param\base\ChoiceParameter

Extended by

hrm\param\MicroscopeType

Namespace: hrm\param
Package: hrm
Located at param/MicroscopeType.php

Methods summary

`public`	# `__construct( )` MicroscopeType constructor. MicroscopeType constructor.
`public boolean`	# `isForMicroscope( )` Confirms that this is a Microscope Parameter. Confirms that this is a Microscope Parameter. Returns boolean Always true. Overrides `hrm\param\base\Parameter::isForMicroscope`
`public string`	# `translatedValue( )` Returns the Parameter translated value. Returns the Parameter translated value. The translated form of the Parameter value is then one used in the Tcl script. The translation of the microscope type is read from the database. Returns string Translated value. Overrides `hrm\param\base\Parameter::translatedValue`
`public string`	# `translateHucore( string $hucoreval )` Returns the value expected by HRM based on the key from Huygens. Returns the value expected by HRM based on the key from Huygens. The translated form of the Parameter value is then one used in the Tcl script. The translated value of the microscope type is read from the database. Parameters `$hucoreval` Hucore value to be translated. Returns string Translated value.
`public static boolean`	# `hasLicense( string $value )` Returns true if the given microscope type has a license. Parameters `$value` Microscope type to check for a valid license; $value must be one one of the possible values. Returns boolean True if the microscope type is licensed, false otherwise.

Methods inherited from hrm\param\base\ChoiceParameter

check(), defaultValue(), displayString(), possibleValues(), possibleValuesString()

Methods inherited from hrm\param\base\Parameter

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

Constants summary

Constants inherited from hrm\param\base\Parameter