/***********************************************************************
 *  J a v a G P S - GPS access library and Java API                    *
 *  Copyright (C) 2001 Ulrich Walther                                  *
 *                                                                     *
 *  This program is free software; you can redistribute it and/or      *
 *  modify it under the terms of the GNU General Public License as     *
 *  published by the Free Software Foundation; either version 2 of     *
 *  the License, or (at your option) any later version.                *
 *                                                                     *
 *  This program 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   *
 *  General Public License for more details.                           *
 *                                                                     *
 *  You should have received a copy of the GNU General Public          *
 *  License along with this program; if not, write to the Free         *
 *  Software Foundation, Inc., 59 Temple Place, Suite 330, Boston,     *
 *  MA 02111-1307 USA                                                  *
 ***********************************************************************/

package org.iu.gps;

/**
 *  Trigger information base class. Contains information common for all
 *  triggers, trigger id, the receiver of the trigger, and whether the trigger
 *  is persistant or a one-shot trigger.
 *
 *@author    walther
 */
public class TriggerInfo {
	/**
	 *  Unique ID for the trigger.
	 */
	public int id;
	/**
	 *  Receiver to whom this trigger will be reported.
	 */
	public VRMITriggerListener receiver;
	/**
	 *  Specifies one-shot (false) or persistant (true) trigger.
	 */
	public boolean persistant;


	/**
	 *  Sends a trigger to the receiver, along with the current GPSInfo.
	 *
	 *@param  gi  Current GPSInfo.
	 */
	public void trigger( GPSInfo gi )
	{
		receiver.trigger( this, gi );
	}
}