001package com.pi4j.io.gpio;
002
003import java.util.EnumSet;
004
005/*
006 * #%L
007 * **********************************************************************
008 * ORGANIZATION  :  Pi4J
009 * PROJECT       :  Pi4J :: Java Library (Core)
010 * FILENAME      :  PinMode.java  
011 * 
012 * This file is part of the Pi4J project. More information about 
013 * this project can be found here:  http://www.pi4j.com/
014 * **********************************************************************
015 * %%
016 * Copyright (C) 2012 - 2015 Pi4J
017 * %%
018 * This program is free software: you can redistribute it and/or modify
019 * it under the terms of the GNU Lesser General Public License as
020 * published by the Free Software Foundation, either version 3 of the
021 * License, or (at your option) any later version.
022 * 
023 * This program is distributed in the hope that it will be useful,
024 * but WITHOUT ANY WARRANTY; without even the implied warranty of
025 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
026 * GNU General Lesser Public License for more details.
027 * 
028 * You should have received a copy of the GNU General Lesser Public
029 * License along with this program.  If not, see
030 * <http://www.gnu.org/licenses/lgpl-3.0.html>.
031 * #L%
032 */
033
034/**
035 * Pin edge definition.
036 *
037 * @author Robert Savage (<a
038 *         href="http://www.savagehomeautomation.com">http://www.savagehomeautomation.com</a>)
039 */
040@SuppressWarnings("unused")
041public enum PinMode {
042
043    DIGITAL_INPUT(0, "input", PinDirection.IN), 
044    DIGITAL_OUTPUT(1, "output", PinDirection.OUT),
045    PWM_OUTPUT(2, "pwm_output", PinDirection.OUT),
046    ANALOG_INPUT(3, "analog_input", PinDirection.IN), 
047    ANALOG_OUTPUT(4, "analog_output", PinDirection.OUT);
048
049    private final int value;
050    private final String name;
051    private final PinDirection direction;
052
053    private PinMode(int value, String name, PinDirection direction) {
054        this.value = value;
055        this.name = name;
056        this.direction = direction;
057    }
058
059    public int getValue() {
060        return value;
061    }
062
063    public String getName() {
064        return name;
065    }
066
067    public PinDirection getDirection() {
068        return direction;
069    }
070    
071    @Override
072    public String toString() {
073        return name.toUpperCase();        
074    }    
075    
076    public static EnumSet<PinMode> allDigital() {
077        return EnumSet.of(PinMode.DIGITAL_INPUT, PinMode.DIGITAL_OUTPUT);
078    }    
079
080    public static EnumSet<PinMode> allAnalog() {
081        return EnumSet.of(PinMode.ANALOG_INPUT, PinMode.ANALOG_OUTPUT);
082    }    
083
084    public static EnumSet<PinMode> all() {
085        return EnumSet.of(PinMode.DIGITAL_INPUT, PinMode.DIGITAL_OUTPUT, 
086                          PinMode.ANALOG_INPUT, PinMode.ANALOG_OUTPUT,
087                          PinMode.PWM_OUTPUT);
088    }    
089
090    public static EnumSet<PinMode> allInputs() {
091        return EnumSet.of(PinMode.DIGITAL_INPUT, PinMode.ANALOG_INPUT);
092    }    
093
094    public static EnumSet<PinMode> allOutput() {
095        return EnumSet.of(PinMode.DIGITAL_OUTPUT, 
096                          PinMode.ANALOG_OUTPUT,
097                          PinMode.PWM_OUTPUT);
098    }        
099}