LatLonAltBox (a Java API for Kml 2.2.1 API)

java.lang.Object
- de.micromata.opengis.kml.v_2_2_0.AbstractObject
- - de.micromata.opengis.kml.v_2_2_0.AbstractLatLonBox
  - - de.micromata.opengis.kml.v_2_2_0.LatLonAltBox

All Implemented Interfaces:

Cloneable
```
public class LatLonAltBox
extends AbstractLatLonBox
implements Cloneable
```
(required)
A bounding box that describes an area of interest defined by geographic coordinates and altitudes. Default values and required fields are as follows:

Field Summary

Fields
Modifier and Type	Field and Description
`protected AltitudeMode`	`altitudeMode` AltitudeMode clampToGround, relativeToGround, absolute See Also: See and
`protected List<AbstractObject>`	`latLonAltBoxObjectExtension`
`protected List<Object>`	`latLonAltBoxSimpleExtension`
`protected double`	`maxAltitude` Specified in meters (and is affected by the altitude mode specification).
`protected double`	`minAltitude` Specified in meters (and is affected by the altitude mode specification).

Fields inherited from class de.micromata.opengis.kml.v_2_2_0.AbstractLatLonBox
abstractLatLonBoxObjectExtension, abstractLatLonBoxSimpleExtension, east, north, south, west

Fields inherited from class de.micromata.opengis.kml.v_2_2_0.AbstractObject
id, objectSimpleExtension, targetId

Constructor Summary

Constructors
Constructor and Description

LatLonAltBox()

Constructors
Constructor and Description
`LatLonAltBox()`

Method Summary

Methods
Modifier and Type	Method and Description
`LatLonAltBox`	`addToAbstractLatLonBoxObjectExtension(AbstractObject abstractLatLonBoxObjectExtension)` add a value to the abstractLatLonBoxObjectExtension property collection
`LatLonAltBox`	`addToAbstractLatLonBoxSimpleExtension(Object abstractLatLonBoxSimpleExtension)` add a value to the abstractLatLonBoxSimpleExtension property collection
`LatLonAltBox`	`addToLatLonAltBoxObjectExtension(AbstractObject latLonAltBoxObjectExtension)` add a value to the latLonAltBoxObjectExtension property collection
`LatLonAltBox`	`addToLatLonAltBoxSimpleExtension(Object latLonAltBoxSimpleExtension)` add a value to the latLonAltBoxSimpleExtension property collection
`LatLonAltBox`	`addToObjectSimpleExtension(Object objectSimpleExtension)` add a value to the objectSimpleExtension property collection
`LatLonAltBox`	`clone()`
`boolean`	`equals(Object obj)`
`AltitudeMode`	`getAltitudeMode()`
`List<AbstractObject>`	`getLatLonAltBoxObjectExtension()`
`List<Object>`	`getLatLonAltBoxSimpleExtension()`
`double`	`getMaxAltitude()`
`double`	`getMinAltitude()`
`int`	`hashCode()`
`void`	`setAbstractLatLonBoxObjectExtension(List<AbstractObject> abstractLatLonBoxObjectExtension)`
`void`	`setAbstractLatLonBoxSimpleExtension(List<Object> abstractLatLonBoxSimpleExtension)`
`void`	`setAltitudeMode(AltitudeMode value)`
`void`	`setLatLonAltBoxObjectExtension(List<AbstractObject> latLonAltBoxObjectExtension)`
`void`	`setLatLonAltBoxSimpleExtension(List<Object> latLonAltBoxSimpleExtension)`
`void`	`setMaxAltitude(double value)`
`void`	`setMinAltitude(double value)`
`void`	`setObjectSimpleExtension(List<Object> objectSimpleExtension)`
`LatLonAltBox`	`withAbstractLatLonBoxObjectExtension(List<AbstractObject> abstractLatLonBoxObjectExtension)` fluent setter
`LatLonAltBox`	`withAbstractLatLonBoxSimpleExtension(List<Object> abstractLatLonBoxSimpleExtension)` fluent setter
`LatLonAltBox`	`withAltitudeMode(AltitudeMode altitudeMode)` fluent setter
`LatLonAltBox`	`withEast(double east)` fluent setter
`LatLonAltBox`	`withId(String id)` fluent setter
`LatLonAltBox`	`withLatLonAltBoxObjectExtension(List<AbstractObject> latLonAltBoxObjectExtension)` fluent setter
`LatLonAltBox`	`withLatLonAltBoxSimpleExtension(List<Object> latLonAltBoxSimpleExtension)` fluent setter
`LatLonAltBox`	`withMaxAltitude(double maxAltitude)` fluent setter
`LatLonAltBox`	`withMinAltitude(double minAltitude)` fluent setter
`LatLonAltBox`	`withNorth(double north)` fluent setter
`LatLonAltBox`	`withObjectSimpleExtension(List<Object> objectSimpleExtension)` fluent setter
`LatLonAltBox`	`withSouth(double south)` fluent setter
`LatLonAltBox`	`withTargetId(String targetId)` fluent setter
`LatLonAltBox`	`withWest(double west)` fluent setter

