public class

CircularRegion

extends Object
java.lang.Object
   ↳ com.urbanairship.location.CircularRegion

Class Overview

A CircularRegion defines a circular region with a radius, latitude and longitude.

Summary

Constants
int MAX_RADIUS The maximum radius for a region event in meters.
Public Constructors
CircularRegion(double radius, double latitude, double longitude)
Constructor for creating a circular region.
Public Methods
double getLatitude()
Gets the circular region's latitude in degrees.
double getLongitude()
Gets the circular region's longitude in degrees.
double getRadius()
Gets the circular region's radius in meters.
boolean isValid()
Validates the circular region object.
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final int MAX_RADIUS

The maximum radius for a region event in meters.

Constant Value: 100000 (0x000186a0)

Public Constructors

public CircularRegion (double radius, double latitude, double longitude)

Constructor for creating a circular region.

Parameters
radius The radius of the circular region in meters.
latitude The latitude of the circular region's center point in degrees.
longitude The longitude of the circular region's center point in degrees.

Public Methods

public double getLatitude ()

Gets the circular region's latitude in degrees.

Returns
  • The latitude in degrees.

public double getLongitude ()

Gets the circular region's longitude in degrees.

Returns
  • The longitude in degrees.

public double getRadius ()

Gets the circular region's radius in meters.

Returns
  • The radius in meters.

public boolean isValid ()

Validates the circular region object.

Returns
  • True if the circular region is valid, false otherwise.