radial_geofence.proto

// Copyright 2020-2024 SIX AFTER, INC (SIX AFTER)
//
// SPDX-License-Identifier: Apache-2.0
// SPDX-FileCopyrightText: SIX AFTER, INC (SIX AFTER)
//
// 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 applicable 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.

syntax="proto3";

package sixafter.types;

option go_package="github.com/sixafter/types;types";
option cc_enable_arenas = true;
option java_package = "com.sixafter.types";
option java_multiple_files = true;
option java_outer_classname = "RadialGeofenceProto";
option objc_class_prefix = "TPB";
option csharp_namespace = "SixAfter.Types.WellKnownTypes";

import "geospatial_coordinate.proto";

// The `RadialGeofence` message represents a circular geofence.
// A geofence is a virtual perimeter defined for a real-world geographic area.
// The radial geofence is defined by a center point and a radius, forming a circular boundary.
// It is commonly used in applications like location-based alerts, tracking, and geofencing.
message RadialGeofence {

  // The name of this geofence.
  // Example: "Warehouse Perimeter", "Restricted Zone".
  string name = 1;

  // The geospatial coordinate representing the center of the circular geofence.
  // This is the point around which the radius is applied to form the boundary.
  // Example: The center coordinate for Westlake, Texas, with latitude `32.9829` and longitude `-97.1876`.
  GeospatialCoordinate center = 2;

  // The radius of the circular geofence, measured in meters.
  // This defines the distance from the center point to the boundary of the geofence.
  // Example: A radius of `500` meters creates a circular geofence with a 1-kilometer diameter.
  double radius = 3;
}