001package com.pi4j.io.gpio.event;
002
003/*
004 * #%L
005 * **********************************************************************
006 * ORGANIZATION  :  Pi4J
007 * PROJECT       :  Pi4J :: Java Library (Core)
008 * FILENAME      :  PinAnalogValueChangeEvent.java
009 *
010 * This file is part of the Pi4J project. More information about
011 * this project can be found here:  https://www.pi4j.com/
012 * **********************************************************************
013 * %%
014 * Copyright (C) 2012 - 2019 Pi4J
015 * %%
016 * This program is free software: you can redistribute it and/or modify
017 * it under the terms of the GNU Lesser General Public License as
018 * published by the Free Software Foundation, either version 3 of the
019 * License, or (at your option) any later version.
020 *
021 * This program is distributed in the hope that it will be useful,
022 * but WITHOUT ANY WARRANTY; without even the implied warranty of
023 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
024 * GNU General Lesser Public License for more details.
025 *
026 * You should have received a copy of the GNU General Lesser Public
027 * License along with this program.  If not, see
028 * <http://www.gnu.org/licenses/lgpl-3.0.html>.
029 * #L%
030 */
031
032
033import com.pi4j.io.gpio.Pin;
034
035/**
036 * GPIO analog pin value change event.
037 *
038 * @author Robert Savage (<a
039 *         href="http://www.savagehomeautomation.com">http://www.savagehomeautomation.com</a>)
040 */
041public class PinAnalogValueChangeEvent extends PinEvent {
042
043    private static final long serialVersionUID = -6210539419288104794L;
044    private final double value;
045
046    /**
047     * Default event constructor
048     *
049     * @param obj Ignore this parameter
050     * @param pin GPIO pin number (not header pin number; not wiringPi pin number)
051     * @param value  New GPIO pin analog value.
052     */
053    public PinAnalogValueChangeEvent(Object obj, Pin pin, double value) {
054        super(obj, pin, PinEventType.ANALOG_VALUE_CHANGE);
055        this.value = value;
056    }
057
058    /**
059     * Get the new pin value raised in this event.
060     *
061     * @return GPIO pin value
062     */
063    public double getValue() {
064        return value;
065    }
066}