GemEquipment (ErgoTech VIB/TransSECS Scripting API)

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

```
public class GemEquipment
extends java.lang.Object
```
This class is the entry point for any gem interface. Given the name of the interface, you can find the handlers for that interface and save and restore the GEM model.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addMessageHandler(java.lang.Object messageHandler)` Add an additional message hanlder.
`static void`	`destroyGemEquipment(java.lang.String equipmentName)` Remove the named equipment from the available equipment list.
`CommunicationsHandler`	`getCommunicationsHandler()` This returns the Communication Handler.
`EquipmentControlInterface`	`getEquipment()` This returns the Equipment Control.
`GemEquipmentInterface`	`getGemEquipment()` This returns the GemEquipment.
`static GemEquipmentInterface`	`getGemEquipment(java.lang.String equipmentName)` Return the GemEquipment for the name provided.
`static GemEquipment`	`getGemEquipmentFor(java.lang.String equipmentName)` Return the GemEquipment for the name provided.
`OnlineHandler`	`getOnlineHandler()` This returns the Online Handler.
`java.lang.String`	`getPersistenceFileName()`
`WrapperInterface`	`getWrapper()` This returns the wrapper.
`EquipmentControlInterface`	`registerWrapperForEquipmentControl(WrapperInterface wrapper)` If you register with this method, the you will have access to the GemEquipment or the equipment control (both the same object).
`static void`	`removeGemEquipment(java.lang.String equipmentName)` Remove the named equipment from the available equipment list.
`void`	`removeMessageHandler(java.lang.Object messageHandler)` Remove an additional message hanlder.
`boolean`	`restoreModel()` Restore the GEM model from the Persistence File.
`void`	`saveModel()` Save the GEM model to the Persistence File.
`void`	`setCommunicationsHandlerFactoryClass(java.lang.Class<? extends CommunicationsHandler> communicationsHandlerFactory)` Set a subclass of the CommunicationsHandler as the factory class for communications control.
`void`	`setEquipmentControlFactoryClass(java.lang.Class<? extends ECHandler> equipmentFactory)` Set an instance of the EquipmentControlInterface as the factory class for equipment control.
`void`	`setInitialStates(int initialCommunicationsState, int initialOnlineState)` Set initial states.
`void`	`setOnlineHandlerFactoryClass(java.lang.Class<? extends OnlineHandler> onlineHandlerFactory)` Set a subclass of the OnlineHandler as the factory class for online/offline control.
`void`	`setPersistenceFileName(java.lang.String persistenceFileName)`

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

- Method Detail
  - addMessageHandler
```
public void addMessageHandler(java.lang.Object messageHandler)
```
    Add an additional message hanlder. This is used for 300mm standards. The order added will be the order that the message handlers are added to the connection. These will be added immediately if there is a valid connection or after the GEMHandler when the wrapper is registered. Calls to this method with duplicate messageHandlers are ignored.
    
    Parameters:
    
    messageHandler - a message handler for E39, E40, E87, etc.
  - destroyGemEquipment
```
public static void destroyGemEquipment(java.lang.String equipmentName)
```
    Remove the named equipment from the available equipment list. This usually means that the equipment has been destroyed.
  - getCommunicationsHandler
```
public CommunicationsHandler getCommunicationsHandler()
```
    This returns the Communication Handler.
  - getEquipment
```
public EquipmentControlInterface getEquipment()
```
    This returns the Equipment Control.
  - getGemEquipment
```
public GemEquipmentInterface getGemEquipment()
```
    This returns the GemEquipment.
  - getGemEquipment
```
public static GemEquipmentInterface getGemEquipment(java.lang.String equipmentName)
```
    Return the GemEquipment for the name provided. If the string is null, then the request is treated as an empty string. An empty string is considered the default equipment, and is the normal request for a single gem interface.
  - getGemEquipmentFor
```
public static GemEquipment getGemEquipmentFor(java.lang.String equipmentName)
```
    Return the GemEquipment for the name provided. If the string is null, then the request is treated as an empty string. An empty string is considered the default equipment, and is the normal request for a single gem interface.
  - getOnlineHandler
```
public OnlineHandler getOnlineHandler()
```
    This returns the Online Handler.
  - getPersistenceFileName
```
public java.lang.String getPersistenceFileName()
```
    Returns:
    
    Returns the persistenceFileName.
  - getWrapper
```
public WrapperInterface getWrapper()
```
    This returns the wrapper.
  - registerWrapperForEquipmentControl
```
public EquipmentControlInterface registerWrapperForEquipmentControl(WrapperInterface wrapper)
```
    If you register with this method, the you will have access to the GemEquipment or the equipment control (both the same object). This is the more general case register method. If you don't know what people will need, then register here instead of registerWrapperForGemEquipment.
  - removeGemEquipment
```
public static void removeGemEquipment(java.lang.String equipmentName)
```
    Remove the named equipment from the available equipment list. This usually means that the equipment has been destroyed.
  - removeMessageHandler
```
public void removeMessageHandler(java.lang.Object messageHandler)
```
    Remove an additional message hanlder. This is used for 300mm standards. The order added will be the order that the message handlers are added to the connection. These will be added immediately if there is a valid connection or after the GEMHandler when the wrapper is registered. Calls to this method with duplicate messageHandlers are ignored.
    
    Parameters:
    
    messageHandler - a message handler for E39, E40, E87, etc.
  - restoreModel
```
public boolean restoreModel()
```
    Restore the GEM model from the Persistence File.
  - saveModel
```
public void saveModel()
```
    Save the GEM model to the Persistence File.
  - setCommunicationsHandlerFactoryClass
```
public void setCommunicationsHandlerFactoryClass(java.lang.Class<? extends CommunicationsHandler> communicationsHandlerFactory)
```
    Set a subclass of the CommunicationsHandler as the factory class for communications control. This must be set before the instances are created. The class registered should be a subclass of CommunicationsHandler
    
    See Also:
    
    CommunicationsHandler
  - setEquipmentControlFactoryClass
```
public void setEquipmentControlFactoryClass(java.lang.Class<? extends ECHandler> equipmentFactory)
```
    Set an instance of the EquipmentControlInterface as the factory class for equipment control. This must be set before the instances are created. The class registered should be a subclass of ECHandler
    
    See Also:
    
    ECHandler
  - setInitialStates
```
public void setInitialStates(int initialCommunicationsState,
                             int initialOnlineState)
