FourMS
Class FourMSConstants

java.lang.Object
  FourMS.FourMSConstants

public final class FourMSConstants
extends java.lang.Object

This is a class full of constants which are used throughout the 4MS package. It should not be instantiated, the constants are static values.

Field Summary

static int	ACKMSG Indicates that a 4MS message is an ACK message .
static int	ACKNOWLEDGED This is a constant which is used to indicate that a message that has been sent to the 4MS has had it's receipt acknowledged.
static int	BROADCASTMSG Indicates that a 4MS message is an broadcast message.
static int	CMDERRMASK A mask used for stripping out the command error from the cmd error status word
static int	CMDERROR This is the parameter position in an incoming status message from a 4MS which corresponds to the command error
static int	CMDREJECTED Command rejected bit mask .
static int	COMMANDACCEPTED Command accepted bit mask.
static int	COMMANDMSG Indicates that the message is a command message.
static int	COMMANDOK Indicates that the command was okay.
static int	DATARESPONSEMSG Indicates that a 4MS message is a data message .
static int	ENGINEERINGTOLOGICAL This constant indicates that the parameter should be converted from engineering units to logical units.
static java.lang.String	FOURMSCOMMSFAILED Indicates that the comms with the 4MS module are bad
static java.lang.String	FOURMSCOMMSOK Indicates that the comms with the 4MS module are OK
static int	IDLE This constants is used to indicate that a mechanism is idle.
static int	INITIALISING This constants is used to indicate that a mechanism is initialising.
static int	INVALIDFORMAT The message is in an invalid format.
static int	INVALIDFUNCTION An invalid function has been specified .
static int	INVALIDPARAM An invalid parameter has been specified.
static int	LOGICALTOENGINEERING Used to indicate that the conversion to be applied to a 4MS parameter is from logical units to engineering.
static int	MAXSENDRETRIES The maximum number of times that we will attempt to send a message giving up
static int	MECHERROR This is the parameter position in an incoming status message from a 4MS which corresponds to the mechanism error
static int	MECHINTERLOCKED The mechanism is interlocked.
static int	MECHPOSUNDEFINED Constant to represent that the position of the mechanism is undefined
static int	MESSAGETYPE This is the parameter position in an incoming status message from a 4MS which corresponds to the message number
static int	MONMODELISTFULL The monitor mode list is full.
static int	MOVING This constants is used to indicate that a mechanism is moving.
static int	MSGBUFFERSIZE This is the size of the incoming buffer which will be used to store the details of messages coming in from a 4MS transceiver
static int	NOCMDERROR Indicates that there is no command error
static int	NODENAMENOTPRESENT The node name is not present, this is for monitor mode only.
static int	NOMECHERROR Indicates that there is no mechanism error.
static int	OPERATIONCANCELLED The operation has been cancelled.
static int	PARAMOUTOFRANGE Indicates that a parameter specified is out of range.
static int	PORTSERVER This is a type of socket which is to be opened
static int	REPROGRAMMING Indicates that the mechanism is being reprogrammed
static int	SOCKETCLIENT Indicates that we have opened a TCP/IP socket client to a 4MS software simulation
static int	SOCKETSERVER This indicates that we want to use a normal TCP/IP socket when opening up a listening connection
static int	STATUSRESPONSEMSG Indicates that the message is a status response message.
static int	STOPPED This constants is used to indicate that a mechanism has stopped.
static int	SUBACTIONBUSY This is sent in response to query about the state of a subaction when the subaction is busy
static int	SUBACTIONCANCELLED This constant represents the final state of an execution of a subaction.
static int	SUBACTIONCOMPLETEDOK This constant represents the final state of an execution of a subaction.
static int	SUBACTIONFAILED This constant represents the final state of an execution of a subaction.
static int	SUBACTIONIDLE This is a constant which indicates that the associated subaction is idle.
static int	SUBACTIONTIMEDOUT This constant represents the final state of an execution of a subaction.
static int	TASKACTIVE Task active mask.
static int	TIMEOUTBEFORERESEND Timeout waiting for an ACK before sending the message again
static int	TIMERIDLE Indicates if a stopwatch timer is idle.
static int	TIMERRUNNING Indicates if a stopwatch timer is actually running.
static int	UNACKNOWLEDGED This constant is used to indicate that a message was not acknowledged by the 4MS
static int	UNDELIVERABLE This is a constant which is used to indicate that a message bound for the 4MS could not be sent.
static int	UNINITIALISED Constant to represent the fact that a mechanism is not initialised
static int	UNSENT This is a constant which is used to indicate that a message destined for the 4MS has not been sent as yet.
static int	WAITINGACK This is a constant which is used to indicate that a message sent to the four MS has been delivered and waiting acknowledgement

