com.ghgande.j2mod.modbus.procimg.DigitalOut Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of j2mod Show documentation

A fork of the j2mod library to support the jSerialComm connector

There is a newer version: 3.2.1

/*
 * Copyright 2002-2016 jamod & j2mod development teams
 *
 * 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 com.ghgande.j2mod.modbus.procimg;

/**
 * Interface defining a digital output.
 * 
 * In Modbus terms this represents a
 * coil, which is read-write from slave and
 * master or device side.

 * Therefor implementations have to be carefully
 * designed for concurrency.
 *
 * @author Dieter Wimberger
 * @author Steve O'Hara (4NG)
 * @version 2.0 (March 2016)
 */
public interface DigitalOut {

    /**
     * Tests if this DigitalOut is set.
     * 

     *
     * @return true if set, false otherwise.
     */
    boolean isSet();

    /**
     * Sets the state of this DigitalOut.
     * 
     *
     * @param b true if to be set, false otherwise.
     */
    void set(boolean b);

}