GemHandler (ErgoTech VIB/TransSECS Scripting API)

java.lang.Object
- com.ergotech.secs.gem.GemHandler

All Implemented Interfaces:

AlarmWriter, GemEquipmentInterface, ReportWriter, SecsEventListener, java.io.Serializable, java.util.EventListener

Direct Known Subclasses:

ECHandler
```
public class GemHandler
extends java.lang.Object
implements GemEquipmentInterface, ReportWriter, AlarmWriter, java.io.Serializable, SecsEventListener
```
This is a MessageHandler that will handle all the messages needed to configure limits. This works with the GemEquipment object.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`java.util.Map<java.lang.String,GemALID>`	`alids` The Vector of Alarm Servers.
`java.util.Vector<GemCEID>`	`ceids` The Vector of CEID servers.
`int`	`dataid` The `dataid`
`static int`	`debugLevel` Positive value of debugLevel provide printouts with debugging information.
`java.util.Vector<GemVID>`	`dvids` The Vector of all the ECIDs.
`java.util.Vector<GemVID>`	`ecids` The Vector of all the ECIDs.
`static java.lang.String`	`MDLN`
`java.util.Map<java.lang.String,Monitor>`	`monitors` The Vector of all the condition monitors.
`static java.time.Clock`	`nanoClock` The Clock to use for the nanoClock VID.
`OnlineHandler`	`onlineHandler` The online handler.
`java.util.Vector<GemRPTID>`	`rptids` The Vector of Report Servers.
`static java.lang.String`	`SOFTREV`
`java.util.Vector<GemVID>`	`svids` The Vector of all the SVIDs.

Fields inherited from interface com.ergotech.secs.gem.ReportWriter
TRANSSECSCONTROLLER_NAME_KEY

Fields inherited from interface com.ergotech.secs.gem.AlarmWriter
cvsRev

