Package adams.flow.transformer

Class Mat5GetMatrixElement

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, MatlabArrayIndexSupporter, VariableChangeListener, Actor, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable
    public class Mat5GetMatrixElement
extends AbstractTransformer
implements MatlabArrayIndexSupporter
    Retrieves the specified matrix element.

    Input/output:
    - accepts:
       us.hebi.matlab.mat.types.Array
    - generates:
       java.lang.Double


    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -name <java.lang.String> (property: name)
    The name of the actor.
    default: Mat5GetMatrixElement
 
    -annotation <adams.core.base.BaseAnnotation> (property: annotations)
    The annotations to attach to this actor.
    default:
 
    -skip <boolean> (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded
    as it is.
    default: false
 
    -stop-flow-on-error <boolean> (property: stopFlowOnError)
    If set to true, the flow execution at this level gets stopped in case this
    actor encounters an error; the error gets propagated; useful for critical
    actors.
    default: false
 
    -silent <boolean> (property: silent)
    If enabled, then no errors are output in the console; Note: the enclosing
    actor handler must have this enabled as well.
    default: false
 
    -index <adams.core.base.Mat5ArrayElementIndex> (property: index)
    The index of the single value (all dimensions specified) or array subset
    to retrieve (some dimensions left empty).
    default:
 
    -zero-based-index <boolean> (property: zeroBasedIndex)
    If true, the index is treated as 0-based (eg 0;0;0 for first value) rather
    than 1-based ones (eg 1;1;1 for first value).
    default: false
 
    -element-type <BOOLEAN|BYTE|SHORT|INTEGER|LONG|FLOAT|DOUBLE> (property: elementType)
    Specifies the type of the value being retrieved.
    default: DOUBLE
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_ZeroBasedIndex

        protected boolean m_ZeroBasedIndex
        whether to interpret the indices as 0-based or 1-based.

    • Constructor Detail

      • Mat5GetMatrixElement

        public Mat5GetMatrixElement()

    • Method Detail

      • indexTipText

        public String indexTipText()
        Returns the tip text for this property.
        Specified by:
        indexTipText in interface MatlabArrayIndexSupporter
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setZeroBasedIndex

        public void setZeroBasedIndex​(boolean value)
        Sets whether the index is 0-based or 1-based.
        Specified by:
        setZeroBasedIndex in interface MatlabArrayIndexSupporter
        Parameters:
        value - true if 0-based

      • zeroBasedIndexTipText

        public String zeroBasedIndexTipText()
        Returns the tip text for this property.
        Specified by:
        zeroBasedIndexTipText in interface MatlabArrayIndexSupporter
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setElementType

        public void setElementType​(ArrayElementType value)
        Sets the type of the element to retrieve.
        Parameters:
        value - the type

      • getElementType

        public ArrayElementType getElementType()
        Returns the type of the element to retrieve.
        Returns:
        the type

      • elementTypeTipText

        public String elementTypeTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • accepts

        public Class[] accepts()
        Returns the class that the consumer accepts.
        Specified by:
        accepts in interface InputConsumer
        Returns:
        the Class of objects that can be processed

      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        Specified by:
        generates in interface OutputProducer
        Returns:
        the Class of the generated tokens

      • doExecute

        protected String doExecute()
        Executes the flow item.
        Specified by:
        doExecute in class AbstractActor
        Returns:
        null if everything is fine, otherwise error message