aboutsummaryrefslogtreecommitdiffstats
path: root/Java/com/phidgets/event/GPSPositionChangeEvent.java
blob: 42b919958b9e67448668c794a0c96be3c204e33f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
/*
 * Copyright 2006 Phidgets Inc.  All rights reserved.
 */

package com.phidgets.event;

import com.phidgets.Phidget;

/**
 * This class represents the data for a GPSPositionChangeEvent.
 * 
 * @author Phidgets Inc.
 */   
public class GPSPositionChangeEvent
{
	Phidget source;
	double latitude;
	double longitude;
	double altitude;

	/**
	 * Class constructor. This is called internally by the phidget library when creating this event.
	 * 
	 * @param source the Phidget object from which this event originated
	 */
	public GPSPositionChangeEvent(Phidget source, double latitude,	double longitude, double altitude) {
		this.source = source;
		this.latitude = latitude;
		this.longitude = longitude;
		this.altitude = altitude;
	}

	/**
	 * Returns the source Phidget of this event. This is a reference to the Phidget object from which this
	 * event was called. This object can be cast into a specific type of Phidget object to call specific
	 * device calls on it.
	 * 
	 * @return the event caller
	 */
	public Phidget getSource() {
		return source;
	}

	/**
	 * Returns the latitude of the GPS, in signed degrees format.
	 * 
	 * @return the latitude
	 */
	public double getLatitude() {
		return latitude;
	}

	/**
	 * Returns the longitude of the GPS, in signed degrees format
	 * 
	 * @return the longitude
	 */
	public double getLongitude() {
		return longitude;
	}

	/**
	 * Returns the altitude of the GPS, in meters.
	 * 
	 * @return the altitude
	 */
	public double getAltitude() {
		return altitude;
	}
	
	/**
	 * Returns a string containing information about the event.
	 * 
	 * @return an informative event string
	 */
	public String toString() {
		return("Position is - Latitude: "+ latitude + " degrees" +
			", Longitude: " + longitude + " degrees" + ", Altitude: "+ altitude + "m");
	}
}