Huygens Remote Manager
  • Namespace
  • Class
  • Tree
  • Todo

Namespaces

  • hrm
    • job
    • param
      • base
    • setting
      • base
    • shell
    • stats
    • user
      • proxy

Classes

  • AnyTypeArrayParameter
  • BooleanParameter
  • ChoiceParameter
  • NumericalArrayParameter
  • NumericalParameter
  • NumericalVectorParameter
  • Parameter
  • SingleOrMultiChannelParameter

Class AnyTypeArrayParameter

Class for a Parameter that has an array of variable of any type as possible value.

It inherits from NumericalArrayParameter and relaxes the condition that the values must be integers.

hrm\param\base\Parameter
Extended by hrm\param\base\NumericalParameter
Extended by hrm\param\base\NumericalArrayParameter
Extended by hrm\param\base\AnyTypeArrayParameter

Direct known subclasses

hrm\param\BackgroundOffsetPercent, hrm\param\ColocCoefficient, hrm\param\ColocThreshold, hrm\param\PSF, hrm\param\SpimDir, hrm\param\SpimExcMode, hrm\param\StedDepletionMode

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

Methods summary

public
# __construct( string $name )

AnyTypeArrayParameter constructor: creates an empty AnyTypeArrayParameter.

AnyTypeArrayParameter constructor: creates an empty AnyTypeArrayParameter.

Parameters

$name
Name of the AnyTypeArrayParameter.

Overrides

hrm\param\base\NumericalArrayParameter::__construct
public array
# possibleValues( )

Returns the possible values for the AnyTypeArrayParameter.

Returns the possible values for the AnyTypeArrayParameter.

Returns

array
The possible values.

Overrides

hrm\param\base\Parameter::possibleValues
public array
# internalValue( )

Returns the internal value of the AnyTypeArrayParameter.

Returns the internal value of the AnyTypeArrayParameter.

This function should be overloaded by the subclasses if the internal and external representations differ.

Returns

array
The internal value of the Parameter

Overrides

hrm\param\base\Parameter::internalValue

Methods inherited from hrm\param\base\NumericalArrayParameter

check(), displayString(), isVariableChannel(), numberOfChannels(), reset(), setNumberOfChannels(), setValue()

Methods inherited from hrm\param\base\NumericalParameter

checkMax(), checkMin(), max(), min(), setMax(), setMin()

Methods inherited from hrm\param\base\Parameter

confidenceLevel(), defaultValue(), getJsonData(), internalPossibleValues(), isBoolean(), isForCapture(), isForCorrection(), isForImage(), isForMicroscope(), isForPixelSizeCalculation(), isForSpim(), isForSted(), isTaskParameter(), message(), mustProvide(), name(), notSet(), setConfidenceLevel(), translatedValue(), translatedValueFor(), value()

Constants summary

Constants inherited from hrm\param\base\Parameter

PADSIZE

Huygens Remote Manager API documentation generated by ApiGen