com.kuka.nav
Class Location

java.lang.Object
  com.kuka.nav.Location

All Implemented Interfaces:

com.kuka.parameters.IParameter, Serializable

public class Location
extends Object
implements com.kuka.parameters.IParameter, Serializable

Objects of this class represent a location in the navigation system. A location consists of a pose on a map with an associated name. A location might also have sensor data and other parameters associated to it.

See Also:

Serialized Form

Constructor Summary

Location(int locId, int mapId, String locName, Pose locPose, int robotTypeId)
Constructs a newly allocated NavigationLocation with the using the given parameters.

Location(Location loc)
Constructs a newly allocated NavigationLocation using the parameters of the given NavigationLocation object.

Method Summary

com.kuka.parameters.IParameter	copy()
boolean	equals(Object obj)
int	getId() Returns the location ID.
int	getMapId() Returns the ID of the map where this location is defined.
String	getName() Returns the name of the location.
Pose	getPose() Returns the pose of the location.
int	getRobotTypeId()
int	hashCode()
boolean	hasSensorData() Returns the flag indicating whether the location has associated sensor data.
String	toString()
Location	withPose(Pose pose) Returns a copy of this location with a changed pose.

Methods inherited from class java.lang.Object

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

Constructor Detail

Location

public Location(int locId,
                int mapId,
                String locName,
                Pose locPose,
                int robotTypeId)

Constructs a newly allocated NavigationLocation with the using the given parameters.

Parameters:

locId - the location id.

mapId - the corresponding map id.

locName - the location name.

locPose - the location pose.

robotTypeId - The robot type id for which sensor data is present or -1 to indicate no sensor data is present.

Location

public Location(Location loc)

Constructs a newly allocated NavigationLocation using the parameters of the given NavigationLocation object.

Parameters:

loc - The NavigationLocation object from which the parameters are going to be taken.

Method Detail

withPose

public Location withPose(Pose pose)

Returns a copy of this location with a changed pose.

Parameters:

pose - The new pose of the location copy.

Returns:

The copy of this location with changed pose.

getId

public int getId()

Returns the location ID.

Returns:

the location ID.

getName

public String getName()

Returns the name of the location.

Returns:

the name of the location.

getMapId

public int getMapId()

Returns the ID of the map where this location is defined.

Returns:

the map ID.

getPose

public Pose getPose()

Returns the pose of the location.

Returns:

the pose of the location.

hasSensorData

public boolean hasSensorData()

Returns the flag indicating whether the location has associated sensor data.

Returns:

flag indicating whether the location has sensor data.

getRobotTypeId

public int getRobotTypeId()

Returns:

The robot type used to record the associated sensor data if hasSensorData() returns true, otherwise -1.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

copy

public com.kuka.parameters.IParameter copy()

Specified by:

copy in interface com.kuka.parameters.IParameter

toString

public String toString()

Overrides:

toString in class Object