com.google.api.services.spectrum.model.AntennaCharacteristics 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;

/**
 * Antenna characteristics provide additional information, such as the antenna height, antenna type,
 * etc. Whether antenna characteristics must be provided in a request depends on the device type and
 * regulatory domain.
 *
 *  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 AntennaCharacteristics extends com.google.api.client.json.GenericJson {

  /**
   * The antenna height in meters. Whether the antenna height is required depends on the device type
   * and the regulatory domain. Note that the height may be negative.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Double height;

  /**
   * If the height is required, then the height type (AGL for above ground level or AMSL for above
   * mean sea level) is also required. The default is AGL.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String heightType;

  /**
   * The height uncertainty in meters. Whether this is required depends on the regulatory domain.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Double heightUncertainty;

  /**
   * The antenna height in meters. Whether the antenna height is required depends on the device type
   * and the regulatory domain. Note that the height may be negative.
   * @return value or {@code null} for none
   */
  public java.lang.Double getHeight() {
    return height;
  }

  /**
   * The antenna height in meters. Whether the antenna height is required depends on the device type
   * and the regulatory domain. Note that the height may be negative.
   * @param height height or {@code null} for none
   */
  public AntennaCharacteristics setHeight(java.lang.Double height) {
    this.height = height;
    return this;
  }

  /**
   * If the height is required, then the height type (AGL for above ground level or AMSL for above
   * mean sea level) is also required. The default is AGL.
   * @return value or {@code null} for none
   */
  public java.lang.String getHeightType() {
    return heightType;
  }

  /**
   * If the height is required, then the height type (AGL for above ground level or AMSL for above
   * mean sea level) is also required. The default is AGL.
   * @param heightType heightType or {@code null} for none
   */
  public AntennaCharacteristics setHeightType(java.lang.String heightType) {
    this.heightType = heightType;
    return this;
  }

  /**
   * The height uncertainty in meters. Whether this is required depends on the regulatory domain.
   * @return value or {@code null} for none
   */
  public java.lang.Double getHeightUncertainty() {
    return heightUncertainty;
  }

  /**
   * The height uncertainty in meters. Whether this is required depends on the regulatory domain.
   * @param heightUncertainty heightUncertainty or {@code null} for none
   */
  public AntennaCharacteristics setHeightUncertainty(java.lang.Double heightUncertainty) {
    this.heightUncertainty = heightUncertainty;
    return this;
  }

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

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

}