synergynet3.positioning

Class SynergyNetPosition

java.lang.Object

synergynet3.web.shared.messages.PerformActionMessage

synergynet3.positioning.SynergyNetPosition

All Implemented Interfaces:

java.io.Serializable

public class SynergyNetPosition
extends PerformActionMessage
implements java.io.Serializable

Structured message representing the location of a remote device's interface.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class synergynet3.web.shared.messages.PerformActionMessage

PerformActionMessage.MESSAGESTATE

Constructor Summary

Constructors

Constructor and Description
SynergyNetPosition() Empty Constructor used to initialise value in the network cluster.
SynergyNetPosition(java.lang.String tableIdentity, boolean remove) Create a structured device position message for transmission through the cluster.
SynergyNetPosition(java.lang.String tableIdentity, float x, float y, float rotation, float displayWidth, float displayHeight, float interfaceHeightFromFloor, float pixelWidth) Create a structured device position message for transmission through the cluster.

Method Summary

Methods

Modifier and Type	Method and Description
float	getHeightinMetres() Get the height of the device interface represented.
float	getInterfaceHeightFromFloorinMetres() Get the height from the floor of the device interface represented.
float	getOrientation() Get the rotation of the device interface represented.
float	getPixelWidth() Get the pixel width of the interface represented in pixels.
java.lang.String	getTableID() Get the cluster ID of the device interface represented.
float	getWidthinMetres() Get the width of the device interface represented.
float	getXinMetres() Get the X value of the device interface represented's location.
float	getYinMetres() Get the Y value of the device interface represented's location.
void	setHeightinMetres(float height) Set the height of the device interface represented.
void	setInterfaceHeightFromFloorinMetres(float interfaceHeightFromFloor) Set the height from the floor of the interface represented.
void	setPixelWidth(float pixelWidth) Set the the pixel width of the interface represented in pixels.
void	setRotation(float rotation) Set the rotation of the device interface represented.
void	setTableID(java.lang.String tableID) Set the cluster ID of the device interface represented.
void	setWidthinMetres(float width) Set the width of the device interface represented.
void	setXinMetres(float x) Set the X value of the device interface represented's location.
void	setYinMetres(float y) Set the Y value of the device interface represented's location.

Methods inherited from class synergynet3.web.shared.messages.PerformActionMessage

getMessageID, getMessageState, messageAlreadyReceived, regenerateID

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SynergyNetPosition

public SynergyNetPosition()

Empty Constructor used to initialise value in the network cluster.

SynergyNetPosition

public SynergyNetPosition(java.lang.String tableIdentity,
                  boolean remove)

Create a structured device position message for transmission through the cluster. This message is used to initialise the removal of a virtual device representation.

Parameters:

tableIdentity -

remove -

SynergyNetPosition

public SynergyNetPosition(java.lang.String tableIdentity,
                  float x,
                  float y,
                  float rotation,
                  float displayWidth,
                  float displayHeight,
                  float interfaceHeightFromFloor,
                  float pixelWidth)

Create a structured device position message for transmission through the cluster. This message is used to initialise the creation of a virtual device representation.

Parameters:

tableIdentity - Cluster ID of the device interface represented.

x - X value of location of the device interface represented.

y - Y value of location of the device interface represented.

thisTableAngleDegrees - Rotation of the device interface represented

displayWidth - Width of the device interface represented.

displayHeight - Height of the device interface represented.

pixelWidth - Pixel width of the interface represented.

Method Detail

getHeightinMetres

public float getHeightinMetres()

Get the height of the device interface represented.

Returns:

Float representing the height of the device interface.

getInterfaceHeightFromFloorinMetres

public float getInterfaceHeightFromFloorinMetres()

Get the height from the floor of the device interface represented.

Returns:

Float representing the height from the floor of the device interface.

getOrientation

public float getOrientation()

Get the rotation of the device interface represented.

Returns:

Float representing the rotation of the device interface.

getPixelWidth

public float getPixelWidth()

Get the pixel width of the interface represented in pixels.

Returns:

Float representing the pixel width of the interface represented in pixels.

getTableID

public java.lang.String getTableID()

Get the cluster ID of the device interface represented.

Returns:

String representing the cluster ID of the device interface.

getWidthinMetres

public float getWidthinMetres()

Get the width of the device interface represented.

Returns:

Float representing the width of the device interface.

getXinMetres

public float getXinMetres()

Get the X value of the device interface represented's location.

Returns:

Float representing the X value of the device interface's location.

getYinMetres

public float getYinMetres()

Get the Y value of the device interface represented's location.

Returns:

Float representing the Y value of the device interface's location.

setHeightinMetres

public void setHeightinMetres(float height)

Set the height of the device interface represented.

Parameters:

height - The height of the device interface represented.

setInterfaceHeightFromFloorinMetres

public void setInterfaceHeightFromFloorinMetres(float interfaceHeightFromFloor)

Set the height from the floor of the interface represented.

Parameters:

height - The height from the floor of the device interface represented.

setPixelWidth

public void setPixelWidth(float pixelWidth)

Set the the pixel width of the interface represented in pixels.

Parameters:

pixelWidth - The pixel width of the interface represented in pixels.

setRotation

public void setRotation(float rotation)

Set the rotation of the device interface represented.

Parameters:

rotation - The rotation of the device interface represented.

setTableID

public void setTableID(java.lang.String tableID)

Set the cluster ID of the device interface represented.

Parameters:

tableID - The cluster ID of the device interface represented.

setWidthinMetres

public void setWidthinMetres(float width)

Set the width of the device interface represented.

Parameters:

width - The width of the device interface represented.

setXinMetres

public void setXinMetres(float x)

Set the X value of the device interface represented's location.

Parameters:

x - The X value of the device interface represented's location.

setYinMetres

public void setYinMetres(float y)

Set the Y value of the device interface represented's location.

Parameters:

y - The Y value of the device interface represented's location.