Package adams.flow.transformer

Class Mat5ArrayInfo

  • 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 Mat5ArrayInfo
extends AbstractArrayProvider
implements DataInfoActor
    Provides information on a Matlab5 array.

    Input/output:
    - accepts:
       us.hebi.matlab.mat.types.Array
    - 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: Mat5ArrayInfo
 
    -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 <ALL|TYPE_NAME|TYPE_ID|NUM_DIMENSIONS|STR_DIMENSIONS|NUM_COLS|NUM_ROWS|NUM_ELEMENTS|DIMENSIONS> (property: type)
    The type of information to generate.
    default: NUM_DIMENSIONS
 
    -dim-separator <java.lang.String> (property: dimSeparator)
    The separator to use for the dimensions when outputting STR_DIMENSIONS.
    default: x
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_DimSeparator

        protected String m_DimSeparator
        the separator to use for the dimsnions.

    • Constructor Detail

      • Mat5ArrayInfo

        public Mat5ArrayInfo()