Class SingleOrMultiChannelParameter

A ChoiceParameter that handles single- and multi-channel Parameters with prefixing.

hrm\param\base\SingleOrMultiChannelParameter

Direct known subclasses

hrm\param\ImageFileFormat

Namespace: hrm\param\base
Package: hrm
Todo: Check whether this is still used anywhere.
Located at param/base/SingleOrMultiChannelParameter.php

Methods summary

`public boolean`	# `isMultiChannel( )` Checks whether the Parameter is multi-channel. Checks whether the Parameter is multi-channel. Returns boolean True if the Parameter is multi-channel.
`public boolean`	# `isSingleChannel( )` Checks whether the Parameter is single-channel. Checks whether the Parameter is single-channel. Returns boolean True if the Parameter is single-channel.
`public`	# `beMultiChannel( )` Makes the Parameter multi-channel. Makes the Parameter multi-channel.
`public`	# `beSingleChannel( )` Makes the Parameter single-channel. Makes the Parameter single-channel.
`public`	# `setValue( mixed $value )` Sets the value of the SingleOrMultiChannelParameter. Sets the value of the SingleOrMultiChannelParameter. If $value contains the prefix single_ or multi_, the parameter is set to be single-channel or multi-channel, respectively, and the postfix of the value is set as final value of the SingleOrMultiChannelParameter. Parameters `$value` New value for the SingleOrMultiChannelParameter. See postfix Overrides `hrm\param\base\Parameter::setValue`
`public string`	# `prefix( )` Returns the prefix for the Parameter, either 'single' or 'multi' Returns the prefix for the Parameter, either 'single' or 'multi' Returns string Either 'single' or 'multi'.
`public string`	# `internalValue( )` Returns the internal value of the SingleOrMultiChannelParameter. Returns the internal value of the SingleOrMultiChannelParameter. This function should be overloaded by the subclasses if the internal and external representations differ. Returns string The internal value of the Parameter, which is the value with the prefix prepended. Overrides `hrm\param\base\Parameter::internalValue`
`public string`	# `internalPossibleValues( )` Returns the internal possible values of the SingleOrMultiChannelParameter Returns the internal possible values of the SingleOrMultiChannelParameter Returns string The internal possible values of the Parameter, which are the checked values with the prefix prepended. Overrides `hrm\param\base\Parameter::internalPossibleValues`