Constructor Summary

FourMSConstants()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

UNSENT

public static final int UNSENT

This is a constant which is used to indicate that a message destined for the 4MS has not been sent as yet.

See Also:

Constant Field Values

UNDELIVERABLE

public static final int UNDELIVERABLE

This is a constant which is used to indicate that a message bound for the 4MS could not be sent.

See Also:

Constant Field Values

ACKNOWLEDGED

public static final int ACKNOWLEDGED

This is a constant which is used to indicate that a message that has been sent to the 4MS has had it's receipt acknowledged.

See Also:

Constant Field Values

SUBACTIONIDLE

public static final int SUBACTIONIDLE

This is a constant which indicates that the associated subaction is idle.

See Also:

Constant Field Values

SUBACTIONBUSY

public static final int SUBACTIONBUSY

This is sent in response to query about the state of a subaction when the subaction is busy

See Also:

Constant Field Values

SUBACTIONCOMPLETEDOK

public static final int SUBACTIONCOMPLETEDOK

This constant represents the final state of an execution of a subaction. It is used to indicate that the subaction completed okay.

See Also:

Constant Field Values

SUBACTIONTIMEDOUT

public static final int SUBACTIONTIMEDOUT

This constant represents the final state of an execution of a subaction. It is used to indicate that the subaction timed out.

See Also:

Constant Field Values

SUBACTIONFAILED

public static final int SUBACTIONFAILED

This constant represents the final state of an execution of a subaction. It is used to indicate that the subaction failed during it's execution..

See Also:

Constant Field Values

TIMERRUNNING

public static final int TIMERRUNNING

Indicates if a stopwatch timer is actually running.

See Also:

Constant Field Values

TIMERIDLE

public static final int TIMERIDLE

Indicates if a stopwatch timer is idle.

See Also:

Constant Field Values

SOCKETSERVER

public static final int SOCKETSERVER

This indicates that we want to use a normal TCP/IP socket when opening up a listening connection

See Also:

Constant Field Values

LOGICALTOENGINEERING

public static final int LOGICALTOENGINEERING

Used to indicate that the conversion to be applied to a 4MS parameter is from logical units to engineering.

See Also:

Constant Field Values

ENGINEERINGTOLOGICAL

public static final int ENGINEERINGTOLOGICAL

This constant indicates that the parameter should be converted from engineering units to logical units.

See Also:

Constant Field Values

UNACKNOWLEDGED

public static int UNACKNOWLEDGED

This constant is used to indicate that a message was not acknowledged by the 4MS

COMMANDMSG

public static final int COMMANDMSG

Indicates that the message is a command message. This values represents a valid value the MESSAGE ID field of a 4MS message

See Also:

Constant Field Values

STATUSRESPONSEMSG

public static final int STATUSRESPONSEMSG

Indicates that the message is a status response message. This values represents a valid value the MESSAGE ID field of a 4MS message

See Also:

Constant Field Values

ACKMSG

public static final int ACKMSG

Indicates that a 4MS message is an ACK message . This values represents a valid value the MESSAGE ID field of a 4MS message

See Also:

Constant Field Values

PORTSERVER

public static final int PORTSERVER

This is a type of socket which is to be opened

See Also:

Constant Field Values

BROADCASTMSG

public static final int BROADCASTMSG

Indicates that a 4MS message is an broadcast message. This values represents a valid value the MESSAGE ID field of a 4MS message

See Also:

Constant Field Values

DATARESPONSEMSG

public static final int DATARESPONSEMSG

Indicates that a 4MS message is a data message . This values represents a valid value the MESSAGE ID field of a 4MS message

See Also:

Constant Field Values

WAITINGACK

public static final int WAITINGACK

This is a constant which is used to indicate that a message sent to the four MS has been delivered and waiting acknowledgement

See Also:

Constant Field Values

TIMEOUTBEFORERESEND

public static final int TIMEOUTBEFORERESEND

Timeout waiting for an ACK before sending the message again

See Also:

Constant Field Values

MAXSENDRETRIES

public static final int MAXSENDRETRIES

The maximum number of times that we will attempt to send a message giving up

See Also:

Constant Field Values

STOPPED

public static final int STOPPED

This constants is used to indicate that a mechanism has stopped.

See Also:

Constant Field Values

IDLE

public static final int IDLE

This constants is used to indicate that a mechanism is idle.

See Also:

Constant Field Values

MOVING

public static final int MOVING

This constants is used to indicate that a mechanism is moving.

See Also:

Constant Field Values

INITIALISING

public static final int INITIALISING

This constants is used to indicate that a mechanism is initialising.

See Also:

Constant Field Values

REPROGRAMMING

public static final int REPROGRAMMING

Indicates that the mechanism is being reprogrammed

See Also:

Constant Field Values

UNINITIALISED

public static final int UNINITIALISED

Constant to represent the fact that a mechanism is not initialised

See Also:

Constant Field Values

COMMANDOK

public static final int COMMANDOK

Indicates that the command was okay. Used when setting the command error for a status response.

See Also:

Constant Field Values

COMMANDACCEPTED

public static final int COMMANDACCEPTED

Command accepted bit mask. Used when setting the command error for a status response.

See Also:

Constant Field Values

TASKACTIVE

public static final int TASKACTIVE

Task active mask. Used when setting the command error for a status response.

See Also:

Constant Field Values

CMDREJECTED

public static final int CMDREJECTED

Command rejected bit mask . Used when setting the command error for a status response.

See Also:

Constant Field Values

PARAMOUTOFRANGE

public static final int PARAMOUTOFRANGE

Indicates that a parameter specified is out of range. Used when setting the command error for a status response.

See Also:

Constant Field Values

INVALIDPARAM

public static final int INVALIDPARAM

An invalid parameter has been specified. Used when setting the command error for a status response.

See Also:

Constant Field Values

INVALIDFORMAT

public static final int INVALIDFORMAT

The message is in an invalid format. Used when setting the command error for a status response.

See Also:

Constant Field Values

MONMODELISTFULL

public static final int MONMODELISTFULL

The monitor mode list is full. Used when setting the command error for a status response.

See Also:

Constant Field Values

INVALIDFUNCTION

public static final int INVALIDFUNCTION

An invalid function has been specified . Used when setting the command error for a status response.

See Also:

Constant Field Values

MECHINTERLOCKED

public static final int MECHINTERLOCKED

The mechanism is interlocked. Used when setting the command error for a status response.

See Also:

Constant Field Values

OPERATIONCANCELLED

public static final int OPERATIONCANCELLED

The operation has been cancelled. Used when setting the command error for a status response.

See Also:

Constant Field Values

NODENAMENOTPRESENT

public static final int NODENAMENOTPRESENT

The node name is not present, this is for monitor mode only. Used when setting the command error for a status response.

See Also:

Constant Field Values

MECHPOSUNDEFINED

public static final int MECHPOSUNDEFINED

Constant to represent that the position of the mechanism is undefined

See Also:

Constant Field Values

NOMECHERROR

public static final int NOMECHERROR

Indicates that there is no mechanism error. Used when setting the command error for a status response.

See Also:

Constant Field Values

MSGBUFFERSIZE

public static final int MSGBUFFERSIZE

This is the size of the incoming buffer which will be used to store the details of messages coming in from a 4MS transceiver

See Also:

Constant Field Values

SUBACTIONCANCELLED

public static final int SUBACTIONCANCELLED

This constant represents the final state of an execution of a subaction. It is used to indicate that the subaction was cancelled

See Also:

Constant Field Values

SOCKETCLIENT

public static final int SOCKETCLIENT

Indicates that we have opened a TCP/IP socket client to a 4MS software simulation

See Also:

Constant Field Values

NOCMDERROR

public static final int NOCMDERROR

Indicates that there is no command error

See Also:

Constant Field Values

CMDERRMASK

public static final int CMDERRMASK

A mask used for stripping out the command error from the cmd error status word

See Also:

Constant Field Values

MESSAGETYPE

public static final int MESSAGETYPE

This is the parameter position in an incoming status message from a 4MS which corresponds to the message number

See Also:

Constant Field Values

MECHERROR

public static final int MECHERROR

This is the parameter position in an incoming status message from a 4MS which corresponds to the mechanism error

See Also:

Constant Field Values

CMDERROR

public static final int CMDERROR

This is the parameter position in an incoming status message from a 4MS which corresponds to the command error

See Also:

Constant Field Values

FOURMSCOMMSOK

public static final java.lang.String FOURMSCOMMSOK

Indicates that the comms with the 4MS module are OK

See Also:

Constant Field Values

FOURMSCOMMSFAILED

public static final java.lang.String FOURMSCOMMSFAILED

Indicates that the comms with the 4MS module are bad

See Also:

Constant Field Values

Constructor Detail

FourMSConstants

public FourMSConstants()