Methods inherited from class de.micromata.opengis.kml.v_2_2_0.AbstractLatLonBox
getAbstractLatLonBoxObjectExtension, getAbstractLatLonBoxSimpleExtension, getEast, getNorth, getSouth, getWest, setEast, setNorth, setSouth, setWest

Methods inherited from class de.micromata.opengis.kml.v_2_2_0.AbstractObject
getId, getObjectSimpleExtension, getTargetId, setId, setTargetId

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - minAltitude
```
protected double minAltitude
```
    Specified in meters (and is affected by the altitude mode specification).
  - maxAltitude
```
protected double maxAltitude
```
    Specified in meters (and is affected by the altitude mode specification).
  - altitudeMode
```
protected AltitudeMode altitudeMode
```
    AltitudeMode
    clampToGround, relativeToGround, absolute
    See Also: See and
  - latLonAltBoxSimpleExtension
```
protected List<Object> latLonAltBoxSimpleExtension
```
  - latLonAltBoxObjectExtension
```
protected List<AbstractObject> latLonAltBoxObjectExtension
```
    This is an abstract base class and cannot be used directly in a KML file. It provides the id attribute, which allows unique identification of a KML element, and the targetId attribute, which is used to reference objects that have already been loaded into Google Earth. The id attribute must be assigned if the mechanism is to be used.
    Syntax:
      
    
    Constructor Detail
    
    LatLonAltBox
    
    public LatLonAltBox()
    
    Method Detail
    
    getMinAltitude
    
    public double getMinAltitude()
    
    Returns:
    possible object is Double
    See Also:
    minAltitude
    
    setMinAltitude
    
    public void setMinAltitude(double value)
    
    Parameters:
    value - allowed object is Double
    See Also:
    minAltitude
    
    getMaxAltitude
    
    public double getMaxAltitude()
    
    Returns:
    possible object is Double
    See Also:
    maxAltitude
    
    setMaxAltitude
    
    public void setMaxAltitude(double value)
    
    Parameters:
    value - allowed object is Double
    See Also:
    maxAltitude
    
    getAltitudeMode
    
    public AltitudeMode getAltitudeMode()
    
    Returns:
    possible object is <Object <AltitudeMode <de.micromata.opengis.kml.v_2_2_0.gx.AltitudeMode
    See Also:
    altitudeMode
    
    setAltitudeMode
    
    public void setAltitudeMode(AltitudeMode value)
    
    Parameters:
    value - allowed object is <Object <AltitudeMode <de.micromata.opengis.kml.v_2_2_0.gx.AltitudeMode
    See Also:
    altitudeMode
    
    getLatLonAltBoxSimpleExtension
    
    public List<Object> getLatLonAltBoxSimpleExtension()
    
    See Also:
    latLonAltBoxSimpleExtension
    
    getLatLonAltBoxObjectExtension
    
    public List<AbstractObject> getLatLonAltBoxObjectExtension()
    
    See Also:
    latLonAltBoxObjectExtension
    
    hashCode
    
    public int hashCode()
    
    Overrides:
    
    hashCode in class AbstractLatLonBox
    
    equals
    
    public boolean equals(Object obj)
    
    Overrides:
    
    equals in class AbstractLatLonBox
    
    setLatLonAltBoxSimpleExtension
    
    public void setLatLonAltBoxSimpleExtension(List<Object> latLonAltBoxSimpleExtension)
    
    Parameters:
    latLonAltBoxSimpleExtension -
    See Also:
    latLonAltBoxSimpleExtension
    
    addToLatLonAltBoxSimpleExtension
    
    public LatLonAltBox addToLatLonAltBoxSimpleExtension(Object latLonAltBoxSimpleExtension)
    
    add a value to the latLonAltBoxSimpleExtension property collection
    
    Parameters:
    latLonAltBoxSimpleExtension - Objects of the following type are allowed in the list: Object
    
    Returns:
    true (as general contract of Collection.add).
    
    setLatLonAltBoxObjectExtension
    
    public void setLatLonAltBoxObjectExtension(List<AbstractObject> latLonAltBoxObjectExtension)
    
    Parameters:
    latLonAltBoxObjectExtension -
    See Also:
    latLonAltBoxObjectExtension
    
    addToLatLonAltBoxObjectExtension
    
    public LatLonAltBox addToLatLonAltBoxObjectExtension(AbstractObject latLonAltBoxObjectExtension)
    
    add a value to the latLonAltBoxObjectExtension property collection
    
    Parameters:
    latLonAltBoxObjectExtension - Objects of the following type are allowed in the list: AbstractObject
    
    Returns:
    true (as general contract of Collection.add).
    
    setObjectSimpleExtension
    
    public void setObjectSimpleExtension(List<Object> objectSimpleExtension)
    
    Overrides:
    
    setObjectSimpleExtension in class AbstractLatLonBox
    
    See Also:
    objectSimpleExtension
    
    addToObjectSimpleExtension
    
    public LatLonAltBox addToObjectSimpleExtension(Object objectSimpleExtension)
    
    Description copied from class: AbstractObject
    
    add a value to the objectSimpleExtension property collection
    
    Overrides:
    
    addToObjectSimpleExtension in class AbstractLatLonBox
    
    Parameters:
    objectSimpleExtension - Objects of the following type are allowed in the list: Object
    
    Returns:
    true (as general contract of Collection.add).
    
    setAbstractLatLonBoxSimpleExtension
    
    public void setAbstractLatLonBoxSimpleExtension(List<Object> abstractLatLonBoxSimpleExtension)
    
    Overrides:
    
    setAbstractLatLonBoxSimpleExtension in class AbstractLatLonBox
    
    See Also:
    abstractLatLonBoxSimpleExtension
    
    addToAbstractLatLonBoxSimpleExtension
    
    public LatLonAltBox addToAbstractLatLonBoxSimpleExtension(Object abstractLatLonBoxSimpleExtension)
    
    Description copied from class: AbstractLatLonBox
    
    add a value to the abstractLatLonBoxSimpleExtension property collection
    
    Overrides:
    
    addToAbstractLatLonBoxSimpleExtension in class AbstractLatLonBox
    
    Parameters:
    abstractLatLonBoxSimpleExtension - Objects of the following type are allowed in the list: Object
    
    Returns:
    true (as general contract of Collection.add).
    
    setAbstractLatLonBoxObjectExtension
    
    public void setAbstractLatLonBoxObjectExtension(List<AbstractObject> abstractLatLonBoxObjectExtension)
    
    Overrides:
    
    setAbstractLatLonBoxObjectExtension in class AbstractLatLonBox
    
    See Also:
    abstractLatLonBoxObjectExtension
    
    addToAbstractLatLonBoxObjectExtension
    
    public LatLonAltBox addToAbstractLatLonBoxObjectExtension(AbstractObject abstractLatLonBoxObjectExtension)
    
    Description copied from class: AbstractLatLonBox
    
    add a value to the abstractLatLonBoxObjectExtension property collection
    
    Overrides:
    
    addToAbstractLatLonBoxObjectExtension in class AbstractLatLonBox
    
    Parameters:
    abstractLatLonBoxObjectExtension - Objects of the following type are allowed in the list: AbstractObject
    
    Returns:
    true (as general contract of Collection.add).
    
    withMinAltitude
    
    public LatLonAltBox withMinAltitude(double minAltitude)
    
    fluent setter
    
    Parameters:
    minAltitude - required parameter
    See Also:
    setMinAltitude(double)
    
    withMaxAltitude
    
    public LatLonAltBox withMaxAltitude(double maxAltitude)
    
    fluent setter
    
    Parameters:
    maxAltitude - required parameter
    See Also:
    setMaxAltitude(double)
    
    withAltitudeMode
    
    public LatLonAltBox withAltitudeMode(AltitudeMode altitudeMode)
    
    fluent setter
    
    Parameters:
    altitudeMode - required parameter
    See Also:
    #setAltitudeMode(Object)
    
    withLatLonAltBoxSimpleExtension
    
    public LatLonAltBox withLatLonAltBoxSimpleExtension(List<Object> latLonAltBoxSimpleExtension)
    
    fluent setter
    
    Parameters:
    latLonAltBoxSimpleExtension - required parameter
    See Also:
    #setLatLonAltBoxSimpleExtension(List

