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:  http://www.pi4j.com/
012 * **********************************************************************
013 * %%
014 * Copyright (C) 2012 - 2013 Pi4J
015 * %%
016 * Licensed under the Apache License, Version 2.0 (the "License");
017 * you may not use this file except in compliance with the License.
018 * You may obtain a copy of the License at
019 * 
020 *      http://www.apache.org/licenses/LICENSE-2.0
021 * 
022 * Unless required by applicable law or agreed to in writing, software
023 * distributed under the License is distributed on an "AS IS" BASIS,
024 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
025 * See the License for the specific language governing permissions and
026 * limitations under the License.
027 * #L%
028 */
029
030
031import com.pi4j.io.gpio.Pin;
032
033/**
034 * GPIO analog pin value change event.
035 *
036 * @author Robert Savage (<a
037 *         href="http://www.savagehomeautomation.com">http://www.savagehomeautomation.com</a>)
038 */
039public class PinAnalogValueChangeEvent extends PinEvent {
040
041    private static final long serialVersionUID = -6210539419288104794L;
042    private final double value;
043
044    /**
045     * Default event constructor
046     * 
047     * @param obj Ignore this parameter
048     * @param pin GPIO pin number (not header pin number; not wiringPi pin number)
049     * @param value  New GPIO pin analog value.
050     */
051    public PinAnalogValueChangeEvent(Object obj, Pin pin, double value) {
052        super(obj, pin, PinEventType.ANALOG_VALUE_CHANGE);
053        this.value = value;
054    }
055
056    /**
057     * Get the new pin value raised in this event.
058     * 
059     * @return GPIO pin value
060     */
061    public double getValue() {
062        return value;
063    }
064}