Fields inherited from interface com.ergotech.secs.SecsEventListener
cvsRev

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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.
`void`	`clearAlarm(SecsFormat3x5x alid, java.util.Hashtable<SecsFormat3x5x,SecsFormat> dvvals)` Clear Alarm will clear an alarm.
`java.lang.String`	`convertDate(java.util.Date date)` This will return a date string in the form required by the CLOCK DDVAL.
`java.lang.String`	`convertInstant(java.time.Instant instant)` This will return a date string in the form required by the CLOCK DDVAL.
`void`	`destroy()` Clear all the variables.
`GemLIMITID`	`findLimit(GemVID vid, int limitID)` This gets a specific GEM limitID
`S5F1`	`generateAlarm(GemALID theAlarm)` This will be called by the alarm when it wants to send a specific alarm.
`SecsMsg`	`generateReport(GemCEID ceid, ValueObjectInterface valueObject)` This will be called by the report when it wants to send a specific report.
`SecsMsg`	`generateReport(GemCEID ceid, ValueObjectInterface valueObject, int function, SecsMsg incoming)` This will be called by the report when it wants to send a specific report.
`SecsMsg`	`generateReport(GemCEID ceid, ValueObjectInterface valueObject, int function, SecsMsg incoming, boolean send)` This will be called by the report when it wants to send a specific report.
`java.util.Date`	`getAdjustedDate()` This will return a date string in the form required by the CLOCK DDVAL.
`java.time.Instant`	`getAdjustedInstant()` This will return an instant precise to nanoseconds but offset by the millesecond field dataOffset
`GemALID`	`getAlarm(SecsFormat alid)` Returns the alarm server associated with the given alid.
`SecsFormat00`	`getAlarmsSet()` Returns a list of all alids.
`java.util.Map<java.lang.String,GemALID>`	`getAllALIDs()` Returns the alids
`java.util.List<GemCEID>`	`getAllCEIDs()` Returns the ceids
`java.util.List<GemVID>`	`getAllDVIDs()` Returns the ecids
`java.util.List<GemVID>`	`getAllECIDs()` Returns the ecids
`java.util.List<GemRPTID>`	`getAllRPTID()` Returns the rptids
`java.util.List<GemVID>`	`getAllSVIDs()` Provide a connection for the equipment.
`SecsFormat`	`getData(SecsMsg msg)` This will return the data from the message provide.
`long`	`getDateOffset()` Returns the current date offset.
`SecsFormat`	`getDvname(java.lang.String dvname)` Returns an DVNAME (an integer ID) for the name provide or null if the name is not registered.
`SecsFormat`	`getDVNAME(java.lang.String dvname)` Returns an ID for any type (not just a DVNAME).
`java.lang.String`	`getEquipmentName()`
`DataSourceContainer`	`getGemContainer()`
`static java.lang.String`	`getKey(SecsFormat3x5x vid, SecsFormat3x5x ceid, java.lang.String condition)`
`static java.lang.String`	`getLimitName(java.lang.String type, long id, long limit)`
`static java.lang.String`	`getName(int type, long id)` Returns a string created from the given type and id.
`static java.lang.String`	`getName(java.lang.String type, java.lang.String id)` Returns a string created from the given type and id.
`OnlineHandler`	`getOnlineHandler()` Returns the gem handler.
`int`	`getOnlineMode()` This will return the current online mode.
`SecsFormat00`	`getReportValues(GemRPTID reportServer, ValueObjectInterface valueObject, boolean annotated)` Creates the list of values for the report given.
`static SecsFormat`	`getSecsFormat(double value, int type)` This utility method will find the best container (SecsFormatxx) for a given value.
`static SecsFormat`	`getSecsFormat(java.lang.Object value)` This utility method will find the best container (SecsFormatxx) for a given value.
`GemID`	`getServerFor(int type, long id)` Returns a GemID server associated with the given id and type.
`DataSource`	`getServerForName(java.lang.String serverName)` This method will return a sever that is managed by GEM and which matches the name provided.
`static int`	`getType(SecsFormat value)` This will only work with the standard SecsFormat20, SecsFormat30, ect (the ones in the com.ergotech.secs package).
`SecsFormat`	`getValue(int vid)` This allows the equipment to poll the value of any VID.
`SecsFormat`	`getValue(SecsFormat vid)` This allows the equipment to poll the value of any VID.
`SecsFormat`	`getValue(java.lang.String vidName)` This allows the equipment to poll the value of any VID.
`static boolean`	`isS1F3ReturnsValues()` The return will be true if the S1F3 method should return the values rather than the IDs.
`void`	`populateDVIDs(ValueObjectInterface dvvals)` Populate all SVIDs and DVIDs with any values from the dvvals.
`void`	`registerAlarm(SecsFormat alid, GemALID theAlarm)` Registers an alarm server with the given alid
`void`	`registerALID(SecsFormat3x5x alid, java.lang.String alidName, java.lang.String altx, byte alcd, SecsFormat3x5x setCEID, SecsFormat3x5x clearCEID)` Alarm handling.
`void`	`registerALID(SecsFormat alid, java.lang.String altx, byte alcd, int setCEID, int clearCEID)` Alarm handling.
`GemCEID`	`registerCEID(SecsFormat3x5x ceid)` ceid registration.
`GemCEID`	`registerCEID(SecsFormat3x5x ceid, java.lang.String name, java.util.List<SecsFormat> dvids)` CEID registration.
`GemCEID`	`registerCEIDIfNotExist(SecsFormat3x5x ceid, java.lang.String name, java.util.List<SecsFormat> dvids)` CEID registration.
`void`	`registerECIDValidator(int id, ECIDValidationInterface target)` This method allows the equipment to validate an ECID before it is changed.
`void`	`registerECIDValidator(SecsFormat id, ECIDValidationInterface target)` This method allows the equipment to validate an ECID before it is changed.
`void`	`registerForUpdate(int id, int type, java.lang.Object target, java.lang.String methodName)` this allows the equpiment to watch a vid.
`void`	`registerForUpdate(SecsFormat id, int type, java.lang.Object target, java.lang.String methodName)` this allows the equpiment to watch a vid.
`TraceServer`	`registerTrace(TRID trid, TOTSMP samples, REPGSZ sampleSize, SecsFormat00 svids)` /** Trace registration.
`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 type, 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`	`removeByName(java.util.Vector<? extends GemID> v, java.lang.String name)` Remove any server matching the name from the list
`void`	`requestOnline(boolean online)` This method allows the equipment to request online, or set offline.
`boolean`	`S1F1(SecsMsg msg)` Respond to an S1F1.
`boolean`	`S1F11(SecsMsg msg)` This method receives an S1F11 and sends an S1F12.
`boolean`	`S1F13(SecsMsg msg)` This method receives an S21F13 and sends an S2F14.
`boolean`	`S1F21(SecsMsg msg)` This method receives an S1F21 and sends an S1F22.
`boolean`	`S1F23(SecsMsg msg)` This method receives an S1F23 (CEID list request) and sends an S1F24 reply.
`boolean`	`S1F3(SecsMsg msg)` This method receives an S1F3 and sends an S1F4.
`boolean`	`S2F13(SecsMsg msg)` This method receives an S21F13 and sends an S2F14.
`boolean`	`S2F15(SecsMsg msg)` This method receives an S21F15 and sends an S2F16.
`boolean`	`S2F17(SecsMsg msg)` This method recieves an S2F17.
`boolean`	`S2F23(SecsMsg msg)` This method recieves an S2F23.
`boolean`	`S2F25(SecsMsg msg)` This method receives an S2,F25 Loopback Diagnostic Request (LDR) A diagnostic message for checkout of protocol and communication circuits.
`boolean`	`S2F29(SecsMsg msg)` This method receives an S2F29 and sends an S2F30.
`boolean`	`S2F31(SecsMsg msg)` This method receives an S2F31 and sends an S2F32.
`boolean`	`S2F33(SecsMsg msg)` This method receives an S2F33 and sends an S2F34.
`boolean`	`S2F35(SecsMsg msg)` This method receives an S2F35 and sends an S2F36.
`boolean`	`S2F37(SecsMsg msg)` This method receives an S2F37 and sends an S2F38.
`boolean`	`S2F39(SecsMsg msg)` Stream 2 multi-block Request.
`boolean`	`S2F45(SecsMsg msg)` This will receive a S2F45 secs msg.
`boolean`	`S2F47(SecsMsg msg)` This method receives an S2F47 and sends an S2F48.
`boolean`	`S5F3(SecsMsg msg)` Enable/Disable alarm send (EAS).
`boolean`	`S5F5(SecsMsg msg)` List alarm request.
`boolean`	`S5F7(SecsMsg msg)` List Enabled Alarm Request.
`boolean`	`S6F15(SecsMsg msg)` Respond to the S6F15 message.
`boolean`	`S6F17(SecsMsg msg)` Respond to the S6F17 message.
`boolean`	`S6F19(SecsMsg msg)` S6F19 - Report Request.
`boolean`	`S6F21(SecsMsg msg)` S6F21 - Annotated Report Request.
`boolean`	`S6F5(SecsMsg msg)` Stream 6 multi-block Request.
`void`	`saveModel()` Save the model.
`void`	`secsEvent(SecsEvent theEvent)` This method will be called when a SecsEvent accurs.
`void`	`sendEventReport(int ceid, java.util.Map<SecsFormat3x5x,SecsFormat> dvvals)` This method will attempt to send an appropriate message for the id.
`void`	`sendEventReport(SecsFormat ceid)` This method will attempt to send an appropriate message for the id.
`void`	`sendEventReport(SecsFormat ceid, java.util.Map<SecsFormat3x5x,SecsFormat> dvvals)` This method will attempt to send an appropriate message for the id.
`static void`	`sendS9F7(SecsMsg msg)` Send an S9F7 message.
`void`	`setAlarm(int alid)` Set Alarm will trigger an alarm.
`void`	`setAlarm(SecsFormat3x5x alid)` Set Alarm will trigger an alarm.
`void`	`setAlarm(SecsFormat3x5x alid, java.util.Hashtable<SecsFormat3x5x,SecsFormat> dvvals)` Set Alarm will trigger an alarm.
`void`	`setAllLimitToUndefined()` This will set all limits to undefined.
`void`	`setAllLimitToUndefined(GemVID vid)` This will set all limits for a specific VID to undefined.
`void`	`setDateOffset(long offset)` Sets the current date offset.
`void`	`setEquipmentName(java.lang.String equipmentName)` Set the name of the equipment.
`void`	`setLimitToUndefined(GemVID vid, int limitID)` This will set a limit to undefined.
`void`	`setLocal(boolean local)` If we are online, this will change to local mode.
`void`	`setOnlineHandler(OnlineHandler oh)` Set the object that will handle online/offline requests.
`static void`	`setS1F3ReturnsValues(boolean returnsValues)` Set to true if the S1F3 method should return the values when a blank list is passed to the method rather than the IDs.
`void`	`setValue(int vid, SecsFormat value)` This allows the equipment to poll the value of any VID.
`void`	`setValue(SecsFormat vid, SecsFormat value)` This allows the equipment to poll the value of any VID.
`void`	`setValue(java.lang.String vidName, SecsFormat value)` This allows the equipment to set the value of any VID to the exact SecsFormat value.
`void`	`setValue(java.lang.String vidName, ValueObjectInterface value)` This allows the equipment to set the value of any VID.
`java.lang.String`	`stripType(int type, java.lang.String name)` This strips the type identifier from the string.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - alids
```
public java.util.Map<java.lang.String,GemALID> alids
```
    The Vector of Alarm Servers.
  - ceids
```
public java.util.Vector<GemCEID> ceids
```
    The Vector of CEID servers.
  - dataid
```
public int dataid
```
    The dataid
  - debugLevel
```
public static int debugLevel
```
    Positive value of debugLevel provide printouts with debugging information. the higher the value the more output is produced.
  - dvids
```
public transient java.util.Vector<GemVID> dvids
```
    The Vector of all the ECIDs. This is not persisted since it cannot change at runtime.
  - ecids
```
public transient java.util.Vector<GemVID> ecids
```
    The Vector of all the ECIDs. This is not persisted since it cannot change at runtime.
  - MDLN
```
public static final java.lang.String MDLN
```
    See Also:
    
    Constant Field Values
  - monitors
```
public transient java.util.Map<java.lang.String,Monitor> monitors
```
    The Vector of all the condition monitors. This is not persisted since it cannot change at runtime.
  - nanoClock
```
public static java.time.Clock nanoClock
```
    The Clock to use for the nanoClock VID. This may be null if the system clock is to be used (Java9+)
  - onlineHandler
```
public transient OnlineHandler onlineHandler
```
    The online handler.
  - rptids
```
public java.util.Vector<GemRPTID> rptids
```
    The Vector of Report Servers.
  - SOFTREV
```
public static final java.lang.String SOFTREV
```
    See Also:
    
    Constant Field Values
  - svids
```
public transient java.util.Vector<GemVID> svids
```
    The Vector of all the SVIDs. This is not persisted since it cannot change at runtime.
- Method Detail
  - addMessageHandler
```
public void addMessageHandler(java.lang.Object messageHandler)
```
    Description copied from interface: GemEquipmentInterface
    
    Add a message handler to the interface.
    
    Specified by:
    
    addMessageHandler in interface GemEquipmentInterface
  - clearAlarm
```
public void clearAlarm(int alid)
                throws SecsException
```
    Clear Alarm will clear an alarm. This will trigger the clearCEID.
    
    Specified by:
    
    clearAlarm in interface GemEquipmentInterface
    
    Parameters:
    
    alid - the alarm id
    
    Throws:
    
    SecsException - thrown if the event report is not sent because there is not connection to the host. Note that this will NOT be thrown if spooling is enabled even if there is no connection to the host.
  - clearAlarm
```
public void clearAlarm(SecsFormat3x5x alid)
                throws SecsException
```
    Clear Alarm will clear an alarm. This will trigger the clearCEID.
    
    Specified by:
    
    clearAlarm in interface GemEquipmentInterface
    
    Parameters:
    
    alid - the alarm id
    
    Throws:
    
    SecsException - thrown if the event report is not sent because there is not connection to the host. Note that this will NOT be thrown if spooling is enabled even if there is no connection to the host.
  - clearAlarm
```
public void clearAlarm(SecsFormat3x5x alid,
                       java.util.Hashtable<SecsFormat3x5x,SecsFormat> dvvals)
                throws SecsException
```
    Clear Alarm will clear an alarm. This will trigger the clearCEID.
    
    Parameters:
    
    alid - the alarm id
    
    dvvals - a table of SecsFormat3x5x ids vs SecsFormat values.
    
    Throws:
    
    SecsException - thrown if the event report is not sent because there is not connection to the host. Note that this will NOT be thrown if spooling is enabled even if there is no connection to the host.
  - convertDate
```
public java.lang.String convertDate(java.util.Date date)
```
    This will return a date string in the form required by the CLOCK DDVAL.
  - convertInstant
```
public java.lang.String convertInstant(java.time.Instant instant)
```
    This will return a date string in the form required by the CLOCK DDVAL.
  - destroy
```
public void destroy()
```
    Clear all the variables.
  - findLimit
```
public GemLIMITID findLimit(GemVID vid,
                            int limitID)
```
    This gets a specific GEM limitID
  - generateAlarm
```
public S5F1 generateAlarm(GemALID theAlarm)
                   throws SecsException
```
    This will be called by the alarm when it wants to send a specific alarm.
    
    Specified by:
    
    generateAlarm in interface AlarmWriter
    
    Throws:
    
    SecsException - thrown if the alarm message cannot be sent because there is no connection. Note that this will NOT be thrown if spooling is enabled even if there is no connection to the host.
  - generateReport
```
public SecsMsg generateReport(GemCEID ceid,
                              ValueObjectInterface valueObject)
                       throws SecsException
```
    This will be called by the report when it wants to send a specific report. This is added so that the report, and all the VIB components that do not have any Secs references (if we ever want to put them on a seperate machine.
    
    Specified by:
    
    generateReport in interface ReportWriter
    
    Throws:
    
    SecsException - thrown if sending the message fails.
  - generateReport
```
public SecsMsg generateReport(GemCEID ceid,
                              ValueObjectInterface valueObject,
                              int function,
                              SecsMsg incoming)
                       throws SecsException
```
    This will be called by the report when it wants to send a specific report. This is also used by S6F15, hence the "function" argument. It could also be used to generate annotated reports.
    
    Throws:
    
    SecsException - thrown if sending the message fails.
  - generateReport
```
public SecsMsg generateReport(GemCEID ceid,
                              ValueObjectInterface valueObject,
                              int function,
                              SecsMsg incoming,
                              boolean send)
                       throws SecsException
```
    This will be called by the report when it wants to send a specific report. This is also used by S6F15, hence the "function" argument. It could also be used to generate annotated reports.
    
    Throws:
    
    SecsException - thrown if sending the message fails.
  - getAdjustedDate
```
public java.util.Date getAdjustedDate()
```
    This will return a date string in the form required by the CLOCK DDVAL. The string will represent the current date.
  - getAdjustedInstant
```
public java.time.Instant getAdjustedInstant()
```
    This will return an instant precise to nanoseconds but offset by the millesecond field dataOffset
  - getAlarm
```
public GemALID getAlarm(SecsFormat alid)
```
    Returns the alarm server associated with the given alid.
    
    Parameters:
    
    alid - the alarm id
    
    Returns:
    
    the alarm server associated with the alid
  - getAlarmsSet
```
public SecsFormat00 getAlarmsSet()
```
    Returns a list of all alids. This is used to create the AlarmsEnabled DDVAL
  - getAllALIDs
```
public java.util.Map<java.lang.String,GemALID> getAllALIDs()
```
    Returns the alids
    
    Returns:
    
    the alids
  - getAllCEIDs
```
public java.util.List<GemCEID> getAllCEIDs()
```
    Returns the ceids
    
    Returns:
    
    ceids
  - getAllDVIDs
```
public java.util.List<GemVID> getAllDVIDs()
```
    Returns the ecids
    
    Returns:
    
    the ecids
  - getAllECIDs
```
public java.util.List<GemVID> getAllECIDs()
```
    Returns the ecids
    
    Returns:
    
    the ecids
  - getAllRPTID
```
public java.util.List<GemRPTID> getAllRPTID()
```
    Returns the rptids
    
    Returns:
    
    the rptids
  - getAllSVIDs
```
public java.util.List<GemVID> getAllSVIDs()
```
    Provide a connection for the equipment. The default session manager of this wrapper will be used to send all unsolicited messages (anything that isn't a reply). The wrapper is probably one of SecsIWrapper, HSMSActiveWrapper, HSMSPassiveWrapper.
    
    Parameters:
    
    WrapperInterface - the wrapper used to connect to the host
  - getData
```
public SecsFormat getData(SecsMsg msg)
                   throws SecsException
```
    This will return the data from the message provide. If the data cannot be convert (ie it throws) then an S9F7 will be sent. The exception will then be re-thrown
    
    Throws:
    
    SecsException
  - getDateOffset
```
public long getDateOffset()
```
    Returns the current date offset.
  - getDvname
```
public SecsFormat getDvname(java.lang.String dvname)
```
    Returns an DVNAME (an integer ID) for the name provide or null if the name is not registered.
  - getDVNAME
```
public SecsFormat getDVNAME(java.lang.String dvname)
```
    Returns an ID for any type (not just a DVNAME). Maintained for compatibility.
  - getEquipmentName
```
public java.lang.String getEquipmentName()
```
    Returns:
    
    Returns the equipmentName.
  - getGemContainer
```
public DataSourceContainer getGemContainer()
```
    Returns:
    
    Returns the gemContainer.
  - getKey
```
public static java.lang.String getKey(SecsFormat3x5x vid,
                                      SecsFormat3x5x ceid,
                                      java.lang.String condition)
```
    Parameters:
    
    vid -
    
    ceid -
    
    condition -
    
    Returns:
  - getLimitName
```
public static java.lang.String getLimitName(java.lang.String type,
                                            long id,
                                            long limit)
```
    Parameters:
    
    type -
    
    id -
    
    limit -
    
    Returns:
  - getName
```
public static java.lang.String getName(int type,
                                       long id)
                                throws GemException
```
    Returns a string created from the given type and id.
    
    Parameters:
    
    type - the type of the server requested.
    
    id - the id of the GEM type requested
    
    Returns:
    
    a string representing the variable and type.
    
    Throws:
    
    GemException
  - getName
```
public static java.lang.String getName(java.lang.String type,
                                       java.lang.String id)
```
    Returns a string created from the given type and id.
    
    Parameters:
    
    type - the type of the server requested.
    
    id - the id of the variable to find
    
    Returns:
  - getOnlineHandler
```
public OnlineHandler getOnlineHandler()
```
    Returns the gem handler.
  - getOnlineMode
```
public int getOnlineMode()
```
    This will return the current online mode. These are defined in com.ergotech.secs.OnlineHandler
    
    Specified by:
    
    getOnlineMode in interface GemEquipmentInterface
  - getReportValues
```
public SecsFormat00 getReportValues(GemRPTID reportServer,
                                    ValueObjectInterface valueObject,
                                    boolean annotated)
```
    Creates the list of values for the report given. The return is just a list of values that represent report.
    
    Parameters:
    
    reportServer - the report for which the values are requested
    
    valueObject - must not be null. Only the properties are used. If the properties contains the id of a variable (as a string) the value associated with that variable will be used in the report in preference to the value of the svid (vid). This provides support for dvvals.
    
    annotated - if true, the report will be an annotated report.
    
    Returns:
  - getSecsFormat
```
public static SecsFormat getSecsFormat(double value,
                                       int type)
```
    This utility method will find the best container (SecsFormatxx) for a given value. the type should be 20, 30, 31, 32, etc. default if not a known type, we will store the toString into a SecsFormat20. We should at some point try to put it into a byte stream... but only useful if both side does it in the same way...
  - getSecsFormat
```
public static SecsFormat getSecsFormat(java.lang.Object value)
```
    This utility method will find the best container (SecsFormatxx) for a given value. (ie Double -> 40, Float -> 44, Long -> 30, Integer -> 34 ect) default if not a known type, we will store the toString into a SecsFormat20. We should at some point try to put it into a byte stream... but only useful if both side does it in the same way...
  - getServerFor
```
public GemID getServerFor(int type,
                          long id)
                   throws BadParameterException,
                          GemException
```
    Returns a GemID server associated with the given id and type.
    
    Throws:
    
    BadParameterException - thrown if a variable with the given id and type has not been registered.
    
    GemException - thrown if the type is invalid.
  - getServerForName
```
public DataSource getServerForName(java.lang.String serverName)
                            throws BadParameterException
```
    This method will return a sever that is managed by GEM and which matches the name provided. If no server exists, then the exception is thrown.
    
    Parameters:
    
    serverName - the name of the server
    
    Returns:
    
    the server
    
    Throws:
    
    BadParameterException - thrown if the server does not exist
  - getType
```
public static int getType(SecsFormat value)
```
    This will only work with the standard SecsFormat20, SecsFormat30, ect (the ones in the com.ergotech.secs package). Any other SecsFormats that we don't understand will return a -1;
  - getValue
```
public SecsFormat getValue(int 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. This may be null if the requested vid does not exist
  - getValue
```
public 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.
    
    Specified by:
    
    getValue in interface GemEquipmentInterface
    
    Parameters:
    
    vid - the VID to poll
    
    Returns:
    
    the current value of the vid expressed as a SecsFormat.
  - getValue
```
public SecsFormat getValue(java.lang.String vidName)
```
    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:
    
    vidName - the VID name for which the value will be returned.
  - isS1F3ReturnsValues
```
public static boolean isS1F3ReturnsValues()
```
    The return will be true if the S1F3 method should return the values rather than the IDs. IDs is compliant with the specification.
    
    Returns:
    
    S1F3ReturnsValues variable
  - populateDVIDs
```
public void populateDVIDs(ValueObjectInterface dvvals)
                   throws SecsException
```
    Populate all SVIDs and DVIDs with any values from the dvvals. This means that all DVIDs (and SVIDs) will contain the last value. This will be true whether the DVID was used in a report and whether the event/report was sent.
    
    Specified by:
    
    populateDVIDs in interface ReportWriter
    
    Throws:
    
    SecsException
  - registerAlarm
```
public void registerAlarm(SecsFormat alid,
                          GemALID theAlarm)
```
    Registers an alarm server with the given alid
    
    Parameters:
    
    alid - the alarm id
    
    theAlarm - the server to associate with the alarm id.
  - registerALID
```
public void registerALID(SecsFormat3x5x alid,
                         java.lang.String alidName,
                         java.lang.String altx,
                         byte alcd,
                         SecsFormat3x5x setCEID,
                         SecsFormat3x5x clearCEID)
```
    Alarm handling. This initializes the alarm management object and allows GEM to handle all the Stream 5 messages.
    
    Specified by:
    
    registerALID in interface GemEquipmentInterface
    
    Parameters:
    
    alid - the alarm id
    
    alidName - the name of the alid, may be null
    
    altx - the alarm text
    
    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
  - registerALID
```
public void registerALID(SecsFormat alid,
                         java.lang.String altx,
                         byte alcd,
                         int setCEID,
                         int clearCEID)
```
    Alarm handling. This initilizes the alarm management object and allows GEM to handle all the Stream 5 messages.
    
    Specified by:
    
    registerALID in interface GemEquipmentInterface
    
    Parameters:
    
    alid - the alarm id
    
    altx - the alarm text
    
    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
```
public GemCEID registerCEID(SecsFormat3x5x ceid)
```
    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.
  - registerCEID
```
public GemCEID registerCEID(SecsFormat3x5x ceid,
                            java.lang.String name,
                            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.
    
    Specified by:
    
    registerCEID in interface GemEquipmentInterface
    
    Parameters:
    
    ceid - the CEID to register
    
    name - the name of the CEID
    
    Returns:
    
    the GemCEID server created as a result of this registration
  - registerCEIDIfNotExist
```
public GemCEID registerCEIDIfNotExist(SecsFormat3x5x ceid,
                                      java.lang.String name,
                                      java.util.List<SecsFormat> dvids)
```
    CEID registration. This registers a CEID only if it does not already exist. This is used by limits and alarm registration to allow existing CEIDs to be used without renaming.
    
    Parameters:
    
    ceid - the CEID to register
    
    name - the name of the CEID
    
    Returns:
    
    the GemCEID server created as a result of this registration
  - registerECIDValidator
```
public void registerECIDValidator(int 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 - thrown if the vid is invalid
    
    See Also:
    
    ECIDValidationInterface
  - registerECIDValidator
```
public void registerECIDValidator(SecsFormat id,
                                  ECIDValidationInterface target)
                           throws GemException
```
    This method allows the equipment to validate an ECID before it is changed.
    
    Specified by:
    
    registerECIDValidator in interface GemEquipmentInterface
    
    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 - thrown if the vid is invalid
    
    See Also:
    
    ECIDValidationInterface
  - registerForUpdate
```
public void registerForUpdate(int 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
  - registerForUpdate
```
public 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
    
    Specified by:
    
    registerForUpdate in interface GemEquipmentInterface
    
    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
  - registerTrace
```
public TraceServer registerTrace(TRID trid,
                                 TOTSMP samples,
                                 REPGSZ sampleSize,
                                 SecsFormat00 svids)
                          throws SecsException
```
    /** Trace registration. This method will register a particular trace and so cause the trace messages to be sent to the host. This method is typically called on receipt of an S2F23 message.
    
    Parameters:
    
    trid - the trace id
    
    samples - the number of samples. This, divided by the report group sized determins the number of messages sent
    
    sampleSize - the report group size
    
    svids - the list of svids that are to be in the report.
    
    Returns:
    
    the TraceServer server created as a result of this registration
    
    Throws:
    
    SecsException - thrown if there is an error creating the trace server.
  - registerVID
```
public 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.
    
    Specified by:
    
    registerVID in interface GemEquipmentInterface
    
    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
    
    GemException
  - registerVID
```
public GemVID registerVID(SecsFormat3x5x vid,
                          java.lang.String name,
                          int type,
                          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.
    
    Specified by:
    
    registerVID in interface GemEquipmentInterface
    
    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
```
public 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.
    
    Specified by:
    
    registerVIDMonitor in interface GemEquipmentInterface
    
    Parameters:
    
    vid - the VID which must be registered
    
    the - CEID which will be registered as a SecsFormat54 if it is not already
    
    condition - one of "<", "<=", ">=", ">", "!=", "=", "==" or ""
    
    target - the target value
    
    Throws:
    
    GemException
  - removeByName
```
public void removeByName(java.util.Vector<? extends GemID> v,
                         java.lang.String name)
```
    Remove any server matching the name from the list
  - requestOnline
```
public 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.
    
    Specified by:
    
    requestOnline in interface GemEquipmentInterface
    
    Parameters:
    
    flag - online
    
    Throws:
    
    SECSException - thrown if the host declines on-line
    
    SecsException
  - S1F1
```
public boolean S1F1(SecsMsg msg)
```
    Respond to an S1F1. This method will create an S1F2 with the values retreived from two ECID called "SOFTREV" and "MDLN".
  - S1F11
```
public boolean S1F11(SecsMsg msg)
```
    This method receives an S1F11 and sends an S1F12. It builds the S1F12 from the information stored in the objects in the SVID hashtable.
  - S1F13
```
public boolean S1F13(SecsMsg msg)
```
    This method receives an S21F13 and sends an S2F14.
  - S1F21
```
public boolean S1F21(SecsMsg msg)
```
    This method receives an S1F21 and sends an S1F22. It builds the S1F21 from the information stored in the objects in the dvids hashtable.
  - S1F23
```
public boolean S1F23(SecsMsg msg)
```
    This method receives an S1F23 (CEID list request) and sends an S1F24 reply.
  - S1F3
```
public boolean S1F3(SecsMsg msg)
```
    This method receives an S1F3 and sends an S1F4. It builds the S1F4 from the information stored in the objects in the SVID hashtable.
  - S2F13
```
public boolean S2F13(SecsMsg msg)
```
    This method receives an S21F13 and sends an S2F14. It builds the S2F14 from the information stored in the objects in the ECID hashtable.
  - S2F15
```
public boolean S2F15(SecsMsg msg)
```
    This method receives an S21F15 and sends an S2F16.
  - S2F17
```
public boolean S2F17(SecsMsg msg)
```
    This method recieves an S2F17.
  - S2F23
```
public boolean S2F23(SecsMsg msg)
```
    This method recieves an S2F23.
  - S2F25
```
public boolean S2F25(SecsMsg msg)
```
    This method receives an S2,F25 Loopback Diagnostic Request (LDR) A diagnostic message for checkout of protocol and communication circuits. The binary string sent is echoed back. Structure and sends back an S2,F26 Loopback Diagnostic Data (LDD) Description The echoed binary string. Structure
  - S2F29
```
public boolean S2F29(SecsMsg msg)
```
    This method receives an S2F29 and sends an S2F30.
  - S2F31
```
public boolean S2F31(SecsMsg msg)
```
    This method receives an S2F31 and sends an S2F32. We can't persist the clock so we will just store it locally.
  - S2F33
```
public boolean S2F33(SecsMsg msg)
```
    This method receives an S2F33 and sends an S2F34. This will define the reports used in event messages
    Parameters:
    
    msg - the S2F33 message
    
    Returns:
    
    returns true if the message is handled correctly.
    
    SML Message Structure
    S2F33 W <L[2] <U4 DATAID> <L[a] <L[2] <U4 RPTID1> <L[b] <U4 VID1> <U4 VID2> [...] <U4 VIDb> > > <L[2] <U4 RPTID2> <L[c] <U4 VID1> <U4 VID2> [...] <U4 VIDc> > > [...] <L[2] <U4 RPTIDa> <L[d] <U4 VID1> <U4 VID2> [...] <U4 VIDd> > > > > .
    Detailed Message Description
    1. A list of zero-length following <DATAID> deletes all report definitions and associated links. See S2,F35 (Link Event/Report). 2. A list of zero-length following <RPTID> deletes report type RPTID. All CEID links to this RPTID are also deleted.
  - S2F35
```
public boolean S2F35(SecsMsg msg)
```
    This method receives an S2F35 and sends an S2F36. This will link reports to CEIDs
    Parameters:
    
    msg - the S2F35 message
    
    Returns:
    
    returns true if the message is handled correctly.
    
    SML Message Structure
    S2F35 W <L[2] <U4 DATAID> <L[a] <L[2] <U4 CEID1> <L[b] <U4 RPTID1> <U4 RPTID2> [...] <U4 RPTIDb> > > <L[2] <U4 CEID2> <L[c] <U4 RPTID1> <U4 RPTID2> [...] <U4 RPTIDc> > > [...] <L[2] <U4 CEIDa> <L[d] <U4 RPTID1> <U4 RPTID2> [...] <U4 RPTIDd> > > > > .
    Detailed Message Description
    A list of zero-length following <CEID> deletes all report links to that event.
  - S2F37
```
public boolean S2F37(SecsMsg msg)
```
    This method receives an S2F37 and sends an S2F38. This will enable or disable the reports.
    Parameters:
    
    msg - the S2F37 message
    
    Returns:
    
    returns true if the message is handled correctly.
    
    SML Message Structure
    S2F37 W <L[2] <Bo CEED> <L[n] <U4 CEID1> <U4 CEID2> [...] <U4 CEIDn> > > .
    Detailed Message Description
    The purpose of this message is for the host to enable or disable reporting for a group of events (CEIDs) A list of zero length following <CEED> means all CEIDs
  - S2F39
```
public boolean S2F39(SecsMsg msg)
```
    Stream 2 multi-block Request. We always ACK this with an OK.
  - S2F45
```
public boolean S2F45(SecsMsg msg)
```
    This will receive a S2F45 secs msg. This will work with the GemEquipment to configure the limits. This will send the reply as a S2F46 message.
  - S2F47
```
public boolean S2F47(SecsMsg msg)
```
    This method receives an S2F47 and sends an S2F48.
  - S5F3
```
public boolean S5F3(SecsMsg msg)
```
    Enable/Disable alarm send (EAS).
  - S5F5
```
public boolean S5F5(SecsMsg msg)
```
    List alarm request.
  - S5F7
```
public boolean S5F7(SecsMsg msg)
```
    List Enabled Alarm Request.
  - S6F15
```
public boolean S6F15(SecsMsg msg)
```
    Respond to the S6F15 message. Event Report Request, send the event.
  - S6F17
```
public boolean S6F17(SecsMsg msg)
```
    Respond to the S6F17 message. Annotated Event Report Request, send the event.
  - S6F19
```
public boolean S6F19(SecsMsg msg)
```
    S6F19 - Report Request.
  - S6F21
```
public boolean S6F21(SecsMsg msg)
```
    S6F21 - Annotated Report Request.
  - S6F5
```
public boolean S6F5(SecsMsg msg)
```
    Stream 6 multi-block Request. We always ACK this with an OK.
  - saveModel
```
public void saveModel()
```
    Save the model.
  - secsEvent
```
public void secsEvent(SecsEvent theEvent)
```
    This method will be called when a SecsEvent accurs.
    
    Specified by:
    
    secsEvent in interface SecsEventListener
  - sendEventReport
```
public void sendEventReport(int ceid,
                            java.util.Map<SecsFormat3x5x,SecsFormat> dvvals)
                     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. Any values provided in the dvvals that are used in the reports associated with the events will use the values from the Hashtable.
    
    Parameters:
    
    ceid - the id for which a message should be sent.
    
    dvvals - a table of SecsFormat3x5x ids vs SecsFormat values.
    
    Throws:
    
    SecsException
  - sendEventReport
```
public 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.
    
    Specified by:
    
    sendEventReport in interface GemEquipmentInterface
    
    Parameters:
    
    ceid - the id for which a message should be sent.
    
    Throws:
    
    SecsException
  - sendEventReport
```
public void sendEventReport(SecsFormat ceid,
                            java.util.Map<SecsFormat3x5x,SecsFormat> dvvals)
                     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. Any values provided in the dvvals that are used in the reports associated with the events will use the values from the Hashtable.
    
    Parameters:
    
    ceid - the id for which a message should be sent.
    
    dvvals - a table of SecsFormat3x5x ids vs SecsFormat values.
    
    Throws:
    
    SecsException
  - sendS9F7
```
public static void sendS9F7(SecsMsg msg)
```
    Send an S9F7 message.
  - setAlarm
```
public void setAlarm(int alid)
              throws SecsException
```
    Set Alarm will trigger an alarm. This will send out any messages then trigger the setCEID.
    
    Specified by:
    
    setAlarm in interface GemEquipmentInterface
    
    Parameters:
    
    alid - the alarm id
    
    Throws:
    
    SecsException - thrown if the event report is not sent because there is not connection to the host. Note that this will NOT be thrown if spooling is enabled even if there is no connection to the host.
  - setAlarm
```
public void setAlarm(SecsFormat3x5x alid)
              throws SecsException
```
    Set Alarm will trigger an alarm. This will send out any messages then trigger the setCEID.
    
    Specified by:
    
    setAlarm in interface GemEquipmentInterface
    
    Parameters:
    
    alid - the alarm id
    
    Throws:
    
    SecsException - thrown if the event report is not sent because there is not connection to the host. Note that this will NOT be thrown if spooling is enabled even if there is no connection to the host.
  - setAlarm
```
public void setAlarm(SecsFormat3x5x alid,
                     java.util.Hashtable<SecsFormat3x5x,SecsFormat> dvvals)
              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 - thrown if the event report is not sent because there is not connection to the host. Note that this will NOT be thrown if spooling is enabled even if there is no connection to the host.
  - setAllLimitToUndefined
```
public void setAllLimitToUndefined()
```
    This will set all limits to undefined.
  - setAllLimitToUndefined
```
public void setAllLimitToUndefined(GemVID vid)
```
    This will set all limits for a specific VID to undefined.
  - setDateOffset
```
public void setDateOffset(long offset)
```
    Sets the current date offset.
  - setEquipmentName
```
public void setEquipmentName(java.lang.String equipmentName)
                      throws BadParameterException
```
    Description copied from interface: GemEquipmentInterface
    
    Set the name of the equipment.
    
    Specified by:
    
    setEquipmentName in interface GemEquipmentInterface
    
    Parameters:
    
    equipmentName - The equipmentName to set.
    
    Throws:
    
    BadParameterException
  - setLimitToUndefined
```
public void setLimitToUndefined(GemVID vid,
                                int limitID)
```
    This will set a limit to undefined.
  - setLocal
```
public 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.
    
    Specified by:
    
    setLocal in interface GemEquipmentInterface
  - setOnlineHandler
```
public void setOnlineHandler(OnlineHandler oh)
```
    Set the object that will handle online/offline requests.
  - setS1F3ReturnsValues
```
public static void setS1F3ReturnsValues(boolean returnsValues)
```
    Set to true if the S1F3 method should return the values when a blank list is passed to the method rather than the IDs. NOTE: Setting this value to true is a violation of the SECS specification which calls for the SVIDs to be returned by the S1F3
    
    Parameters:
    
    returnsValues - the S1F3ReturnsValues parameter
  - setValue
```
public void setValue(int vid,
                     SecsFormat value)
```
    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.
  - setValue
```
public void setValue(SecsFormat vid,
                     SecsFormat value)
```
    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.
    
    Specified by:
    
    setValue in interface GemEquipmentInterface
    
    Parameters:
    
    vid - the VID to poll
    
    the - current value of the vid expressed as a double.
  - setValue
```
public void setValue(java.lang.String vidName,
                     SecsFormat value)
```
    This allows the equipment to set the value of any VID to the exact SecsFormat value.
    
    Parameters:
    
    vidName - the name of the VID to set
    
    the - new value of the vid
  - setValue
```
public void setValue(java.lang.String vidName,
                     ValueObjectInterface value)
```
    This allows the equipment to set the value of any VID. The SecsFormat value of the VID will be converted to match the default value of the server.
    
    Parameters:
    
    vidName - the name of the VID to set
    
    the - new value of the vid
  - stripType
```
public java.lang.String stripType(int type,
                                  java.lang.String name)
```
    This strips the type identifier from the string. The type must be one of the enumerations in GemEquipmentInterface.
    
    Parameters:
    
    type - the type of the variable this must be one of the types defined in GemEquipmentInterface. One of ECID, SVID, DVNAME, VID, CEID, ALID
    
    name - the name of the variable from which to strip the type prefix
    
    Returns:
    
    the string representing the type, one of the types defined in GemEquipmentInterface VID_STR, CEID_STR, ALID_STR

Class GemHandler

Field Summary

Fields inherited from interface com.ergotech.secs.gem.GemEquipmentInterface

Fields inherited from interface com.ergotech.secs.gem.ReportWriter

Fields inherited from interface com.ergotech.secs.gem.AlarmWriter

Fields inherited from interface com.ergotech.secs.SecsEventListener

Method Summary

Methods inherited from class java.lang.Object

Field Detail

alids

ceids

dataid

debugLevel

dvids

ecids

MDLN

monitors

nanoClock

onlineHandler

rptids

SOFTREV

svids

Method Detail

addMessageHandler

clearAlarm

clearAlarm

clearAlarm

convertDate

convertInstant

destroy

findLimit

generateAlarm

generateReport

generateReport

generateReport

getAdjustedDate

getAdjustedInstant

getAlarm

getAlarmsSet

getAllALIDs

getAllCEIDs

getAllDVIDs

getAllECIDs

getAllRPTID

getAllSVIDs

getData

getDateOffset

getDvname

getDVNAME

getEquipmentName

getGemContainer

getKey

getLimitName

getName

getName

getOnlineHandler

getOnlineMode

getReportValues

getSecsFormat

getSecsFormat

getServerFor

getServerForName

getType

getValue

getValue

getValue

isS1F3ReturnsValues

populateDVIDs

registerAlarm

registerALID

registerALID

registerCEID

registerCEID

registerCEIDIfNotExist

registerECIDValidator

registerECIDValidator

registerForUpdate

registerForUpdate

registerTrace

registerVID