org.jpac.NthCycle Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of elbfisch.core Show documentation

Open-source runtime system for component-based implementation of automation solutions with Java

The newest version!

/**
 * PROJECT   : Elbfisch - java process automation controller (jPac)
 * MODULE    : NthCycle.java
 * VERSION   : -
 * DATE      : -
 * PURPOSE   : 
 * AUTHOR    : Bernd Schuster, MSK Gesellschaft fuer Automatisierung mbH, Schenefeld
 * REMARKS   : -
 * CHANGES   : CH#n   
 *
 * This file is part of the jPac process automation controller.
 * jPac is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * jPac is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with the jPac If not, see .
 */

package org.jpac;

/**
 * process event, indicating, that the n cycles passed since calling await()
 * @author berndschuster
 */
public class NthCycle extends ProcessEvent{
    private int cycleCount;
    private int n;

    public NthCycle(int n){
        if (n < 0){
            n = 0;
        }
        cycleCount = 0;
        this.n = n;
    };

    public boolean fire() throws ProcessException{
       boolean localFired;
       cycleCount++;
       localFired = cycleCount >= n;
       return localFired;
    }

    @Override
    public void reset(){
        super.reset();
        cycleCount = 0;
    }
    
    public void setN(int n){
        this.n = n;
    }
    
    public int getN(){
       return this.n;
    }
}