Class TaskSetting

A TaskSetting is a complete set of restoration parameters.

hrm\setting\base\Setting

Extended by

hrm\setting\TaskSetting

Direct known subclasses

hrm\setting\JobTaskSetting

Namespace: hrm\setting
Package: hrm
Located at setting/TaskSetting.php

Methods summary

`public`	# `__construct( )` TaskSetting constructor. TaskSetting constructor.
`public static string`	# `table( )` Returns the name of the database table in which the list of Setting names are stored. Returns the name of the database table in which the list of Setting names are stored. Besides the name, the table contains the Setting's name, owner and the standard (default) flag. Returns string The name of the table. Throws Exception This method must be reimplemented. Overrides `hrm\setting\base\Setting::table`
`public static string`	# `sharedTable( )` Returns the name of the database table in which the list of shared Setting names are stored. Returns the name of the database table in which the list of shared Setting names are stored. Returns string The name of the shared table.
`public static string`	# `parameterTable( )` Returns the name of the database table in which all the Parameters for the Settings stored in the table specified in table(). Returns the name of the database table in which all the Parameters for the Settings stored in the table specified in table(). Returns string The name of the parameter table. Throws Exception This method must be reimplemented. See `hrm\setting\TaskSetting::table()` Overrides `hrm\setting\base\Setting::parameterTable`
`public static string`	# `sharedParameterTable( )` Returns the name of the database table to use for sharing settings. Returns the name of the database table to use for sharing settings. Returns string The name of the shared parameter table. See `hrm\setting\TaskSetting::sharedTable()`
`public boolean`	# `checkPostedTaskParameters( array $postedParameters )` Checks that the posted Task Parameters are all defined and valid. Checks that the posted Task Parameters are all defined and valid. Parameters `$postedParameters` The array of posted parameters. Returns boolean True if all Parameters are defined and valid, false otherwise.
`public boolean`	# `checkPostedChromaticAberrationParameters( array $postedParameters )` Checks that the posted Aberration Correction Parameters are defined. This correction is optional. Checks that the posted Aberration Correction Parameters are defined. This correction is optional. Parameters `$postedParameters` The array of posted parameters. Returns boolean True if all Parameters are defined and valid, false otherwise.
`public array`	# `taskParameterNames( )` Returns all Task Parameter names. Returns all Task Parameter names. Returns array Array of Task Parameter names.
`public integer`	# `numberOfChannels( )` Returns the number of channels of the Setting Returns the number of channels of the Setting Returns integer The number of channels for the Setting.
`public string`	# `displayString( integer $numberOfChannels = 0, string\|null $micrType = NULL )` Displays the setting as a text containing Parameter names and their values Displays the setting as a text containing Parameter names and their values Parameters `$numberOfChannels` Number of channels (optional, default value is 0) `$micrType` Microscope type (optional). Returns string Parameter names and their values as a string.
`public boolean`	# `isEligibleForStabilization( hrm\setting\ParameterSetting $paramSetting )` Checks whether the restoration should allow for stabilization. Checks whether the restoration should allow for stabilization. Parameters `$paramSetting` An instance of the ParameterSetting class. Returns boolean True to enable stabilization option, false otherwise.
`public boolean`	# `isEligibleForCAC( hrm\setting\ParameterSetting $paramSetting )` Checks whether the restoration should allow for CAC. Checks whether the restoration should allow for CAC. Parameters `$paramSetting` An instance of the ParameterSetting class (ignored). Returns boolean True to enable CAC, false otherwise. Todo Why is this taking a ParameterSetting as an input?
`public static array`	# `getTemplatesSharedWith( string $username )` Get the list of templates shared with the given user. Get the list of templates shared with the given user. Parameters `$username` Name of the user to query for. Returns array List of shared templates with the user.
`public static array`	# `getTemplatesSharedBy( string $username )` Get the list of templates shared by the given user. Get the list of templates shared by the given user. Parameters `$username` Name of the user to query for. Returns array List of shared templates by the user.
`public`	# `parseParamsFromHuCore( array $huArray )` Parse Huygens parameters to HRM parameters. Parse Huygens parameters to HRM parameters. Parameters `$huArray` An array with the result of 'image setp -tclReturn'.

Methods inherited from hrm\setting\base\Setting

__clone(), beDefault(), copyParameterFrom(), isDefault(), load(), message(), name(), owner(), parameter(), parameterNames(), resetDefault(), save(), set(), setName(), setNumberOfChannels(), setOwner(), shareWith()