Package adams.flow.standalone

Class Standalones

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, Pausable, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, ThreadLimiter, VariablesInspectionHandler, FlowPauseStateListener, VariableChangeListener, AtomicExecution, Actor, ActorHandler, ControlActor, ErrorHandler, Flushable, MutableActorHandler, SubFlowWrapUp, Serializable, Comparable
    Direct Known Subclasses:
    AutogeneratedStandalone, ConditionalStandalones, InactiveStandalone
    public class Standalones
extends MutableControlActor
implements ThreadLimiter
    Container for standalone actors. 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
    min-user-mode: Expert
 
    -name <java.lang.String> (property: name)
    The name of the actor.
    default: Standalones
 
    -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
    min-user-mode: Expert
 
    -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
    min-user-mode: Expert
 
    -finish-before-stopping <boolean> (property: finishBeforeStopping)
    If enabled, actor first finishes processing all data before stopping.
    default: false
 
    -stopping-timeout <int> (property: stoppingTimeout)
    The timeout in milliseconds when waiting for actors to finish (<= 0 for
    infinity; see 'finishBeforeStopping').
    default: -1
    minimum: -1
 
    -stopping-warning-interval <int> (property: stoppingWarningInterval)
    The interval in milliseconds to output logging warnings if the actors haven't
    stopped yet (and no stopping timeout set); no warning if <= 0.
    default: 10000
    minimum: -1
 
    -actor <adams.flow.core.Actor> [-actor ...] (property: actors)
    The standalone actors grouped by this container.
    default:
 
    -num-threads <int> (property: numThreads)
    The number of threads to use for parallel execution; > 0: specific number
    of cores to use (capped by actual number of cores available, 1 = sequential
    execution); = 0: number of cores; < 0: number of free cores (eg -2 means
    2 free cores; minimum of one core is used)
    default: 1
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_NumThreads

        protected int m_NumThreads
        the number of threads to use for parallel execution.

    • Constructor Detail

      • Standalones

        public Standalones()
        Default constructor.

      • Standalones

        public Standalones​(String name)
        Initializes with the specified name.
        Parameters:
        name - the name to use

    • Method Detail

      • actorsTipText

        public String actorsTipText()
        Returns the tip text for this property.
        Specified by:
        actorsTipText in class MutableControlActor
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setNumThreads

        public void setNumThreads​(int value)
        Sets the number of threads to use for executing the branches.
        Specified by:
        setNumThreads in interface ThreadLimiter
        Parameters:
        value - the number of threads: -1 = # of CPUs/cores; 0/1 = sequential execution

      • getNumThreads

        public int getNumThreads()
        Returns the number of threads to use for executing the branches.
        Specified by:
        getNumThreads in interface ThreadLimiter
        Returns:
        the number of threads: -1 = # of CPUs/cores; 0/1 = sequential execution

      • numThreadsTipText

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

      • checkScope

        protected String checkScope()
        Checks whether names of sub-actors are unique.
        Returns:
        null if everything is fine, otherwise the offending connection