com.oziexplorer
Class RoutePoint

java.lang.Object
  com.oziexplorer.RoutePoint

public class RoutePoint
extends Object

This class represents route points.

Copyright 2011 Alan Burlison, . All rights reserved. Use is subject to license terms, see LICENSE.txt.

Field Summary

protected int	backColor The background color.
protected Calendar	date The route point date.
protected String	description The route point description.
protected int	displayFormat The display format.
protected int	foreColor The foreground color.
protected int	garminFormat The garmin display format.
protected String	name The route point name.
protected int	pointerDir The pointer direction.
protected Position	position The route point number.
protected int	symbol The route point symbol.
protected int	waypointNumber The associated waypoint number.

Constructor Summary

RoutePoint(int waypointNumber, String name, Position position, Calendar date, int symbol, int displayFormat, int foreColor, int backColor, String description, int pointerDir, int garminFormat)
Create a new route point.

Method Summary

boolean	equals(Object that) Test if two route points are equal.
int	getBackColor() Get the symbol background color.
Calendar	getDate() Get the route point date.
String	getDescription() Get the route point description.
int	getDisplayFormat() Get the route point display format.
int	getForeColor() Get the route point foreground color.
int	getGarminFormat() Get the garmin display format.
String	getName() Get the route point name.
int	getPointerDir() Get the pointer direction.
Position	getPosition() Get the route point position.
int	getSymbol() Get the route point symbol.
int	getWaypointNumber() Get the associated waypoint number.
int	hashCode() Return the hash code for this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

waypointNumber

protected final int waypointNumber

The associated waypoint number.

name

protected final String name

The route point name.

position

protected final Position position

The route point number.

date

protected final Calendar date

The route point date.

symbol

protected final int symbol

The route point symbol.

displayFormat

protected final int displayFormat

The display format.

foreColor

protected final int foreColor

The foreground color.

backColor

protected final int backColor

The background color.

description

protected final String description

The route point description.

pointerDir

protected final int pointerDir

The pointer direction.

garminFormat

protected final int garminFormat

The garmin display format.

Constructor Detail

RoutePoint

public RoutePoint(int waypointNumber,
                  String name,
                  Position position,
                  Calendar date,
                  int symbol,
                  int displayFormat,
                  int foreColor,
                  int backColor,
                  String description,
                  int pointerDir,
                  int garminFormat)

Create a new route point.

Parameters:

waypointNumber - the route point number.

name - the route point name.

position - the route point position.

date - the route point date

symbol - the symbol.

displayFormat - the symbol display format.

foreColor - the symbol foreground color.

backColor - the symbol background color.

description - the description.

pointerDir - the pointer direction.

garminFormat - the garmin display format.

Method Detail

equals

public boolean equals(Object that)

Test if two route points are equal. The position and name are compared.

Overrides:

equals in class Object

Parameters:

that - the object to compare against.

Returns:

true if the objects are equal.

hashCode

public int hashCode()

Return the hash code for this object.

Overrides:

hashCode in class Object

Returns:

the hash code for this object.

getBackColor

public int getBackColor()

Get the symbol background color.

Returns:

the symbol background color.

getDate

public Calendar getDate()

Get the route point date.

Returns:

the route point date.

getDescription

public String getDescription()

Get the route point description.

Returns:

the route point description.

getDisplayFormat

public int getDisplayFormat()

Get the route point display format.

Returns:

the route point display format.

getForeColor

public int getForeColor()

Get the route point foreground color.

Returns:

the route point foreground color.

getGarminFormat

public int getGarminFormat()

Get the garmin display format.

Returns:

the garmin display format.

getName

public String getName()

Get the route point name.

Returns:

the route point name.

getPointerDir

public int getPointerDir()

Get the pointer direction.

Returns:

the pointer direction.

getPosition

public Position getPosition()

Get the route point position.

Returns:

the route point position.

getSymbol

public int getSymbol()

Get the route point symbol.

Returns:

the route point symbol.

getWaypointNumber

public int getWaypointNumber()

Get the associated waypoint number.

Returns:

the associated waypoint number.