Class LatLonAltBox

Field Summary

Fields inherited from class de.micromata.opengis.kml.v_2_2_0.AbstractLatLonBox

Fields inherited from class de.micromata.opengis.kml.v_2_2_0.AbstractObject

Constructor Summary

Method Summary

Methods inherited from class de.micromata.opengis.kml.v_2_2_0.AbstractLatLonBox

Methods inherited from class de.micromata.opengis.kml.v_2_2_0.AbstractObject

Methods inherited from class java.lang.Object

Field Detail

minAltitude

maxAltitude

altitudeMode

latLonAltBoxSimpleExtension

latLonAltBoxObjectExtension

Constructor Detail

LatLonAltBox

Method Detail

getMinAltitude

setMinAltitude

getMaxAltitude

setMaxAltitude

getAltitudeMode

setAltitudeMode

getLatLonAltBoxSimpleExtension

getLatLonAltBoxObjectExtension

hashCode

equals

setLatLonAltBoxSimpleExtension

addToLatLonAltBoxSimpleExtension

setLatLonAltBoxObjectExtension

addToLatLonAltBoxObjectExtension

setObjectSimpleExtension

addToObjectSimpleExtension

setAbstractLatLonBoxSimpleExtension

addToAbstractLatLonBoxSimpleExtension

setAbstractLatLonBoxObjectExtension

addToAbstractLatLonBoxObjectExtension

withMinAltitude

withMaxAltitude

withAltitudeMode

withLatLonAltBoxSimpleExtension

withLatLonAltBoxObjectExtension

withObjectSimpleExtension

withId

withTargetId

withNorth

withSouth

withEast

withWest

withAbstractLatLonBoxSimpleExtension

withAbstractLatLonBoxObjectExtension

clone