io.engineblock.activityapi.core.MultiPhaseAction Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of eb-api Show documentation

The driver API for engineblock; Provides the interfaces needed to build drivers that can be loaded by engineblock core

There is a newer version: 2.12.65

/*
 *
 *    Copyright 2016 jshook
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 * /
 */

package io.engineblock.activityapi.core;

/**
 * A continuing action can ask to be iterated within the cycle.
 * 
 * Motors must:
 * 

 * Detect when an action is a multi-phase action at initialization time, not in the inner loop
 * Call accept(cycle) as normal.
 * If the action is a multi-phase action, keep calling accept(cycle), with the same cycle number as above,
 * until incomplete returns false.
 * 
 */
public interface MultiPhaseAction extends Action {

    /**
     * Signal to the caller whether or not the current multi-phase is completed.
     *
     * @return true when completed.
     */
    boolean incomplete();

    /**
     * Apply a work function to an input value, producing an int status code.
     * This iterative interface represents work that occurs within the scope
     * of an existing action cycle. The last value returned by this phase loop will
     * take the place of the value returned by {@link Action#runCycle(long)}
     *
     * This will be called iteratively so long as {@link #incomplete()} returns true.
     *
     * The meaning of status codes is activity specific, however, negative values are reserved.
     *
     * @param value a long input
     * @return an int status
     */
    int runPhase(long value);

}