Package adams.flow.transformer

Class Mat5StructInfo

  • All Implemented Interfaces:
    AdditionalInformationHandler, ArrayProvider, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ArrayProvider, DataInfoActor, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable
    public class Mat5StructInfo
extends AbstractArrayProvider
implements DataInfoActor
    Provides information from a Matlab struct object.

    Input/output:
    - accepts:
       us.hebi.matlab.mat.types.Struct
    - generates:
       java.lang.Integer


    -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: MatlabStructInfo
 
    -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
 
    -output-array <boolean> (property: outputArray)
    If enabled, outputs the items as array rather than one-by-one.
    default: false
 
    -type <NUM_FIELDNAMES|FIELD_NAMES> (property: type)
    The type of information to generate.
    default: NUM_FIELDNAMES
 
    -sort <boolean> (property: sort)
    If enabled, lists (eg names, values) are sorted.
    default: true
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Sort

        protected boolean m_Sort
        whether to sort lists.

    • Constructor Detail

      • Mat5StructInfo

        public Mat5StructInfo()

    • Method Detail

      • setType

        public void setType​(Mat5StructInfo.InfoType value)
        Sets the type of information to generate.
        Parameters:
        value - the type

      • getType

        public Mat5StructInfo.InfoType getType()
        Returns the type of information to generate.
        Returns:
        the type

      • typeTipText

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

      • setSort

        public void setSort​(boolean value)
        Sets whether to sort lists (eg names, values).
        Parameters:
        value - true if to sort

      • getSort

        public boolean getSort()
        Returns whether lists (eg names, values) are sorted.
        Returns:
        true if to sort

      • sortTipText

        public String sortTipText()
        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

      • doExecute

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