geospatial_elevation.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 = "GeospatialElevationProto";
option objc_class_prefix = "TPB";
option csharp_namespace = "SixAfter.Types.WellKnownTypes";

// The `GeospatialElevation` message represents the vertical direction
// or height of a point relative to a specified reference datum. This
// is commonly used in geolocation, mapping, and geographic information systems (GIS).
message GeospatialElevation {

  // The `GeodeticDatum` enum defines the reference system or surface
  // against which the elevation is measured. These reference systems are
  // approximations of the Earth's surface.
  enum GeodeticDatum {
    // The altitude above mean sea level (MSL), measured in meters.
    // This is a commonly used datum for everyday elevation measurements.
    SEA_LEVEL = 0;

    // The altitude as a height above the World Geodetic System 1984 (WGS84)
    // ellipsoid, measured in meters. This is commonly used in GPS systems.
    WGS_84 = 1;
  }

  // The geodetic datum used as the reference point for the elevation measurement.
  // Example: `SEA_LEVEL` for altitude above mean sea level.
  GeodeticDatum datum = 1;

  // The altitude or vertical elevation of the point, measured in meters.
  // This value can be positive (above the datum) or negative (below the datum).
  // Example: An altitude of 212 meters above sea level for Westlake, Texas.
  double altitude = 2;
}