/*
 * Copyright (C) 2007 ETH Zurich
 *
 * This file is part of Fosstrak (www.fosstrak.org).
 *
 * Fosstrak is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License version 2.1, as published by the Free Software Foundation.
 *
 * Fosstrak is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with Fosstrak; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA  02110-1301  USA
 */

package org.fosstrak.reader.rprm.core.mgmt.alarm;

/**
 * Controls the direction in which an edge-triggered alarm should fire.
 */
public enum EdgeTriggeredAlarmDirection {
	
	/*
	 * Trigger on the rising edge
	 */
	RISING,
	
	/*
	 * Trigger on the falling edge
	 */
	FALLING;
	
	
	/**
	 * Converts this <code>EdgeTriggeredAlarmDirection</code> instance to an
	 * <code>int</code> value.
	 * 
	 * @return <code>int</code> representation of this
	 *         <code>EdgeTriggeredAlarmDirection</code> instance
	 */
	public final int toInt() {
		EdgeTriggeredAlarmDirection[] values = EdgeTriggeredAlarmDirection.values();
		for (int index = 0; index < values.length; index++) {
			if (values[index] == this) return index;
		}
		return -1;
	}
	
	/**
	 * Converts an <code>int</code> value to an
	 * <code>EdgeTriggeredAlarmDirection instance</code>. If the
	 * <code>int</code> value is out of range it returns <code>null</code>.
	 * 
	 * @param i
	 *            The <code>int</code> value
	 * @return The <code>EdgeTriggeredAlarmDirection</code> representation of
	 *         the <code>int</code> value
	 */
	public static final EdgeTriggeredAlarmDirection intToEnum(final int i) {
		try {
			return EdgeTriggeredAlarmDirection.values()[i];
		} catch (ArrayIndexOutOfBoundsException e) {
			return null;
		}
	}
	
}