WorldObjectList (Autonomous Unmanned Vehicle (AUV) Workbench Documentation)

java.lang.Object
- execution.world.WorldObjectList<ObjectType>

All Implemented Interfaces:

Iterable<ObjectType>
```
public class WorldObjectList<ObjectType extends WorldObject>
extends Object
implements Iterable<ObjectType>
```
A container class for holding a list of objects of a specific type that are in the world model MOVES Institute Naval Postgraduate School, Monterey, CA www.nps.edu

Since:

9 April 2009, 10:46:41 AM

Version:

$Id: WorldObjectList.java 9109 2015-07-29 22:39:46Z brutzman $

Author:

Duane Davis

Constructor Summary

Constructors
Constructor and Description

WorldObjectList()

Constructors
Constructor and Description
`WorldObjectList()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(ObjectType newObject)` Adds a new object to the list if it is not already present
`void`	`clear()` Clears all objects from the list
`boolean`	`contains(ObjectType testObject)` Returns true if the List contains the specified object
`ObjectType`	`get(int index)` Returns a reference to a specified object from the world model
`boolean`	`isClearPath(double[] end1, double[] end2)` Determines whether or not a line segment encroaches into any of the objects in the list
`boolean`	`isClearPath(double x1, double y1, double x2, double y2)` Determines whether or not a line segment encroaches into any of the objects in the list
`boolean`	`isClearPath(LineSegment segment)` Determines whether or not a line segment encroaches into any of the objects in the list
`boolean`	`isClearPath(Point end1, Point end2)` Determines whether or not a line segment encroaches into any of the objects in the list
`boolean`	`isClearPoint(double[] point)` Determines whether or not a point encroaches on any of the objects in the list
`boolean`	`isClearPoint(double x, double y)` Determines whether or not a point encroaches on any of the objects in the list
`boolean`	`isClearPoint(Point point)` Determines whether or not a point encroaches on any of the objects in the list
`Iterator<ObjectType>`	`iterator()` Implements the Iterable interface
`ObjectType`	`remove(int index)` Removes a stationary object from the world model
`boolean`	`remove(ObjectType toRemove)` Removes a stationary object from the world model
`int`	`size()`
`String`	`toString()` Generates a string representation of the wall object

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

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - WorldObjectList
```
public WorldObjectList()
```
- Method Detail
  - iterator
```
public Iterator<ObjectType> iterator()
```
    Implements the Iterable interface
    
    Specified by:
    
    iterator in interface Iterable<ObjectType extends WorldObject>
    
    Returns:
    
    an iterator over the contained objects
  - clear
```
public void clear()
```
    Clears all objects from the list
  - add
```
public void add(ObjectType newObject)
```
    Adds a new object to the list if it is not already present
    
    Parameters:
    
    newObject -
  - get
```
public ObjectType get(int index)
```
    Returns a reference to a specified object from the world model
    
    Parameters:
    
    index - the object to be removed
    
    Returns:
    
    the object referred to by the index (or null)
  - remove
```
public ObjectType remove(int index)
```
    Removes a stationary object from the world model
    
    Parameters:
    
    index - index of the object to be removed
    
    Returns:
    
    the removed object (or null)
  - remove
```
public boolean remove(ObjectType toRemove)
```
    Removes a stationary object from the world model
    
    Parameters:
    
    toRemove - the object to be removed
    
    Returns:
    
    true or false depending on whether or not the object was actually present
  - contains
```
public boolean contains(ObjectType testObject)
```
    Returns true if the List contains the specified object
    
    Parameters:
    
    testObject -
    
    Returns:
    
    boolean
  - size
```
public int size()
```
    Returns:
    
    the number of objects contained in the list
  - isClearPoint
```
public boolean isClearPoint(double[] point)
```
    Determines whether or not a point encroaches on any of the objects in the list
    
    Parameters:
    
    point -
    
    Returns:
    
    true if the is no closer to any object than the standoff
  - isClearPoint
```
public boolean isClearPoint(Point point)
```
    Determines whether or not a point encroaches on any of the objects in the list
    
    Parameters:
    
    point -
    
    Returns:
    
    true if the is no closer to any object than the standoff
  - isClearPoint
```
public boolean isClearPoint(double x,
                            double y)
```
    Determines whether or not a point encroaches on any of the objects in the list
    
    Parameters:
    
    x - the x coordinate of the point being tested
    
    y - the y coordinate of the point being tested
    
    Returns:
    
    true if the segment does not pass closer to any object than the standoff
  - isClearPath
```
public boolean isClearPath(LineSegment segment)
```
    Determines whether or not a line segment encroaches into any of the objects in the list
    
    Parameters:
    
    segment -
    
    Returns:
    
    true if the segment does not pass closer to any object than the standoff
  - isClearPath
```
public boolean isClearPath(Point end1,
                           Point end2)
```
    Determines whether or not a line segment encroaches into any of the objects in the list
    
    Parameters:
    
    end1 - the first end point of the segment
    
    end2 - the second end point of the segment
    
    Returns:
    
    true if the segment does not pass closer to any object than the standoff
  - isClearPath
```
public boolean isClearPath(double[] end1,
                           double[] end2)
```
    Determines whether or not a line segment encroaches into any of the objects in the list
    
    Parameters:
    
    end1 - the first end point of the segment
    
    end2 - the second end point of the segment
    
    Returns:
    
    true if the segment does not pass closer to any object than the standoff
  - isClearPath
```
public boolean isClearPath(double x1,
                           double y1,
                           double x2,
                           double y2)
```
    Determines whether or not a line segment encroaches into any of the objects in the list
    
    Parameters:
    
    x1 - coordinate for the first end point of the segment
    
    y1 - coordinate for the first end point of the segment
    
    x2 - coordinate for the second end point of the segment
    
    y2 - coordinate for the second end point of the segment
    
    Returns:
    
    true if the segment does not pass closer to any object than the standoff
  - toString
```
public String toString()
```
    Generates a string representation of the wall object
    
    Overrides:
    
    toString in class Object

Class WorldObjectList<ObjectType extends WorldObject>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

WorldObjectList

Method Detail

iterator

clear

add

get

remove

remove

contains

size

isClearPoint

isClearPoint

isClearPoint

isClearPath

isClearPath

isClearPath

isClearPath

toString