TLcdASTERIXPrecipitationZone (LuciadFusion API documentation)

java.lang.Object
- com.luciad.format.asterix.TLcdASTERIXPrecipitationZone

All Implemented Interfaces:

ILcdDataObject, ILcdBounded, ILcdShape, ILcdShapeList, ILcdCloneable, ~~ILcdFeatured~~ , Serializable, Cloneable
```
public class TLcdASTERIXPrecipitationZone
extends Object
implements ILcdShapeList, ILcdBounded, 
ILcdFeatured
, ILcdDataObject
```
TLcdASTERIXPrecipitationZone models a set of geometries with the same precipitation intensity. The intensity can be retrieve with getIntensity(). TLcdASTERIXPrecipitationZone implements ILcdShapeList where all the shapes are instance of ILcd2DEditablePolyline.

Since:

2015.0

See Also:

Serialized Form

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`canSetFeature(int aIndex)` Checks whether the specified feature is editable.
`Object`	`clone()` Makes `Object.clone()` public.
`boolean`	`contains2D(double aX, double aY)` Checks whether this `ILcdShape` contains the given point in the 2D space.
`boolean`	`contains2D(ILcdPoint aPoint)` Checks whether this `ILcdShape` contains the given `ILcdPoint` in the 2D space.
`boolean`	`contains3D(double aX, double aY, double aZ)` Checks whether this `ILcdShape` contains the given point in the 3D space.
`boolean`	`contains3D(ILcdPoint aPoint)` Checks whether this `ILcdShape` contains the given `ILcdPoint` in the 3D space.
`ILcdBounds`	`getBounds()` Returns the `ILcdBounds` by which the geometry of this `ILcdBounded` object is bounded.
`TLcdDataType`	`getDataType()` Returns the type of this data object.
`Object`	`getFeature(int aIndex)` Returns the feature `Object` at the given index.
`int`	`getFeatureCount()` Returns the number of features.
`ILcdPoint`	`getFocusPoint()` Returns the focus point of this `ILcdShape`.
`int`	`getIntensity()` Retrieves the intensity associated with this precipitation zone.
`ILcdShape`	`getShape(int aIndex)` Returns the `ILcdShape` at the given index.
`int`	`getShapeCount()` Returns the number of `ILcdShape` objects in the list.
`Object`	`getValue(String aPropertyName)` Convenience method that returns the value of the property with the given name.
`Object`	`getValue(TLcdDataProperty aProperty)` Returns the value of the given property.
`boolean`	`hasValue(String aPropertyName)` Indicates whether this data object has a value for the given property.
`boolean`	`hasValue(TLcdDataProperty aProperty)` Indicates whether this data object has a value for the given property.
`void`	`setFeature(int aIndex, Object aFeature)` Sets the feature `Object` at the given index.
`void`	`setValue(String aPropertyName, Object aValue)` Convenience method that sets the value of the property with the given name.
`void`	`setValue(TLcdDataProperty aProperty, Object aValue)` Sets the value of the given property for this data object.

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

- Method Detail
  - getIntensity
```
public int getIntensity()
```
    Retrieves the intensity associated with this precipitation zone.
    
    Returns:
    
    an integer between 0 and 7
  - getFeatureCount
```
public int getFeatureCount()
```
    Description copied from interface: ILcdFeatured
    
    Returns the number of features.
    
    Specified by:
    
    getFeatureCount in interface ILcdFeatured
    
    Returns:
    
    the number of features.
  - getFeature
```
public Object getFeature(int aIndex)
                  throws IndexOutOfBoundsException
```
    Description copied from interface: ILcdFeatured
    
    Returns the feature Object at the given index.
    
    Specified by:
    
    getFeature in interface ILcdFeatured
    
    Parameters:
    
    aIndex - a valid feature index.
    
    Returns:
    
    the feature Object at the given index.
    
    Throws:
    
    IndexOutOfBoundsException - when an index is chosen greater than the result of getFeatureCount.
    
    See Also:
    
    ILcdFeatured.setFeature(int, java.lang.Object)
  - setFeature
```
public void setFeature(int aIndex,
                       Object aFeature)
                throws IllegalArgumentException
```
    Description copied from interface: ILcdFeatured
    
    Sets the feature Object at the given index.
    
    Specified by:
    
    setFeature in interface ILcdFeatured
    
    Parameters:
    
    aIndex - a valid feature index.
    
    aFeature - the new feature Object.
    
    Throws:
    
    IllegalArgumentException - if the feature can't be set.
    
    See Also:
    
    ILcdFeatured.getFeature(int), ILcdFeatured.canSetFeature(int)
  - canSetFeature
