me.adaptive.arp.api.Geolocation Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of adaptive-arp-lib Show documentation
This is the AdaptiveMe Runtime Platform (ARP) API for Java platforms.
The newest version!
/**
--| ADAPTIVE RUNTIME PLATFORM |----------------------------------------------------------------------------------------

(C) Copyright 2013-2015 Carlos Lozano Diez t/a Adaptive.me .

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the
License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 . Unless required by appli-
-cable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS,  WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the  License  for the specific language governing
permissions and limitations under the License.

Original author:

    * Carlos Lozano Diez
            
            
            

Contributors:

    * Ferran Vila Conesa
             
             
             

    * See source code files for contributors.

Release:

    * @version v2.2.15

-------------------------------------------| aut inveniam viam aut faciam |--------------------------------------------
*/

package me.adaptive.arp.api;

import java.io.Serializable;

/**
   Structure representing the data a single geolocation reading.

   @author Francisco Javier Martin Bueno
   @since v2.0
   @version 1.0
*/
public class Geolocation extends APIBean implements Serializable {

     /**
        Java serialization support.
        @since 2.2.13
     */
     private static final long serialVersionUID = 100308101L;

     /**
        The current device altitude (or Z coordinate). Measured in meters.
     */
     private double altitude;
     /**
        The Y coordinate (or latitude). Measured in degrees.
     */
     private double latitude;
     /**
        The X coordinate (or longitude). Measured in degrees.
     */
     private double longitude;
     /**
        Timestamp of the geolocation reading.
     */
     private long timestamp;
     /**
        Dilution of precision on the X measurement. Measured in meters.
     */
     private float xDoP;
     /**
        Dilution of precision on the Y measurement. Measured in meters.
     */
     private float yDoP;

     /**
        Default constructor

        @since v2.0
     */
     public Geolocation() {
     }

     /**
        Constructor with parameters

        @param latitude  Latitude of the measurement
        @param longitude Longitude of the measurement
        @param altitude  Altitude of the measurement
        @param xDoP      Dilution of precision on the X measurement
        @param yDoP      Dilution of precision on the Y measurement
        @param timestamp Timestamp of the measurement
        @since v2.0
     */
     public Geolocation(double latitude, double longitude, double altitude, float xDoP, float yDoP, long timestamp) {
          super();
          this.latitude = latitude;
          this.longitude = longitude;
          this.altitude = altitude;
          this.xDoP = xDoP;
          this.yDoP = yDoP;
          this.timestamp = timestamp;
     }

     /**
        Constructor with parameters

        @param latitude  Latitude of the measurement
        @param longitude Longitude of the measurement
        @param timestamp Timestamp of the measurement
        @since v2.0
     */
     public Geolocation(double latitude, double longitude, long timestamp) {
          super();
          this.latitude = latitude;
          this.longitude = longitude;
          this.timestamp = timestamp;
     }

     /**
        Returns altitude in meters

        @return Altitude of the measurement
        @since v2.0
     */
     public double getAltitude() {
          return this.altitude;
     }

     /**
        Set altitude in meters

        @param altitude Altitude of the measurement
        @since v2.0
     */
     public void setAltitude(double altitude) {
          this.altitude = altitude;
     }

     /**
        Returns the latitude in degrees

        @return Latitude of the measurement
        @since v2.0
     */
     public double getLatitude() {
          return this.latitude;
     }

     /**
        Set the latitude in degrees

        @param latitude Latitude of the measurement
        @since v2.0
     */
     public void setLatitude(double latitude) {
          this.latitude = latitude;
     }

     /**
        Returns the longitude in degrees

        @return Longitude of the measurement
        @since v2.0
     */
     public double getLongitude() {
          return this.longitude;
     }

     /**
        Returns the latitude in degrees

        @param longitude Longitude of the measurement
        @since v2.0
     */
     public void setLongitude(double longitude) {
          this.longitude = longitude;
     }

     /**
        Timestamp Getter

        @return Timestamp
        @since v2.0
     */
     public long getTimestamp() {
          return this.timestamp;
     }

     /**
        Timestamp Setter

        @param timestamp Timestamp
        @since v2.0
     */
     public void setTimestamp(long timestamp) {
          this.timestamp = timestamp;
     }

     /**
        Gets Dilution of precision on the X measurement. Measured in meters.

        @return xDoP Dilution of precision on the X measurement. Measured in meters.
     */
     public float getXDoP() {
          return this.xDoP;
     }

     /**
        Sets Dilution of precision on the X measurement. Measured in meters.

        @param xDoP Dilution of precision on the X measurement. Measured in meters.
     */
     public void setXDoP(float xDoP) {
          this.xDoP = xDoP;
     }

     /**
        Gets Dilution of precision on the Y measurement. Measured in meters.

        @return yDoP Dilution of precision on the Y measurement. Measured in meters.
     */
     public float getYDoP() {
          return this.yDoP;
     }

     /**
        Sets Dilution of precision on the Y measurement. Measured in meters.

        @param yDoP Dilution of precision on the Y measurement. Measured in meters.
     */
     public void setYDoP(float yDoP) {
          this.yDoP = yDoP;
     }


}

/**
------------------------------------| Engineered with ♥ in Barcelona, Catalonia |--------------------------------------
*/