```
    Set initial states. This will configure the Communications and Online states. This method is a cover for the "changeState" method in those two objects. The communications states should be one of the states defined in SessionManager, that is, DISABLED, NOT_COMMUNICATING, EQUIPMENT_INITIATED_CONNECT, EQUIPMENT_INITIATED_CONNECT_WAIT_CRA, EQUIPMENT_INITIATED_CONNECT_WAIT_DELAY, HOST_INITIATED_CONNECT, WAIT_CR_FROM_HOST, COMMUNICATING, with the obvious observation that not all should be considered viable candidates. This state will be set as soon as this method is called. The Online states are defined in the OnlineHandler as: EQUIPMENT_OFFLINE, ATTEMPT_ONLINE, HOST_OFFLINE, LOCAL_ONLINE, REMOTE_ONLINE. This value will not be set until the online handler is created.
    
    See Also:
    
    SessionManager, CommunicationsHandler, OnlineHandler
  - setOnlineHandlerFactoryClass
```
public void setOnlineHandlerFactoryClass(java.lang.Class<? extends OnlineHandler> onlineHandlerFactory)
```
    Set a subclass of the OnlineHandler as the factory class for online/offline control. This must be set before the instances are created. The class registered should be a subclass of OnlineHandler
    
    See Also:
    
    OnlineHandler
  - setPersistenceFileName
```
public void setPersistenceFileName(java.lang.String persistenceFileName)
```
    Parameters:
    
    persistenceFileName - The persistenceFileName to set.

Class GemEquipment

Method Summary

Methods inherited from class java.lang.Object

Method Detail

addMessageHandler

destroyGemEquipment

getCommunicationsHandler

getEquipment

getGemEquipment

getGemEquipment

getGemEquipmentFor

getOnlineHandler

getPersistenceFileName

getWrapper

registerWrapperForEquipmentControl

removeGemEquipment

removeMessageHandler

restoreModel

saveModel

setCommunicationsHandlerFactoryClass

setEquipmentControlFactoryClass

setInitialStates

setOnlineHandlerFactoryClass

setPersistenceFileName