```
public boolean canSetFeature(int aIndex)
```
    Description copied from interface: ILcdFeatured
    
    Checks whether the specified feature is editable.
    
    Specified by:
    
    canSetFeature in interface ILcdFeatured
    
    Parameters:
    
    aIndex - a valid feature index.
    
    Returns:
    
    true if the feature can be set, false otherwise.
  - getDataType
```
public TLcdDataType getDataType()
```
    Description copied from interface: ILcdDataObject
    
    Returns the type of this data object. This can never be null.
    
    Specified by:
    
    getDataType in interface ILcdDataObject
    
    Returns:
    
    the type of this data object
  - getValue
```
public Object getValue(TLcdDataProperty aProperty)
```
    Description copied from interface: ILcdDataObject
    
    Returns the value of the given property.
    
    If the property is a collection, the returned value will never be null. If the property has not been set, an empty collection of the appropriate type will be returned (Set, List or Map).
    
    The property must not be null, and must be declared in the data object's type or in one of its super types. Otherwise an IllegalArgumentException is thrown.
    
    Specified by:
    
    getValue in interface ILcdDataObject
    
    Parameters:
    
    aProperty - the property for which the value is to be returned
    
    Returns:
    
    the value of the given property for this data object
  - getValue
```
public Object getValue(String aPropertyName)
```
    Description copied from interface: ILcdDataObject
    
    Convenience method that returns the value of the property with the given name.
    If more than one property exists with the given name, the most specific property should be used (this is the property defined by the most specialized type in this object's data type hierarchy).
    See ILcdDataObject.getValue(TLcdDataProperty) for more information.
    
    Specified by:
    
    getValue in interface ILcdDataObject
    
    Parameters:
    
    aPropertyName - the name of the property of which the value is to be returned
    
    Returns:
    
    the value of the property with the given name
    
    See Also:
    
    TLcdDataType.getProperty(String)
  - setValue
```
public void setValue(TLcdDataProperty aProperty,
                     Object aValue)
```
    Description copied from interface: ILcdDataObject
    
    Sets the value of the given property for this data object. The implementation is allowed to throw an exception if the given value can't be set.
    The given property must be declared in the data object's type or in one of its super types. In other words, getDataType().getProperties().contains( aProperty ) should always be true. Otherwise, the implementation should throw an IllegalArgumentException.
    
    Specified by:
    
    setValue in interface ILcdDataObject
    
    Parameters:
    
    aProperty - the property for which the value is to be set
    
    aValue - the value to set
    
    See Also:
    
    TLcdDataType.getProperty(String)
  - setValue
```
public void setValue(String aPropertyName,
                     Object aValue)
```
    Description copied from interface: ILcdDataObject
    
    Convenience method that sets the value of the property with the given name.
    If more than one property exists with the given name, the most specific property should be used (this is the property defined by the most specialized type in this object's data type hierarchy).
    See ILcdDataObject.setValue(TLcdDataProperty, Object) for more information.
    
    Specified by:
    
    setValue in interface ILcdDataObject
    
    Parameters:
    
    aPropertyName - the name of the property of which the value is to be set
    
    aValue - the value to set
  - hasValue
```
public boolean hasValue(TLcdDataProperty aProperty)
```
    Description copied from interface: ILcdDataObject
    Indicates whether this data object has a value for the given property.
    - aProperty is from the right data type, and this instance has a value for it: returns true
    - aProperty is from the right data type, and this instance has no value for it: returns false
    - aProperty is not from the right data type: not allowed, you will get IllegalArgumentException
    - aProperty is null: not allowed, you will get NullPointerException
    A multivalued property is considered to have a value if it has at least one value.
    Specified by:
    
    hasValue in interface ILcdDataObject
    
    Parameters:
    
    aProperty - the property for which to return whether a value is present or not.
    
    Returns:
    
    true if this data object has a value for the given property, false otherwise.
  - hasValue
```
public boolean hasValue(String aPropertyName)
```
    Description copied from interface: ILcdDataObject
    
    Indicates whether this data object has a value for the given property.
    See ILcdDataObject.hasValue(TLcdDataProperty) for more information.
    
    Specified by:
    
    hasValue in interface ILcdDataObject
    
    Parameters:
    
    aPropertyName - the name of the property for which to return whether a value is present or not.
    
    Returns:
    
    true if this data object has a value for the property with the given name, false otherwise.
  - clone
```
public Object clone()
```
    Description copied from interface: ILcdCloneable
    Makes Object.clone() public.
    When for example extending from java.lang.Object, it can be implemented like this:
```
 public Object clone() {
   try {
     return super.clone();
   } catch ( CloneNotSupportedException e ) {
     // Cannot happen: extends from Object and implements Cloneable (see also Object.clone)
     throw new RuntimeException( e );
   }
 }
 
```
    Specified by:
    
    clone in interface ILcdCloneable
    
    Overrides:
    
    clone in class Object
    
    See Also:
    
    Object.clone()
  - getShapeCount
```
public int getShapeCount()
```
    Description copied from interface: ILcdShapeList
    
    Returns the number of ILcdShape objects in the list.
    
    Specified by:
    
    getShapeCount in interface ILcdShapeList
    
    Returns:
    
    the number of ILcdShape objects in the list.
  - getShape
```
public ILcdShape getShape(int aIndex)
                   throws IndexOutOfBoundsException
```
    Description copied from interface: ILcdShapeList
    
    Returns the ILcdShape at the given index.
    
    Specified by:
    
    getShape in interface ILcdShapeList
    
    Parameters:
    
    aIndex - a valid index in the list of ILcdShape objects.
    
    Returns:
    
    the ILcdShape at the given index.
    
    Throws:
    
    IndexOutOfBoundsException - when the index is not valid.
  - getFocusPoint
```
public ILcdPoint getFocusPoint()
```
    Description copied from interface: ILcdShape
    
    Returns the focus point of this ILcdShape.
    
    Specified by:
    
    getFocusPoint in interface ILcdShape
    
    Returns:
    
    the focus point of this ILcdShape.
  - contains2D
```
public boolean contains2D(ILcdPoint aPoint)
```
    Description copied from interface: ILcdShape
    
    Checks whether this ILcdShape contains the given ILcdPoint in the 2D space. Only the first two dimensions of the ILcdShape and the ILcdPoint are considered.
    
    Specified by:
    
    contains2D in interface ILcdShape
    
    Parameters:
    
    aPoint - the ILcdPoint to test.
    
    Returns:
    
    the boolean result of the containment test.
    
    See Also:
    
    ILcdShape.contains2D(double, double)
  - contains2D
```
public boolean contains2D(double aX,
                          double aY)
```
    Description copied from interface: ILcdShape
    
    Checks whether this ILcdShape contains the given point in the 2D space. Only the first two dimensions of the ILcdShape are considered.
    
    Specified by:
    
    contains2D in interface ILcdShape
    
    Parameters:
    
    aX - the x coordinate of the point.
    
    aY - the y coordinate of the point.
    
    Returns:
    
    the boolean result of the containment test.
  - contains3D
```
public boolean contains3D(ILcdPoint aPoint)
```
    Description copied from interface: ILcdShape
    
    Checks whether this ILcdShape contains the given ILcdPoint in the 3D space.
    
    Specified by:
    
    contains3D in interface ILcdShape
    
    Parameters:
    
    aPoint - the ILcdPoint to test.
    
    Returns:
    
    the boolean result of the containment test.
    
    See Also:
    
    ILcdShape.contains3D(double, double, double)
  - contains3D
```
public boolean contains3D(double aX,
                          double aY,
                          double aZ)
```
    Description copied from interface: ILcdShape
    
    Checks whether this ILcdShape contains the given point in the 3D space.
    
    Specified by:
    
    contains3D in interface ILcdShape
    
    Parameters:
    
    aX - the x coordinate of the point.
    
    aY - the y coordinate of the point.
    
    aZ - the z coordinate of the point.
    
    Returns:
    
    the boolean result of the containment test.
  - getBounds
```
public ILcdBounds getBounds()
```
    Description copied from interface: ILcdBounded
    
    Returns the ILcdBounds by which the geometry of this ILcdBounded object is bounded.
    If the geometry does not allow retrieving valid bounds (for example a polyline with 0 points) the return value is unspecified. It is highly recommended to return an undefined bounds. You can create undefined bounds using the default constructors of TLcdLonLatBounds or TLcdXYBounds.
    
    Specified by:
    
    getBounds in interface ILcdBounded
    
    Returns:
    
    the ILcdBounds by which the geometry of this ILcdBounded object is bounded.

Radar ConnectorsClass TLcdASTERIXPrecipitationZone

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getIntensity

getFeatureCount

getFeature

setFeature

canSetFeature

getDataType

getValue

getValue

setValue

setValue

hasValue

hasValue

clone

getShapeCount

getShape

getFocusPoint

contains2D

contains2D

contains3D

contains3D

getBounds