workbench.main

Class AUV

java.lang.Object

workbench.main.AUV

All Implemented Interfaces:

Serializable, Cloneable, Comparable

public class AUV
extends Object
implements Comparable, Serializable, Cloneable

Filename : AUV.class Description : Data structure for AUV information (not used). This is to be used for multiple AUVs in the same scene. TO map to AUVWorkbench XML configuration file

   
           AUV in Beach Tank 1
           111.222.333.444
           1234
           1
           1
           2
   
 

Created Date : 07 November 2003 Revised Date : 12 November 2003 Course : Thesis Program : Thesis Compiler : JDK 1.4.2 onwards Platform : Windows 2000/Windows XP

Version:

1.0

Author:

Lee, Chin Siong Daryl

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AUV() constructor
AUV(int index, String sGroup, int iPort, int appID, int siteID, int entityID, String sDesc) constructor

Method Summary

Modifier and Type	Method and Description
Object	clone() make a copy (shallow copy) http://www.javaworld.com/javaworld/jw-01-1999/jw-01-object_p.html "How to avoid traps and correctly override methods from java.lang.Object"
int	compareTo(Object aAUV) means to compare 2 Mission Plans
int	getApplicationID() get Application ID
String	getDesc() get Description
int	getEntityID() get Entity ID
int	getIndex() get AUV Number/Index
String	getMulticastGroup() get Multicast Group
int	getMulticastPort() get Multicast Port
int	getSiteID() get Site ID
void	setApplicationID(int aID) get Application ID
void	setDesc(String sDesc) set Description
void	setEntityID(int aID) get Entity ID
void	setIndex(int aIdx) set AUV Number/Index
void	setMulticastGroup(String sGroup) set Multicast Group
void	setMulticastPort(int sPort) set Multicast Port
void	setSiteID(int aID) get Site ID
void	setValue(AUV anAUV) set Value
String	toString() get Mission Point information

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AUV

public AUV()

constructor

AUV

public AUV(int index,
           String sGroup,
           int iPort,
           int appID,
           int siteID,
           int entityID,
           String sDesc)

constructor

Parameters:

index - index

sGroup - Multicast Group

iPort - Multicast Port

appID - Application ID

siteID - Site ID

entityID - Entity ID

sDesc - Description

Method Detail

getDesc

public String getDesc()

get Description

Returns:

String value

setDesc

public void setDesc(String sDesc)

set Description

Parameters:

sDesc - String value

getIndex

public int getIndex()

get AUV Number/Index

Returns:

numeric value

setIndex

public void setIndex(int aIdx)

set AUV Number/Index

Parameters:

aIdx - numeric value

getMulticastGroup

public String getMulticastGroup()

get Multicast Group

Returns:

String value

setMulticastGroup

public void setMulticastGroup(String sGroup)

set Multicast Group

Parameters:

sGroup - String value

getMulticastPort

public int getMulticastPort()

get Multicast Port

Returns:

String value

setMulticastPort

public void setMulticastPort(int sPort)

set Multicast Port

Parameters:

sPort - String value

getApplicationID

public int getApplicationID()

get Application ID

Returns:

numeric value

setApplicationID

public void setApplicationID(int aID)

get Application ID

Parameters:

aID - numeric value

getSiteID

public int getSiteID()

get Site ID

Returns:

numeric value

setSiteID

public void setSiteID(int aID)

get Site ID

Parameters:

aID - numeric value

getEntityID

public int getEntityID()

get Entity ID

Returns:

numeric value

setEntityID

public void setEntityID(int aID)

get Entity ID

Parameters:

aID - numeric value

setValue

public void setValue(AUV anAUV)

set Value

Parameters:

anAUV - AUV to be set

clone

public Object clone()
             throws CloneNotSupportedException

make a copy (shallow copy) http://www.javaworld.com/javaworld/jw-01-1999/jw-01-object_p.html "How to avoid traps and correctly override methods from java.lang.Object"

Overrides:

clone in class Object

Returns:

a copy of the object

Throws:

CloneNotSupportedException - an exception

compareTo

public int compareTo(Object aAUV)

means to compare 2 Mission Plans

Specified by:

compareTo in interface Comparable

Parameters:

aAUV - AUV object to be compare with

Returns:

1 - not same coordinates 0 - same coordinates

toString

public String toString()

get Mission Point information

Overrides:

toString in class Object

Returns:

String value