Class NumericalVectorParameter

Class for a channel Parameter consisting of N components.

hrm\param\base\Parameter

Extended by

hrm\param\base\NumericalParameter

Extended by

hrm\param\base\NumericalVectorParameter

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

Methods summary

`public`	# `__construct( string $name, integer $componentCnt )` Constructor: creates an empty NumericalVectorParameter. Constructor: creates an empty NumericalVectorParameter. Parameters `$name` Name of the new NumericalVectorParameter. `$componentCnt` Number of components for the NumericalVectorParameter. Overrides `hrm\param\base\NumericalParameter::__construct`
`public`	# `reset( integer $componentCnt )` Sets the NumericalVectorParameter value(s) to null. Sets the NumericalVectorParameter value(s) to null. Parameters `$componentCnt` Number of components for the NumericalVectorParameter. Overrides `hrm\param\base\Parameter::reset`
`public boolean`	# `check( )` Checks whether all values in the NumericalVectorParameter are valid. Checks whether all values in the NumericalVectorParameter are valid. Each value in the NumericalVectorParameter must be a number and might optionally have to be larger than or equal to a given minimum value and smaller than or equal to a given maximum. Returns boolean True if all values are valid, false otherwise. Todo This method calls parent::check() passing one argument, but parent::check() does not take input arguments! Overrides `hrm\param\base\NumericalParameter::check`
`public`	# `setValue( array $value )` Sets the value of the NumericalVectorParameter. Sets the value of the NumericalVectorParameter. The value must be an array with as many components as $componentCnt Parameters `$value` Array of values for the NumericalVectorParameter. Overrides `hrm\param\base\NumericalParameter::setValue`
`public string`	# `value( )` Function for retrieving a string representation of the NumericalVectorParameter. Function for retrieving a string representation of the NumericalVectorParameter. Returns string A '#'-separated string denoting the NumericalVectorParameter components. Overrides `hrm\param\base\Parameter::value`
`public string`	# `displayString( )` Returns the string representation of the NumericalVectorParameter. Returns the string representation of the NumericalVectorParameter. Returns string String representation of the NumericalVectorParameter. Overrides `hrm\param\base\NumericalParameter::displayString`

Methods inherited from hrm\param\base\NumericalParameter

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

Methods inherited from hrm\param\base\Parameter

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

Constants summary

Constants inherited from hrm\param\base\Parameter

Properties summary

`public integer`	`$componentCnt` Number of components in the vector. Number of components in the vector.	#