OCSEPICS
Class OCSEPICSConsts

java.lang.Object
  OCSEPICS.OCSEPICSConsts

public class OCSEPICSConsts
extends java.lang.Object

This is a class which holds constants and enumerations which will be used throughout an OCS EPICS based application.

Version:

1.0

Author:

Craige Bevil

Nested Class Summary

static class	OCSEPICSConsts.ConversionTypes Conversion types which are to be applied
static class	OCSEPICSConsts.IOCSubactionStateType These are the states that an EPICS action can take
static class	OCSEPICSConsts.MechanismActivityStates This enumeration reflects the possible state that a mechanism can be in.
static class	OCSEPICSConsts.OCSActionStatesType This enumeration reflects the states that an EPICS action can be used to model the states of an EPICS action
static class	OCSEPICSConsts.PrematureClStatStates These values will be used to track premature events on the clstat value before command processing is completed.
static class	OCSEPICSConsts.PVTypes This is an enumeration of the types of PV which are associated with an EPICS control action
static class	OCSEPICSConsts.SubactionCompletionStates These values will be used to report the completion state of the subactions
static class	OCSEPICSConsts.SubactionStateType This enumeration reflects the possible state that subactions in the instrument controller can be in.
static class	OCSEPICSConsts.UnitType These are the two types of values which can be associated with PV.

Field Summary

static int	APPLICATIONERROR This will be used to indicate an application related in error when errors are written into the status IDL types.
static java.lang.String	COMMANDACCEPTEDSUCESSFULLY This is the logical value which should be associated with the * COMMSTR PV which indicates that the command was accepted.
static java.lang.String	COMMANDPROCESSING_ACTIVE Used to indicate the various states of the COMMSTAT variable.
static java.lang.String	COMMANDPROCESSING_OK Used to indicate the various states of the COMMSTAT variable.
static java.lang.String	COMMANDPROCESSING_REJECTEDAIP Used to indicate the various states of the COMMSTAT variable.
static java.lang.String	COMMANDPROCESSING_REJECTEDCNS Used to indicate the various states of the COMMSTAT variable.
static java.lang.String	COMMANDPROCESSING_REJECTEDIDP Used to indicate the various states of the COMMSTAT variable.
static java.lang.String	COMMANDPROCESSING_REJECTEDIIO Used to indicate the various states of the COMMSTAT variable.
static java.lang.String	COMMANDPROCESSING_REJECTEDMNN Used to indicate the various states of the COMMSTAT variable.
static java.lang.String	COMMSTATCOMMANDACCEPTED This is the value which is set in the commstat variable when a command is completed without problem
static int	ENGINEERINGARG Used to index the engineering status value in the array which is returned which contains the IDL type representing a status item after type conversion has been performed.
static int	LOGICALARG Used to index the logical status value in the array which is returned which contains the IDL type representing a status item after type conversion has been performed.
static java.lang.String	MECHANISMACTIVE The PV CLSTAT is set to ACTIVE to indicate that the mechanism is moving
static java.lang.String	MECHANISMINACTIVE The PV CLSTAT is set to DONE to indicate that the mechanism is not active
static int	MECHSTATOK This constant indicates that there is no mechanism error which is associated with a mechanism
static java.lang.String	NOERROR This string indicates that there is no error associated with a mechanism
static int	SUBACTIONTIMEDOUT This is an indication that the subaction has expired

Constructor Summary

OCSEPICSConsts()

Method Summary

void	finalize()

Methods inherited from class java.lang.Object

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

Field Detail

MECHSTATOK

public static final int MECHSTATOK

This constant indicates that there is no mechanism error which is associated with a mechanism

See Also:

Constant Field Values

NOERROR

public static final java.lang.String NOERROR

This string indicates that there is no error associated with a mechanism

See Also:

Constant Field Values

COMMANDACCEPTEDSUCESSFULLY

public static final java.lang.String COMMANDACCEPTEDSUCESSFULLY

This is the logical value which should be associated with the * COMMSTR PV which indicates that the command was accepted. It is the responsiblity of the EPICS instrument controller task to ensure that whatever value is returned by the IOC for this PV that a parameter conversion is performed such that successful command completion is set to this value

See Also:

Constant Field Values

COMMSTATCOMMANDACCEPTED

public static final java.lang.String COMMSTATCOMMANDACCEPTED

This is the value which is set in the commstat variable when a command is completed without problem

See Also:

Constant Field Values

LOGICALARG

public static final int LOGICALARG

Used to index the logical status value in the array which is returned which contains the IDL type representing a status item after type conversion has been performed.

See Also:

Constant Field Values

ENGINEERINGARG

public static final int ENGINEERINGARG

Used to index the engineering status value in the array which is returned which contains the IDL type representing a status item after type conversion has been performed.

See Also:

Constant Field Values

APPLICATIONERROR

public static final int APPLICATIONERROR

This will be used to indicate an application related in error when errors are written into the status IDL types.

See Also:

Constant Field Values

SUBACTIONTIMEDOUT

public static final int SUBACTIONTIMEDOUT

This is an indication that the subaction has expired

See Also:

Constant Field Values

MECHANISMACTIVE

public static final java.lang.String MECHANISMACTIVE

The PV CLSTAT is set to ACTIVE to indicate that the mechanism is moving

See Also:

Constant Field Values

MECHANISMINACTIVE

public static final java.lang.String MECHANISMINACTIVE

The PV CLSTAT is set to DONE to indicate that the mechanism is not active

See Also:

Constant Field Values

COMMANDPROCESSING_OK

public static final java.lang.String COMMANDPROCESSING_OK

Used to indicate the various states of the COMMSTAT variable. Indicates that the command request was processed without problem.

See Also:

Constant Field Values

COMMANDPROCESSING_ACTIVE

public static final java.lang.String COMMANDPROCESSING_ACTIVE

Used to indicate the various states of the COMMSTAT variable. Indicates that a command request is being processed

See Also:

Constant Field Values

COMMANDPROCESSING_REJECTEDIIO

public static final java.lang.String COMMANDPROCESSING_REJECTEDIIO

Used to indicate the various states of the COMMSTAT variable. Indicates that an interlock is in operation

See Also:

Constant Field Values

COMMANDPROCESSING_REJECTEDAIP

public static final java.lang.String COMMANDPROCESSING_REJECTEDAIP

Used to indicate the various states of the COMMSTAT variable. Indicates that command processing failed because the action is already in progress.

See Also:

Constant Field Values

COMMANDPROCESSING_REJECTEDMNN

public static final java.lang.String COMMANDPROCESSING_REJECTEDMNN

Used to indicate the various states of the COMMSTAT variable. Command processing rejected because the mechanism is deemed not to be moving.

See Also:

Constant Field Values

COMMANDPROCESSING_REJECTEDCNS

public static final java.lang.String COMMANDPROCESSING_REJECTEDCNS

Used to indicate the various states of the COMMSTAT variable. Command processing rejected because the command is not supported.

See Also:

Constant Field Values

COMMANDPROCESSING_REJECTEDIDP

public static final java.lang.String COMMANDPROCESSING_REJECTEDIDP

Used to indicate the various states of the COMMSTAT variable. Command processing rejected because the demand value is invalid.

See Also:

Constant Field Values

Constructor Detail

OCSEPICSConsts

public OCSEPICSConsts()

Method Detail

finalize

public void finalize()
              throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable