org.jpac.vioss.IoSignal 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    : IoSignal.java (versatile input output subsystem)
 * 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.vioss;

import java.net.URI;
import java.util.Map;

import org.jpac.IoDirection;
import org.jpac.NumberOutOfRangeException;
import org.jpac.SignalAccessException;

/**
 *
 * @author berndschuster
 */
public interface IoSignal extends org.jpac.IoSignal {
	public IoDirection         getIoDirection();
    public URI                 getUri();
    public Object              getErrorCode();
    public void                setErrorCode(Object errorCode);
    public IOHandler           getIOHandler();
    public RemoteSignalInfo    getRemoteSignalInfo();
    public void                setRemoteSignalInfo(RemoteSignalInfo remoteSignalInfo);
    public void                checkIn() throws SignalAccessException, NumberOutOfRangeException;
    public void                checkOut() throws SignalAccessException, NumberOutOfRangeException;
    public boolean             isToBePutOut();
    public void                resetToBePutOut();
    public void                invalidate();
    public Map getParameters();
    
    default public String   getPath() {
    	return getUri().getPath().substring(1);
    }
}