Package org.eclipse.scanning.api.scan.event

Class Location

java.lang.Object

org.eclipse.scanning.api.AbstractNameable

org.eclipse.scanning.api.scan.event.Location

All Implemented Interfaces:

INameable

public class Location
extends AbstractNameable

A location is a json object for notifying over JMS the value of an IScannable. We do not use IPosition directly because this does not have all the information required. A location may be a transient state which a motor is moving through or a notifcation of an intent to move. It can be thought of as a PositionEvent encapsulated in a single JSON object and with context information.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Location.LocationType	Must match method names in IPositionListener as reflection used on the value to call the correct method on the listener.

Constructor Summary

Constructors

Constructor	Description
Location()
Location(Location.LocationType t, PositionEvent evnt)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
int	getLevel()
List<String>	getLevelNames()
IPosition	getPosition()
Location.LocationType	getType()
int	hashCode()
void	setLevel(int level)
void	setLevelNames(List<String> levelNames)
void	setPosition(IPosition position)
void	setType(Location.LocationType type)
String	toString()

Methods inherited from class org.eclipse.scanning.api.AbstractNameable

getName, setName

Methods inherited from class java.lang.Object

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

Constructor Details

Location

public Location()

Location

public Location(Location.LocationType t,
 PositionEvent evnt)

Method Details

getType

public Location.LocationType getType()

setType

public void setType(Location.LocationType type)

getPosition

public IPosition getPosition()

setPosition

public void setPosition(IPosition position)

getLevel

public int getLevel()

setLevel

public void setLevel(int level)

getLevelNames

public List<String> getLevelNames()

setLevelNames

public void setLevelNames(List<String> levelNames)

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractNameable

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractNameable

toString

public String toString()

Overrides:

toString in class AbstractNameable