GemIDConnection (ErgoTech VIB/TransSECS Scripting API)

java.lang.Object
- TransSECS.GemIDConnection

public class GemIDConnection
extends java.lang.Object

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class GemIDConnection.ValueConverter
Converts from a value object to a value.

Nested Classes
Modifier and Type	Class and Description
`static class`	`GemIDConnection.ValueConverter` Converts from a value object to a value.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALID` Used to identify a ALID.
`static java.lang.String`	`ALID_STR` The string used to describe all the ALIDs.
`static int`	`CEID` Used to identify a CEID.
`static java.lang.String`	`CEID_STR` The string used to describe all the CEIDs.
`static java.util.Hashtable`	`connections` All known connections.
`static int`	`DVNAME` Used to identify a DVNAME.
`static int`	`ECID` Used to identify an ECID.
`static int`	`LIMITID` Used to identify a LIMITID.
`static int`	`RPTID` Used to identify a RPTID.
`static int`	`SVID` Used to identify an SVID.
`static int`	`VID` Used to identify a VID.
`static java.lang.String`	`VID_STR` The string used to describe all the value IDs (VID, ECID, SVID, DVNAME).

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static GemIDConnection`	`createConnection(java.lang.String connectionName)` Called from C# to create the instance.
`void`	`enableAlarm(int alid, boolean enabled)` This method should be called from the C# object.
`void`	`enableEvent(int ceid, boolean enabled)` This method should be called from the C# object.
`boolean`	`getBooleanValue(int vid)` Get the current value of the VID as a boolean.
`TransSecsController`	`getController()`
`double`	`getDoubleValue(int vid)` Get the current value of the VID as a double (which can be converted to a float if needed).
`long`	`getIntValue(int vid)` Get the current value of the VID as a long (which can be converted to a byte, short, or int if needed).
`VIBMessageBean`	`getMessage(java.lang.String messageName)` Returns a message that can be sent from the interface.
`java.lang.String`	`getStringValue(int vid)` Get the current value of the VID as a String.
`boolean`	`registerForReceiveNotification(java.lang.String messageName, MessageNotifier messageReceivedInterface)`
`boolean`	`registerForValueNotification(int id, int type, ValueNotifier svidChanged)`
`void`	`setAlarm(int alid, boolean set)` This method should be called from the C# object.
`void`	`setBooleanValue(int id, boolean value)` This method should be called from the C# object.
`void`	`setDoubleValue(int id, double value)` This method should be called from the C# object.
`void`	`setIntValue(int id, int value)` This method should be called from the C# object.
`void`	`setStringValue(int id, java.lang.String value)` This method should be called from the C# object.
`void`	`triggerEvent(int ceid)` This method should be called from the C# object.

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

- Field Detail
  - ALID
```
public static final int ALID
```
    Used to identify a ALID.
    
    See Also:
    
    #registerForUpdate, Constant Field Values
  - ALID_STR
```
public static final java.lang.String ALID_STR
```
    The string used to describe all the ALIDs.
    
    See Also:
    
    Constant Field Values
  - CEID
```
public static final int CEID
```
    Used to identify a CEID.
    
    See Also:
    
    #registerForUpdate, Constant Field Values
  - CEID_STR
```
public static final java.lang.String CEID_STR
```
    The string used to describe all the CEIDs.
    
    See Also:
    
    Constant Field Values
  - connections
```
public static java.util.Hashtable connections
```
    All known connections.
  - DVNAME
```
public static final int DVNAME
```
    Used to identify a DVNAME.
    
    See Also:
    
    #registerVID, Constant Field Values
  - ECID
```
public static final int ECID
```
    Used to identify an ECID.
    
    See Also:
    
    #registerVID, Constant Field Values
  - LIMITID
```
public static final int LIMITID
```
    Used to identify a LIMITID.
    
    See Also:
    
    #registerForUpdate, Constant Field Values
  - RPTID
```
public static final int RPTID
```
    Used to identify a RPTID.
    
    See Also:
    
    #registerForUpdate, Constant Field Values
  - SVID
```
public static final int SVID
```
    Used to identify an SVID.
    
    See Also:
    
    #registerVID, Constant Field Values
  - VID
```
public static final int VID
```
    Used to identify a VID.
    
    See Also:
    
    #registerForUpdate, Constant Field Values
  - VID_STR
```
public static final java.lang.String VID_STR
```
    The string used to describe all the value IDs (VID, ECID, SVID, DVNAME).
    
    See Also:
    
    Constant Field Values
- Method Detail
  - createConnection
```
public static GemIDConnection createConnection(java.lang.String connectionName)
```
    Called from C# to create the instance.
  - enableAlarm
```
public void enableAlarm(int alid,
                        boolean enabled)
```
    This method should be called from the C# object.
    
    Throws:
    
    SecsException
  - enableEvent
```
public void enableEvent(int ceid,
                        boolean enabled)
```
    This method should be called from the C# object.
    
    Throws:
    
    SecsException
  - getBooleanValue
```
public boolean getBooleanValue(int vid)
```
    Get the current value of the VID as a boolean. This method should be called from the C# object.
  - getController
```
public TransSecsController getController()
```
  - getDoubleValue
```
public double getDoubleValue(int vid)
```
    Get the current value of the VID as a double (which can be converted to a float if needed). This method should be called from the C# object.
  - getIntValue
```
public long getIntValue(int vid)
```
    Get the current value of the VID as a long (which can be converted to a byte, short, or int if needed). This method should be called from the C# object.
    
    Parameters:
    
    vid - the vid of the value
  - getMessage
```
public VIBMessageBean getMessage(java.lang.String messageName)
```
    Returns a message that can be sent from the interface.
  - getStringValue
```
public java.lang.String getStringValue(int vid)
```
    Get the current value of the VID as a String. This method should be called from the C# object.
  - registerForReceiveNotification
```
public boolean registerForReceiveNotification(java.lang.String messageName,
                                              MessageNotifier messageReceivedInterface)
```
  - registerForValueNotification
```
public boolean registerForValueNotification(int id,
                                            int type,
                                            ValueNotifier svidChanged)
```
  - setAlarm
```
public void setAlarm(int alid,
                     boolean set)
```
    This method should be called from the C# object.
    
    Throws:
    
    SecsException
  - setBooleanValue
```
public void setBooleanValue(int id,
                            boolean value)
```
    This method should be called from the C# object.
    
    Throws:
    
    SecsException
  - setDoubleValue
```
public void setDoubleValue(int id,
                           double value)
```
    This method should be called from the C# object.
    
    Throws:
    
    SecsException
  - setIntValue
```
public void setIntValue(int id,
                        int value)
```
    This method should be called from the C# object.
    
    Throws:
    
    SecsException
  - setStringValue
```
public void setStringValue(int id,
                           java.lang.String value)
```
    This method should be called from the C# object.
    
    Throws:
    
    SecsException
  - triggerEvent
```
public void triggerEvent(int ceid)
```
    This method should be called from the C# object.
    
    Throws:
    
    SecsException

Class GemIDConnection

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ALID

ALID_STR

CEID

CEID_STR

connections

DVNAME

ECID

LIMITID

RPTID

SVID

VID

VID_STR

Method Detail

createConnection

enableAlarm

enableEvent

getBooleanValue

getController

getDoubleValue

getIntValue

getMessage

getStringValue

registerForReceiveNotification

registerForValueNotification

setAlarm

setBooleanValue

setDoubleValue

setIntValue

setStringValue

triggerEvent