com.google.api.services.spectrum.model.GeoLocationEllipse Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-services-spectrum Show documentation
There is a newer version: v1explorer-rev52-1.24.1
Show newest version
/*
 * Copyright 2010 Google Inc.
 *
 * 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.
 */
/*
 * This code was generated by https://github.com/google/apis-client-generator/
 * (build: 2016-05-04 15:59:39 UTC)
 * on 2016-05-18 at 06:28:13 UTC 
 * Modify at your own risk.
 */

package com.google.api.services.spectrum.model;

/**
 * A "point" with uncertainty is represented using the Ellipse shape.
 *
 *  This is the Java data model class that specifies how to parse/serialize into the JSON that is
 * transmitted over HTTP when working with the Google Spectrum Database API. For a detailed
 * explanation see:
 * https://developers.google.com/api-client-library/java/google-http-java-client/json
 * 
 *
 * @author Google, Inc.
 */
@SuppressWarnings("javadoc")
public final class GeoLocationEllipse extends com.google.api.client.json.GenericJson {

  /**
   * A required geo-spatial point representing the center of the ellipse.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private GeoLocationPoint center;

  /**
   * A floating-point number that expresses the orientation of the ellipse, representing the
   * rotation, in degrees, of the semi-major axis from North towards the East. For example, when the
   * uncertainty is greatest along the North-South direction, orientation is 0 degrees; conversely,
   * if the uncertainty is greatest along the East-West direction, orientation is 90 degrees. When
   * orientation is not present, the orientation is assumed to be 0.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Double orientation;

  /**
   * A floating-point number that expresses the location uncertainty along the major axis of the
   * ellipse. May be required by the regulatory domain. When the uncertainty is optional, the
   * default value is 0.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Double semiMajorAxis;

  /**
   * A floating-point number that expresses the location uncertainty along the minor axis of the
   * ellipse. May be required by the regulatory domain. When the uncertainty is optional, the
   * default value is 0.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Double semiMinorAxis;

  /**
   * A required geo-spatial point representing the center of the ellipse.
   * @return value or {@code null} for none
   */
  public GeoLocationPoint getCenter() {
    return center;
  }

  /**
   * A required geo-spatial point representing the center of the ellipse.
   * @param center center or {@code null} for none
   */
  public GeoLocationEllipse setCenter(GeoLocationPoint center) {
    this.center = center;
    return this;
  }

  /**
   * A floating-point number that expresses the orientation of the ellipse, representing the
   * rotation, in degrees, of the semi-major axis from North towards the East. For example, when the
   * uncertainty is greatest along the North-South direction, orientation is 0 degrees; conversely,
   * if the uncertainty is greatest along the East-West direction, orientation is 90 degrees. When
   * orientation is not present, the orientation is assumed to be 0.
   * @return value or {@code null} for none
   */
  public java.lang.Double getOrientation() {
    return orientation;
  }

  /**
   * A floating-point number that expresses the orientation of the ellipse, representing the
   * rotation, in degrees, of the semi-major axis from North towards the East. For example, when the
   * uncertainty is greatest along the North-South direction, orientation is 0 degrees; conversely,
   * if the uncertainty is greatest along the East-West direction, orientation is 90 degrees. When
   * orientation is not present, the orientation is assumed to be 0.
   * @param orientation orientation or {@code null} for none
   */
  public GeoLocationEllipse setOrientation(java.lang.Double orientation) {
    this.orientation = orientation;
    return this;
  }

  /**
   * A floating-point number that expresses the location uncertainty along the major axis of the
   * ellipse. May be required by the regulatory domain. When the uncertainty is optional, the
   * default value is 0.
   * @return value or {@code null} for none
   */
  public java.lang.Double getSemiMajorAxis() {
    return semiMajorAxis;
  }

  /**
   * A floating-point number that expresses the location uncertainty along the major axis of the
   * ellipse. May be required by the regulatory domain. When the uncertainty is optional, the
   * default value is 0.
   * @param semiMajorAxis semiMajorAxis or {@code null} for none
   */
  public GeoLocationEllipse setSemiMajorAxis(java.lang.Double semiMajorAxis) {
    this.semiMajorAxis = semiMajorAxis;
    return this;
  }

  /**
   * A floating-point number that expresses the location uncertainty along the minor axis of the
   * ellipse. May be required by the regulatory domain. When the uncertainty is optional, the
   * default value is 0.
   * @return value or {@code null} for none
   */
  public java.lang.Double getSemiMinorAxis() {
    return semiMinorAxis;
  }

  /**
   * A floating-point number that expresses the location uncertainty along the minor axis of the
   * ellipse. May be required by the regulatory domain. When the uncertainty is optional, the
   * default value is 0.
   * @param semiMinorAxis semiMinorAxis or {@code null} for none
   */
  public GeoLocationEllipse setSemiMinorAxis(java.lang.Double semiMinorAxis) {
    this.semiMinorAxis = semiMinorAxis;
    return this;
  }

  @Override
  public GeoLocationEllipse set(String fieldName, Object value) {
    return (GeoLocationEllipse) super.set(fieldName, value);
  }

  @Override
  public GeoLocationEllipse clone() {
    return (GeoLocationEllipse) super.clone();
  }

}