com.ergotech.secs.gem

Interface GemEquipmentInterface

All Known Subinterfaces:

EquipmentControlInterface

All Known Implementing Classes:

ECHandler, GemHandler

public interface GemEquipmentInterface

This is the primary equipment interface to the GEM package. The equipment provides the required parameters and data as those parameters change, the GEM subsystem will provide message handling.

The system is backed up by the VIB data handling system. Each of the methods is a convenience method to interface to VIB. The raw VIB interface is described in the VID, ALID, CEID, LimitID and VidMonitor data server objects. Note that all ids are keyed as Java Strings. The methods that accept other types are convenience methods that pass through to the string method. This means that CEID 100 is identical to "100". Note that E30 requires that certain dictionary items exist. Thes must be registered by the name specified in the E5 manual and mapped to an ID. These DDNAMES are AlarmID, EventLimit, LimitVariable, TransitionType AlarmsEnabled, AlarmsSet, Clock, ControlState, EventsEnabled, SpoolCountActual, SpoolCountTotal, SpoolFulltime, SpoolStartTime.

See Also:

VIBGemEquipmentInterface, VID, ALID, CEID, LimitID, VidMonitor

Field Summary

Fields

Modifier and Type	Field and Description
static int	ADJUSTED_TIME_CHANGED This event is posted when the adjusted time, that is, the date offset is changed as a result of an S2F31 message.
static int	ALARM_CLEARED This event is posted when an alarm is cleared.
static int	ALARM_DISABLED This event is posted when an alarm is disabled.
static int	ALARM_ENABLED This event is posted when an alarm is enabled.
static int	ALARM_REGISTERED This event is posted when an alarm is registered (after it's configured) The source will be the GemALID object.
static int	ALARM_SET This event is posted when an alarm is set.
static int	ALID Used to identify a ALID.
static java.lang.String	ALID_STR The string used to describe all the ALIDs.
static int	ALL_ALARMS_DISABLED This event is posted when all the alarms are disabled.
static int	ALL_ALARMS_ENABLED This event is posted when all the alarms are enabled.
static int	ALL_EVENTS_DISABLED This event is posted when all the events are disabled.
static int	ALL_EVENTS_ENABLED This event is posted when all the events are disabled.
static int	ALL_LIMITS_UNREGISTERED This event is posted when all limits are unregistered.
static int	ALL_REPORTS_UNLINKED This event is posted when an report is linked.
static int	ALL_REPORTS_UNREGISTERED This event is posted when all the report are unregistered.
static int	CEID Used to identify a CEID.
static java.lang.String	CEID_STR The string used to describe all the CEIDs.
static int	DVID Used to identify a DVID.
static int	DVVAL_CHANGED This event is posted when an DVVAL's value has changed.
static int	ECID Used to identify an ECID.
static int	ECID_CHANGED This event is posted when an ECID value has changed.
static int	EVENT_DISABLED This event is posted when an event is disabled.
static int	EVENT_ENABLED This event is posted when an event is enabled.
static int	EVENT_REGISTERED This event is posted when an event is registered.
static int	EVENT_TRIGGERED This event is posted when an event is triggered.
static int	LIMIT_REGISTERED This event is posted when an limit is registered.
static int	LIMIT_TRIGGERED This event is posted when an limit is triggered.
static int	LIMIT_UNREGISTERED This event is posted when a limit is unregistered.
static int	LIMITID Used to identify a LIMITID.
static int	MONITOR_CHANGED This event is posted when an monitor is reregistered or changed.
static int	MONITOR_REGISTERED This event is posted when an monitor is triggered The source will be the Monitor object.
static int	MONITOR_TRIGGERED This event is posted when an limit is monitor.
static int	REPORT_LINKED This event is posted when an event is registered.
static int	REPORT_REGISTERED This event is posted when an report is registered.
static int	REPORT_SENT This event is posted when an report is triggered.
static int	REPORT_UNLINKED This event is posted when an report is linked.
static int	REPORT_UNREGISTERED This event is posted when an report is unregistered.
static int	RPTID Used to identify a RPTID.
static int	SPOOL_ALL_STREAMS_REMOVED This event is posted when all the streams are removed from the spooler as a result of an S2F43 message.
static int	SPOOL_STREAM_ADDED This event is posted when a stream is added to the spooler as a result of an S2F43 message.
static int	SPOOL_STREAM_AND_FUNCTION_ADDED This event is posted when a stream is added to the spooler as a result of an S2F43 message.
static int	SVID Used to identify an SVID.
static int	SVID_CHANGED This event is posted when an SVID's value has changed.
static int	TRID Used to identify a TRID.
static int	VID Used to identify a VID.
static int	VID_CHANGED This event is posted when an ID's value has changed.
static int	VID_REGISTERED This event is posted when an id is triggered.
static java.lang.String	VID_STR The string used to describe all the value IDs (VID, ECID, SVID, DVID).

Method Summary

Modifier and Type	Method and Description
void	addMessageHandler(java.lang.Object messageHandler) Add a message handler to the interface.
void	clearAlarm(int alid) Clear Alarm will clear an alarm.
void	clearAlarm(SecsFormat3x5x alid) Clear Alarm will clear an alarm.
int	getOnlineMode() This will return the current online mode.
SecsFormat	getValue(SecsFormat vid) This allows the equipment to poll the value of any VID.
void	registerALID(SecsFormat3x5x alid, java.lang.String alidName, java.lang.String altx, byte alcd, SecsFormat3x5x setCEID, SecsFormat3x5x clearCEID) Alarm handling.
GemCEID	registerCEID(SecsFormat3x5x CEID, java.lang.String ceidName, java.util.List<SecsFormat> dvids) CEID registration.
void	registerECIDValidator(SecsFormat id, ECIDValidationInterface target) This method allows the equipment to validate an ECID before it is changed.
void	registerForUpdate(SecsFormat id, int type, java.lang.Object target, java.lang.String methodName) this allows the equpiment to watch a vid.
GemVID	registerVID(SecsFormat3x5x vid, java.lang.String name, int type, java.lang.String units, double limitMax, double limitMin, SecsFormat initialValue, double deadband) VID registration.
GemVID	registerVID(SecsFormat3x5x vid, java.lang.String name, int format, java.lang.String units, SecsFormat initialValue) VID registration.
void	registerVIDMonitor(int vid, int ceid, java.lang.String condition, SecsFormat value) Register a monitor for a vid.
void	requestOnline(boolean online) This method allows the equipment to request online, or set offline.
void	sendEventReport(SecsFormat ceid) This method will attempt to send an appropriate message for the id.
void	setAlarm(int alid) Set Alarm will trigger an alarm.
void	setAlarm(SecsFormat3x5x alid) Set Alarm will trigger an alarm.
void	setEquipmentName(java.lang.String equipmentName) Set the name of the equipment.
void	setLocal(boolean local) If we are online, this will change to local mode.
void	setValue(SecsFormat vid, SecsFormat value) This allows the equipment to poll the value of any VID.

Field Detail

ADJUSTED_TIME_CHANGED

static final int ADJUSTED_TIME_CHANGED

This event is posted when the adjusted time, that is, the date offset is changed as a result of an S2F31 message. The source will be the GemHandler. The userObject will be the current adjusted date The subid will be the adjustment in milliseconds

See Also:

Constant Field Values

ALARM_CLEARED

static final int ALARM_CLEARED

This event is posted when an alarm is cleared. This will be called before the clear ceid is called (if one exists). The source will be the GemALID object. The userObject will be the set GemCEID object (if one is registered)

See Also:

Constant Field Values

ALARM_DISABLED

static final int ALARM_DISABLED

This event is posted when an alarm is disabled. The source will be the GemALID object. The user object is undefined.

See Also:

Constant Field Values

ALARM_ENABLED

static final int ALARM_ENABLED

This event is posted when an alarm is enabled. The source will be the GemALID object. The user object is undefined.

See Also:

Constant Field Values

ALARM_REGISTERED

static final int ALARM_REGISTERED

This event is posted when an alarm is registered (after it's configured) The source will be the GemALID object.

See Also:

Constant Field Values

ALARM_SET

static final int ALARM_SET

This event is posted when an alarm is set. This will be called before the set ceid is called (if one exists). The source will be the GemALID object. The userObject will be the set GemCEID object (if one is registered)

See Also:

Constant Field Values

ALID

static final int ALID

Used to identify a ALID.

See Also:

registerForUpdate(com.ergotech.secs.SecsFormat, int, java.lang.Object, java.lang.String), Constant Field Values

ALID_STR

static final java.lang.String ALID_STR

The string used to describe all the ALIDs.

See Also:

Constant Field Values

ALL_ALARMS_DISABLED

static final int ALL_ALARMS_DISABLED

This event is posted when all the alarms are disabled. The source and the user object are undefined.

See Also:

Constant Field Values

ALL_ALARMS_ENABLED

static final int ALL_ALARMS_ENABLED

This event is posted when all the alarms are enabled. The source and the user object are undefined.

See Also:

Constant Field Values

ALL_EVENTS_DISABLED

static final int ALL_EVENTS_DISABLED

This event is posted when all the events are disabled. The source and the user object are undefined.

See Also:

Constant Field Values

ALL_EVENTS_ENABLED

static final int ALL_EVENTS_ENABLED

This event is posted when all the events are disabled. The source and the user object are undefined.

See Also:

Constant Field Values

ALL_LIMITS_UNREGISTERED

static final int ALL_LIMITS_UNREGISTERED

This event is posted when all limits are unregistered. It will be proceeded by a LIMIT_UNREGISTERED for each limit that is unregistered. The source will be the GemLIMITID object. The user object is undefined.

See Also:

Constant Field Values

ALL_REPORTS_UNLINKED

static final int ALL_REPORTS_UNLINKED

This event is posted when an report is linked. The source will be the GemCEID object. The userObject will be the GemRPTID that defines this specific report.

See Also:

Constant Field Values

ALL_REPORTS_UNREGISTERED

static final int ALL_REPORTS_UNREGISTERED

This event is posted when all the report are unregistered. The source and userObject are undefined.

See Also:

Constant Field Values

CEID

static final int CEID

Used to identify a CEID.

See Also:

registerForUpdate(com.ergotech.secs.SecsFormat, int, java.lang.Object, java.lang.String), Constant Field Values

CEID_STR

static final java.lang.String CEID_STR

The string used to describe all the CEIDs.

See Also:

Constant Field Values

DVID

static final int DVID

Used to identify a DVID.

See Also:

registerVID(com.ergotech.secs.SecsFormat3x5x, java.lang.String, int, java.lang.String, double, double, com.ergotech.secs.SecsFormat, double), Constant Field Values

DVVAL_CHANGED

static final int DVVAL_CHANGED

This event is posted when an DVVAL's value has changed. The ECID will trigger both an VID_CHANGED and a DVVAL_CHANGED. The source will be the Monitor object. The userObject will be the new value (as a SecsFormat)

See Also:

Constant Field Values

ECID

static final int ECID

Used to identify an ECID.

See Also:

registerVID(com.ergotech.secs.SecsFormat3x5x, java.lang.String, int, java.lang.String, double, double, com.ergotech.secs.SecsFormat, double), Constant Field Values

ECID_CHANGED

static final int ECID_CHANGED

This event is posted when an ECID value has changed. The ECID will trigger both an VID_CHANGED and a ECID_CHANGED. This will allow you to register for only the ecid's that might have been changed from the host. The source will be the Monitor object. The userObject will be the new value (as a SecsFormat)

See Also:

Constant Field Values

EVENT_DISABLED

static final int EVENT_DISABLED

This event is posted when an event is disabled. The source will be the GemCEID object. The user object is undefined.

See Also:

Constant Field Values

EVENT_ENABLED

static final int EVENT_ENABLED

This event is posted when an event is enabled. The source will be the GemCEID object. The user object is undefined.

See Also:

Constant Field Values

EVENT_REGISTERED

static final int EVENT_REGISTERED

This event is posted when an event is registered. The source will be the GemCEID object. The userObject will be the GemCEID.

See Also:

Constant Field Values

EVENT_TRIGGERED

static final int EVENT_TRIGGERED

This event is posted when an event is triggered. This will be called after creating the report and sending out over the link. The source will be the GemCEID object. The userObject will be the report itself as a Vector of GemRPTID's that are going to be triggered.

See Also:

Constant Field Values

LIMIT_REGISTERED

static final int LIMIT_REGISTERED

This event is posted when an limit is registered. The source will be the GemLIMITID object. The user object is the GemVID for which the limit is registered.

See Also:

Constant Field Values

LIMIT_TRIGGERED

static final int LIMIT_TRIGGERED

This event is posted when an limit is triggered. The source will be the GemLIMITID object. The user object is a SECS Format that has the current value

See Also:

Constant Field Values

LIMIT_UNREGISTERED

static final int LIMIT_UNREGISTERED

This event is posted when a limit is unregistered. The source will be the GemLIMITID object. The user object is a GemVID.

See Also:

Constant Field Values

LIMITID

static final int LIMITID

Used to identify a LIMITID.

See Also:

registerForUpdate(com.ergotech.secs.SecsFormat, int, java.lang.Object, java.lang.String), Constant Field Values

MONITOR_CHANGED

static final int MONITOR_CHANGED

This event is posted when an monitor is reregistered or changed. The source will be the Monitor object.

See Also:

Constant Field Values

MONITOR_REGISTERED

static final int MONITOR_REGISTERED

This event is posted when an monitor is triggered The source will be the Monitor object.

See Also:

Constant Field Values

MONITOR_TRIGGERED

static final int MONITOR_TRIGGERED

This event is posted when an limit is monitor. The source will be the Monitor object. The UserObject will be the value that changed the monitor (as a Secsformat)

See Also:

Constant Field Values

REPORT_LINKED

static final int REPORT_LINKED

This event is posted when an event is registered. The source will be the GemCEID object.

See Also:

Constant Field Values

REPORT_REGISTERED

static final int REPORT_REGISTERED

This event is posted when an report is registered. The source will be the GemRPTID object. The userObject will be a Vector of GemIDs that defines this specific report.

See Also:

Constant Field Values

REPORT_SENT

static final int REPORT_SENT

This event is posted when an report is triggered. This will be called after creating the report and sent sending out the link. The source will be the GemRPTID object. The userObject will be the GemCEID object associated with this report.

See Also:

Constant Field Values

REPORT_UNLINKED

static final int REPORT_UNLINKED

This event is posted when an report is linked. The source will be the GemCEID object. The userObject will be the GemRPTID that defines this specific report.

See Also:

Constant Field Values

REPORT_UNREGISTERED

static final int REPORT_UNREGISTERED

This event is posted when an report is unregistered. The source will be the GemRPTID object. The userObject will be a Vector of GemIDs that defines this specific report.

See Also:

Constant Field Values

RPTID

static final int RPTID

Used to identify a RPTID.

See Also:

registerForUpdate(com.ergotech.secs.SecsFormat, int, java.lang.Object, java.lang.String), Constant Field Values

SPOOL_ALL_STREAMS_REMOVED

static final int SPOOL_ALL_STREAMS_REMOVED

This event is posted when all the streams are removed from the spooler as a result of an S2F43 message. The source will be the spooler. The userObject will be null

See Also:

Constant Field Values

SPOOL_STREAM_ADDED

static final int SPOOL_STREAM_ADDED

This event is posted when a stream is added to the spooler as a result of an S2F43 message. The source will be the spooler. The userObject will be null The subid will be the stream that was added

See Also:

Constant Field Values

SPOOL_STREAM_AND_FUNCTION_ADDED

static final int SPOOL_STREAM_AND_FUNCTION_ADDED

This event is posted when a stream is added to the spooler as a result of an S2F43 message. The source will be the spooler. The userObject will be null The subid will be ((stream << 16) | function)

See Also:

Constant Field Values

SVID

static final int SVID

Used to identify an SVID.

See Also:

registerVID(com.ergotech.secs.SecsFormat3x5x, java.lang.String, int, java.lang.String, double, double, com.ergotech.secs.SecsFormat, double), Constant Field Values

SVID_CHANGED

static final int SVID_CHANGED

This event is posted when an SVID's value has changed. The ECID will trigger both an VID_CHANGED and a SVID_CHANGED. The source will be the Monitor object. The userObject will be the new value (as a SecsFormat)

See Also:

Constant Field Values

TRID

static final int TRID

Used to identify a TRID.

See Also:

registerForUpdate(com.ergotech.secs.SecsFormat, int, java.lang.Object, java.lang.String), Constant Field Values

VID

static final int VID

Used to identify a VID.

See Also:

registerForUpdate(com.ergotech.secs.SecsFormat, int, java.lang.Object, java.lang.String), Constant Field Values

VID_CHANGED

static final int VID_CHANGED

This event is posted when an ID's value has changed. The source will be the Monitor object. The userObject will be the new value (as a SecsFormat)

See Also:

Constant Field Values

VID_REGISTERED

static final int VID_REGISTERED

This event is posted when an id is triggered. This will be called after creating the report and sent sending out the link. The source will be the GemRPTID object. The userObject will be the type (SVID, CEID, ect) as an Integer;

See Also:

Constant Field Values

VID_STR

static final java.lang.String VID_STR

The string used to describe all the value IDs (VID, ECID, SVID, DVID).

See Also:

Constant Field Values

Method Detail

addMessageHandler

void addMessageHandler(java.lang.Object messageHandler)

Add a message handler to the interface.

clearAlarm

void clearAlarm(int alid)
         throws SecsException

Clear Alarm will clear an alarm. This will trigger the clearCEID.

Parameters:

alid - the alarm id

Throws:

SecsException

clearAlarm

void clearAlarm(SecsFormat3x5x alid)
         throws SecsException

Clear Alarm will clear an alarm. This will trigger the clearCEID.

Parameters:

alid - the alarm id

Throws:

SecsException

getOnlineMode

int getOnlineMode()

This will return the current online mode. These are defined in com.ergotech.secs.OnlineHandler

getValue

SecsFormat getValue(SecsFormat vid)

This allows the equipment to poll the value of any VID. The value of the VID will be converted to the required type whenever possible. String types that cannot be converted will silently return zero.

Parameters:

vid - the VID to poll

Returns:

the current value of the vid expressed as a SecsFormat.

registerALID

void registerALID(SecsFormat3x5x alid,
                  java.lang.String alidName,
                  java.lang.String altx,
                  byte alcd,
                  SecsFormat3x5x setCEID,
                  SecsFormat3x5x clearCEID)

Alarm handling. This initilizes the alarm management object and allows GEM to handle all the Stream 5 messages.

Parameters:

alid - the alarm id

altx - the alarm text

alidName - the name of the alid, may be null

alcd - the alcd as defined by the E5 specification

aled - set to true to enable the alarm, otherwise false

setCEID - the ceid of the event report sent when the alarm is set

clearCEID - the ceid of the event report sent when the alarm is cleared

registerCEID

GemCEID registerCEID(SecsFormat3x5x CEID,
                     java.lang.String ceidName,
                     java.util.List<SecsFormat> dvids)

CEID registration. This registers a CEID simply to indicate it's validity. Any CEID registered elsewhere need not be registered using this method. For example, CEIDs used in limits monitoring will be automatically registered. It is also not an error to register them using this method.

Parameters:

CEID - the ceid

ceidName - the name of the CEID, may be null

Returns:

the registered server

registerECIDValidator

void registerECIDValidator(SecsFormat id,
                           ECIDValidationInterface target)
                    throws GemException

This method allows the equipment to validate an ECID before it is changed.

Parameters:

id - the id for which the method is registering.

target - the instance of the object that is the target of the update

Throws:

GemException

See Also:

ECIDValidationInterface

registerForUpdate

void registerForUpdate(SecsFormat id,
                       int type,
                       java.lang.Object target,
                       java.lang.String methodName)
                throws GemException

this allows the equpiment to watch a vid. The method provided must take one argument that is a String (the id that was set). There is an optional second argument that takes a Object. This object will be different depending on what type we are looking for. For a VID, ALID, LIMITID the optional object will be the new value as a ValueObject For a CEID the optional object will be the the report as a SecsFormat

Parameters:

id - the id for which the method is registering.

type - This is the type of id (VID, ALID, CEID)

target - the instance of the object that is the target of the update

method - a method that takes one argument that is one of the above types.

Throws:

GemException

See Also:

vib.utils.ValueObjectInterface

registerVID

GemVID registerVID(SecsFormat3x5x vid,
                   java.lang.String name,
                   int type,
                   java.lang.String units,
                   double limitMax,
                   double limitMin,
                   SecsFormat initialValue,
                   double deadband)
            throws VIBUpdateFailedException

VID registration. VIDs must be registered before use. The interpretation of deadband is a little different from the GEM usage. For VIB the values must change either up or down by the size of the deadband in the particular direction. Values passed to a VIB server that do not meet this requirement will not cause the server to update it's clients. Note that clients within the implementation include manipulators used for condition checking and limits monitoring. So, if a server has a deadband set to 1 and the values send to the server are 100.1, 100.5, 101.1 the clients will see only 100.1 and 101.1. This will stop "chatter" on condition monitoring, but conflicts with the GEM interpretation of limits monitoring, especially if the LOWERDB and UPPERDB are set within the deadband set for the parameter. In practice there should be no conflict because the deadband should always be set to eliminate noise and the noise should be less than any significant change in the signal. If this isn't the case, meeting the GEM monitoring requirements doesn't solve your problems. If you are concerned about this problem the deadbands should be set to zero.

Parameters:

vid - the id in the form of a SecsFormatXX

name - This is the SVName used for S1F12

type - one of the defined types for vids (ECID, VID, DVNAME)

units - the units for this vid

limitMax - the maximum allowable limit for this value

limitMin - the minimum allowable limit for this value

initialValue - this is the initial value of the vid. This will NOT send out any limits, monitors or ceids.

deadband - the new value must be the old value minus this value for the value associated with the VID to change.

Throws:

VIBUpdateFailedException - thrown if the type is invalid or if the intial value cannot be set to the server

registerVID

GemVID registerVID(SecsFormat3x5x vid,
                   java.lang.String name,
                   int format,
                   java.lang.String units,
                   SecsFormat initialValue)
            throws VIBUpdateFailedException

VID registration. VIDs must be registered before use. For VIB the values must change either up or down by the size of the deadband in the particular direction. Values passed to a VIB server that do not meet this requirement will not cause the server to update it's clients. A vid created with this method WILL NOT have th ability to set limits or monitors. It will also not keep track of deadbands.

Parameters:

vid - the id in the form of a SecsFormatXX

name - This is the SVName used for S1F12

type - one of the defined types for vids (ECID, VID, DVNAME)

units - the units for this vid

initialValue - this is the initial value of the vid. This will NOT send out any limits, monitors or ceids. value for the value associated with the VID to change.

Throws:

VIBUpdateFailedException - thrown if the type is invalid or if the intial value cannot be set to the server

registerVIDMonitor

void registerVIDMonitor(int vid,
                        int ceid,
                        java.lang.String condition,
                        SecsFormat value)
                 throws GemException

Register a monitor for a vid. The condition must be one of "<", "<=", ">=", "!=", "=" or empty (""). An empty string will be used as the default for limits monitoring for this VID. Any number of limits may be registered and no sanity checking is performed, so every change to this VID could generate multiple events. This method may be called multiple times. Calls with the same VID, CEID and condition will replace an existing record. In other words, you can only register one of each condition for each VID with the same CEID. Note any deadbands set for this vid will be applied before comparison.

Parameters:

vid - the VID which must be registered

the - CEID which will be registered if it is not already

condition - one of "<", "<=", ">=", ">", "!=", "=", "==" or ""

target - the target value to compare with.

Throws:

GemException

requestOnline

void requestOnline(boolean online)
            throws SecsException

This method allows the equipment to request online, or set offline. Note that this method may take a while since an online request has to go to the host and we have to wait for a response. This will occur in this thread.

Parameters:

flag - online

Throws:

SECSException - thrown if the host declines on-line

SecsException

sendEventReport

void sendEventReport(SecsFormat ceid)
              throws SecsException

This method will attempt to send an appropriate message for the id. If the id is a CEID and S6F11 report will be sent. If the id is an ALID the alarm message will be sent. If the id is a VID and condition monitoring for the id has been configured then the CEID associtated with the first registered condition will be sent. If none of these apply, this call will do nothing.

Parameters:

the - id for which a message should be sent.

Throws:

SecsException

setAlarm

void setAlarm(int alid)
       throws SecsException

Set Alarm will trigger an alarm. This will send out any messages then trigger the setCEID.

Parameters:

alid - the alarm id

Throws:

SecsException

setAlarm

void setAlarm(SecsFormat3x5x alid)
       throws SecsException

Set Alarm will trigger an alarm. This will send out any messages then trigger the setCEID.

Parameters:

alid - the alarm id

Throws:

SecsException

setEquipmentName

void setEquipmentName(java.lang.String equipmentName)
               throws BadParameterException

Set the name of the equipment.

Throws:

BadParameterException - thrown if there is an error creating the container.

setLocal

void setLocal(boolean local)

If we are online, this will change to local mode. If We are offline, this will change the default online mode to online.

setValue

void setValue(SecsFormat vid,
              SecsFormat value)
       throws SecsException

This allows the equipment to poll the value of any VID. The value of the VID will be converted to the required type whenever possible. String types that cannot be converted will silently return zero.

Parameters:

vid - the VID to poll

the - current value of the vid expressed as a double.

Throws:

SecsException