GraphNodeObject (Autonomous Unmanned Vehicle (AUV) Workbench Documentation)

java.lang.Object
- planner.graphPlan.GraphNodeObject

All Implemented Interfaces:

Comparable

Direct Known Subclasses:

Action, Literal
```
public abstract class GraphNodeObject
extends Object
implements Comparable
```
Abstract class for a graph plan action or literal

Author:

dtdavis

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected class GraphNodeObject.ParameterPairs
Class defining a set of parameter/value pairs that define the literal

Nested Classes
Modifier and Type	Class and Description
`protected class`	`GraphNodeObject.ParameterPairs` Class defining a set of parameter/value pairs that define the literal

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`name` Name assigned to this action of literal
`protected GraphNodeObject.ParameterPairs`	`parameters` A list of parameter/value pairs defining what this literal applies to

Constructor Summary

Constructors
Constructor and Description

GraphNodeObject(String name)
Creates a new instance of GraphNodeObject

Constructors
Constructor and Description
`GraphNodeObject(String name)` Creates a new instance of GraphNodeObject

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addParameter(String[] p)` Adds a parameter/value pair to the object
`void`	`addParameter(String[] p, int index)` Adds a parameter/value pair to the object at a specific place in the list
`void`	`addParameter(String param, String value)` Adds a parameter/value pair to the object
`void`	`addParameter(String param, String value, int index)` Adds a parameter/value pair to the object at a specific place in the list
`int`	`compareTo(Object o)` Implementation of Comparable interface
`void`	`copyParameters(GraphNodeObject object2)` Copies the parameters from the current object to another
`String`	`getName()` Returns a reference to the name of the object
`String[]`	`getParameter(int index)` Returns a requested parameter pair
`abstract boolean`	`match(GraphNodeObject l2)` Compares the GraphNodeObject against another to test for equivalence
`boolean`	`matchParams(GraphNodeObject l2)` Compares this object's parameters against another and returns true if they are equivalent
`int`	`numParameters()` Returns the number of parameters in the set
`void`	`removeParameter(int index)` Removes a parameter/value pair from the object
`String`	`toString()` Converts the GraphNodeObject to a String

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

- Field Detail
  - name
```
protected String name
```
    Name assigned to this action of literal
  - parameters
```
protected GraphNodeObject.ParameterPairs parameters
```
    A list of parameter/value pairs defining what this literal applies to
- Constructor Detail
  - GraphNodeObject
```
public GraphNodeObject(String name)
```
    Creates a new instance of GraphNodeObject
    
    Parameters:
    
    name -
- Method Detail
  - match
```
public abstract boolean match(GraphNodeObject l2)
```
    Compares the GraphNodeObject against another to test for equivalence
    
    Parameters:
    
    l2 -
    
    Returns:
  - getName
```
public String getName()
```
    Returns a reference to the name of the object
    
    Returns:
  - addParameter
```
public void addParameter(String[] p)
```
    Adds a parameter/value pair to the object
    
    Parameters:
    
    p -
  - addParameter
```
public void addParameter(String param,
                         String value)
```
    Adds a parameter/value pair to the object
    
    Parameters:
    
    param -
    
    value -
  - addParameter
```
public void addParameter(String[] p,
                         int index)
```
    Adds a parameter/value pair to the object at a specific place in the list
    
    Parameters:
    
    p -
    
    index -
  - addParameter
```
public void addParameter(String param,
                         String value,
                         int index)
```
    Adds a parameter/value pair to the object at a specific place in the list
    
    Parameters:
    
    param -
    
    value -
    
    index -
  - removeParameter
```
public void removeParameter(int index)
```
    Removes a parameter/value pair from the object
    
    Parameters:
    
    index -
  - copyParameters
```
public void copyParameters(GraphNodeObject object2)
```
    Copies the parameters from the current object to another
    
    Parameters:
    
    object2 -
  - numParameters
```
public int numParameters()
```
    Returns the number of parameters in the set
    
    Returns:
  - getParameter
```
public String[] getParameter(int index)
```
    Returns a requested parameter pair
    
    Parameters:
    
    index -
    
    Returns:
  - matchParams
```
public boolean matchParams(GraphNodeObject l2)
```
    Compares this object's parameters against another and returns true if they are equivalent
    
    Parameters:
    
    l2 -
    
    Returns:
  - compareTo
```
public int compareTo(Object o)
              throws ClassCastException
```
    Implementation of Comparable interface
    
    Specified by:
    
    compareTo in interface Comparable
    
    Throws:
    
    ClassCastException
  - toString
```
public String toString()
```
    Converts the GraphNodeObject to a String
    
    Overrides:
    
    toString in class Object

Class GraphNodeObject

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

name

parameters

Constructor Detail

GraphNodeObject

Method Detail

match

getName

addParameter

addParameter

addParameter

addParameter

removeParameter

copyParameters

numParameters

getParameter

matchParams

compareTo

toString