001package com.pi4j.io.gpio.event;
002
003/*
004 * #%L
005 * **********************************************************************
006 * ORGANIZATION  :  Pi4J
007 * PROJECT       :  Pi4J :: Java Library (Core)
008 * FILENAME      :  PinDigitalStateChangeEvent.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;
032import com.pi4j.io.gpio.PinState;
033
034
035/**
036 * GPIO digital pin state change event.
037 *
038 * @author Robert Savage (<a
039 *         href="http://www.savagehomeautomation.com">http://www.savagehomeautomation.com</a>)
040 */
041public class PinDigitalStateChangeEvent extends PinEvent {
042
043    private static final long serialVersionUID = -7643355305429082626L;
044    private final PinState state;
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 state New GPIO pin state.
052     */
053    public PinDigitalStateChangeEvent(Object obj, Pin pin, PinState state) {
054        super(obj, pin, PinEventType.DIGITAL_STATE_CHANGE);
055        this.state = state;
056    }
057
058    /**
059     * Get the new pin state raised in this event.
060     * 
061     * @return GPIO pin state (HIGH, LOW)
062     */
063    public PinState getState() {
064        return state;
065    }
066}