GemHostModel (ErgoTech VIB/TransSECS Scripting API)

java.lang.Object
- com.ergotech.secs.gem.GemToolModelSnapshot
- - com.ergotech.secs.gem.GemHostModel

Direct Known Subclasses:

GemHostDevicesModel
```
public class GemHostModel
extends GemToolModelSnapshot
```
This model is created by the host and used in the configuration of alarms, events, reports and limits.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`GemHostModel.GemTraceVariable` This adds the "set" variable that the tool side uses to store the current state of the alarm.
`static class`	`GemHostModel.GemValueVariable` This adds the "vid" variables.

Nested classes/interfaces inherited from class com.ergotech.secs.gem.GemToolModelSnapshot
GemToolModelSnapshot.GemAlarmVariable, GemToolModelSnapshot.GemLimitVariable, GemToolModelSnapshot.GemReportVariable, GemToolModelSnapshot.GemVariable

Field Summary

Fields
Modifier and Type	Field and Description
`int`	`alidSecsFormat` The format and so the byte-length of the integer ALID.
`int`	`ceidSecsFormat` The format and so the byte-length of the integer CEIDs.
`int`	`dataIdSecsFormat` The format and so the byte-length of the integer data ID.
`boolean`	`enableAllAlarms` Set to true to force the application to enable all alarms.
`boolean`	`enableAllEvents` Set to true to force the application to enable all events.
`int`	`rptidSecsFormat` The format and so the byte-length of the integer RPTID.
`int`	`totsmpSecsFormat` The format for trace reporting TOTSMP.
`int`	`tridSecsFormat` The format and so the byte-length of the integer TRID.
`int`	`vidSecsFormat` The format and so the byte-length of the integer VID.

Constructor Summary

Constructors
Constructor and Description

GemHostModel()
Default constructor.

Constructors
Constructor and Description
`GemHostModel()` Default constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GemHostModel.GemTraceVariable`	`addS1F3Poll(java.lang.String traceName, long pollId, java.util.List<java.lang.Long> vids, long startCeid, long endCeid, int totalSamples, double sampleInterval)` Add a S1F3 Poll variable.
`GemHostModel.GemTraceVariable`	`addTRID(java.lang.String traceName, long trid, java.util.List<java.lang.Long> vids, long startCeid, long endCeid, int totalSamples, double sampleInterval)` Add a trace variable.
`GemHostModel.GemValueVariable`	`addVID(java.lang.String name, long id, int vidType, int valueType)` Add a variable.
`int`	`getAlidSecsFormat()`
`int`	`getCeidSecsFormat()`
`int`	`getDataIdSecsFormat()`
`GemHostModel.GemTraceVariable`	`getremoveS1F3Poll(long trid)` Return a variable associated with the provided trid, or null if the poll is unknown.
`GemHostModel.GemTraceVariable`	`getremoveS1F3Poll(java.lang.String tridName)` Return a variable associated with the provided tridName, or null if the poll is unknown.
`int`	`getRptidSecsFormat()`
`java.util.List<GemHostModel.GemTraceVariable>`	`getS1F3Polls()`
`int`	`getTotsmpSecsFormat()`
`GemHostModel.GemTraceVariable`	`getTRID(long trid)` Return a variable associated with the provided trid, or null if the trid is unknown.
`GemHostModel.GemTraceVariable`	`getTRID(java.lang.String tridName)` Return a variable associated with the provided tridName, or null if the trid is unknown.
`java.util.List<GemHostModel.GemTraceVariable>`	`getTrids()`
`int`	`getTridSecsFormat()`
`GemHostModel.GemValueVariable`	`getVID(long vid)` Return a variable associated with the provided vid, or null if the vid is unknown.
`GemHostModel.GemValueVariable`	`getVID(java.lang.String vidName)` Return a variable associated with the provided vid public String toString() { String retString = "GEM Host Model VIDs:" + getVids().size() + " CEIDs:"+ getCeids().size() + " RPTIDs:" + getRptids().size() + " ALIDs:" + getAlids().size(); return retString; } Name, or null if the vid is unknown.
`java.util.List<GemHostModel.GemValueVariable>`	`getVids()`
`int`	`getVidSecsFormat()`
`boolean`	`isEnableAllAlarms()`
`boolean`	`isEnableAllEvents()`
`void`	`removeS1F3Poll(long pollId)` Remove the given trid.
`void`	`removeTRID(long id)` Remove the given trid.
`void`	`removeVID(long id)` Remove the given vid.
`void`	`setAlidSecsFormat(int alidSecsFormat)`
`void`	`setCeidSecsFormat(int ceidSecsFormat)`
`void`	`setDataIdSecsFormat(int dataIdSecsFormat)`
`void`	`setEnableAllAlarms(boolean enableAllAlarms)`
`void`	`setEnableAllEvents(boolean enableAllEvents)`
`void`	`setRptidSecsFormat(int rptidSecsFormat)`
`void`	`setTotsmpSecsFormat(int totsmpSecsFormat)`
`void`	`setTridSecsFormat(int tridSecsFormat)`
`void`	`setVidSecsFormat(int vidSecsFormat)`
`java.lang.String`	`toString()`

Methods inherited from class com.ergotech.secs.gem.GemToolModelSnapshot
addAlarm, addCeid, addReport, getALID, getAlids, getCEID, getCEID, getCeids, getLimitids, getRPTID, getRptids, removeAlarm, removeCEID, removeRPTID

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

- Field Detail
  - alidSecsFormat
```
public int alidSecsFormat
```
    The format and so the byte-length of the integer ALID. This is 50 (8 bytes ), 51 (1 byte), 52 (2 bytes), 54(4 bytes).
  - ceidSecsFormat
```
public int ceidSecsFormat
```
    The format and so the byte-length of the integer CEIDs. This is 50 (8 bytes ), 51 (1 byte), 52 (2 bytes), 54(4 bytes).
  - dataIdSecsFormat
```
public int dataIdSecsFormat
```
    The format and so the byte-length of the integer data ID. This is 50 (8 bytes ), 51 (1 byte), 52 (2 bytes), 54(4 bytes).
  - enableAllAlarms
```
public boolean enableAllAlarms
```
    Set to true to force the application to enable all alarms.
  - enableAllEvents
```
public boolean enableAllEvents
```
    Set to true to force the application to enable all events.
  - rptidSecsFormat
```
public int rptidSecsFormat
```
    The format and so the byte-length of the integer RPTID. This is 50 (8 bytes ), 51 (1 byte), 52 (2 bytes), 54(4 bytes).
  - totsmpSecsFormat
```
public int totsmpSecsFormat
```
    The format for trace reporting TOTSMP. This is 20,30() or 50().
  - tridSecsFormat
```
public int tridSecsFormat
```
    The format and so the byte-length of the integer TRID. This is 50 (8 bytes ), 51 (1 byte), 52 (2 bytes), 54(4 bytes).
  - vidSecsFormat
```
public int vidSecsFormat
```
    The format and so the byte-length of the integer VID. This is 50 (8 bytes ), 51 (1 byte), 52 (2 bytes), 54(4 bytes).
- Constructor Detail
  - GemHostModel
```
public GemHostModel()
```
    Default constructor.
- Method Detail
  - addS1F3Poll
```
public GemHostModel.GemTraceVariable addS1F3Poll(java.lang.String traceName,
                                                 long pollId,
                                                 java.util.List<java.lang.Long> vids,
                                                 long startCeid,
                                                 long endCeid,
                                                 int totalSamples,
                                                 double sampleInterval)
```
    Add a S1F3 Poll variable.
    
    Parameters:
    
    traceName - the name of the trace
    
    startCeid - the CEID that will start the trace data collection
    
    endCeid - the CEID that will end the trace data collection
    
    totalSamples - the maximum number of samples
    
    sampleInterval - the time, in seconds and decimal seconds between readings.
    
    pollId - the poll id
    
    Returns:
    
    the newly created trace
  - addTRID
```
public GemHostModel.GemTraceVariable addTRID(java.lang.String traceName,
                                             long trid,
                                             java.util.List<java.lang.Long> vids,
                                             long startCeid,
                                             long endCeid,
                                             int totalSamples,
                                             double sampleInterval)
```
    Add a trace variable.
    
    Parameters:
    
    traceName - the name of the trace
    
    startCeid - the CEID that will start the trace data collection
    
    endCeid - the CEID that will end the trace data collection
    
    totalSamples - the maximum number of samples
    
    sampleInterval - the time, in seconds and decimal seconds between readings.
    
    trid - the trace id
    
    Returns:
    
    the newly created trace
  - addVID
```
public GemHostModel.GemValueVariable addVID(java.lang.String name,
                                            long id,
                                            int vidType,
                                            int valueType)
```
    Add a variable.
    
    Parameters:
    
    name - the name of the vid
    
    id - the id of the vid
    
    vidType - the type of the vid - SVID, ECID, DVNAME as defined in the GemEquipmentInterface
    
    valueType - the type of the value. Required by the host application.
    
    Returns:
    
    the newly created vid
  - getAlidSecsFormat
```
public int getAlidSecsFormat()
```
    Returns:
    
    the alidSecsFormat
  - getCeidSecsFormat
```
public int getCeidSecsFormat()
```
    Returns:
    
    the ceidSecsFormat
  - getDataIdSecsFormat
```
public int getDataIdSecsFormat()
```
    Returns:
    
    the dataIdSecsFormat
  - getremoveS1F3Poll
```
public GemHostModel.GemTraceVariable getremoveS1F3Poll(long trid)
```
    Return a variable associated with the provided trid, or null if the poll is unknown.
    
    Parameters:
    
    pollId - the poll id
    
    Returns:
    
    a variable or null if the trid is unknown.
  - getremoveS1F3Poll
```
public GemHostModel.GemTraceVariable getremoveS1F3Poll(java.lang.String tridName)
```
    Return a variable associated with the provided tridName, or null if the poll is unknown.
    
    Parameters:
    
    tridName - the poll name to check
    
    Returns:
    
    a variable or null if the trid is unknown.
  - getRptidSecsFormat
```
public int getRptidSecsFormat()
```
    Returns:
    
    the rptidSecsFormat
  - getS1F3Polls
```
public java.util.List<GemHostModel.GemTraceVariable> getS1F3Polls()
```
    Returns:
    
    the configured s1f3Polls
  - getTotsmpSecsFormat
```
public int getTotsmpSecsFormat()
```
    Returns:
    
    the totsmpSecsFormat
  - getTRID
```
public GemHostModel.GemTraceVariable getTRID(long trid)
```
    Return a variable associated with the provided trid, or null if the trid is unknown.
    
    Parameters:
    
    trid - the trid to check
    
    Returns:
    
    a variable or null if the trid is unknown.
  - getTRID
```
public GemHostModel.GemTraceVariable getTRID(java.lang.String tridName)
```
    Return a variable associated with the provided tridName, or null if the trid is unknown.
    
    Parameters:
    
    tridName - the trid to check
    
    Returns:
    
    a variable or null if the trid is unknown.
  - getTrids
```
public java.util.List<GemHostModel.GemTraceVariable> getTrids()
```
    Returns:
    
    the configured trids
  - getTridSecsFormat
```
public int getTridSecsFormat()
```
    Returns:
    
    the tridSecsFormat
  - getVID
```
public GemHostModel.GemValueVariable getVID(long vid)
```
    Return a variable associated with the provided vid, or null if the vid is unknown.
    
    Parameters:
    
    vid - the vid to check
    
    Returns:
    
    a variable or null if the vid is unknown.
  - getVID
```
public GemHostModel.GemValueVariable getVID(java.lang.String vidName)
```
    Return a variable associated with the provided vid public String toString() { String retString = "GEM Host Model VIDs:" + getVids().size() + " CEIDs:"+ getCeids().size() + " RPTIDs:" + getRptids().size() + " ALIDs:" + getAlids().size(); return retString; } Name, or null if the vid is unknown.
    
    Parameters:
    
    vidName - the vid to check
    
    Returns:
    
    a variable or null if the vid is unknown.
  - getVids
```
public java.util.List<GemHostModel.GemValueVariable> getVids()
```
    Returns:
    
    the configured vids
  - getVidSecsFormat
```
public int getVidSecsFormat()
```
    Returns:
    
    the vidSecsFormat
  - isEnableAllAlarms
```
public boolean isEnableAllAlarms()
```
    Returns:
    
    the enableAllEvents
  - isEnableAllEvents
```
public boolean isEnableAllEvents()
```
    Returns:
    
    the enableAllEvents
  - removeS1F3Poll
```
public void removeS1F3Poll(long pollId)
```
    Remove the given trid.
    
    Parameters:
    
    pollId - the poll id
  - removeTRID
```
public void removeTRID(long id)
```
    Remove the given trid.
  - removeVID
```
public void removeVID(long id)
```
    Remove the given vid. This will also remove references to the VID from the reports.
  - setAlidSecsFormat
```
public void setAlidSecsFormat(int alidSecsFormat)
```
    Parameters:
    
    alidSecsFormat - the alidSecsFormat to set
  - setCeidSecsFormat
```
public void setCeidSecsFormat(int ceidSecsFormat)
```
    Parameters:
    
    ceidSecsFormat - the ceidSecsFormat to set
  - setDataIdSecsFormat
```
public void setDataIdSecsFormat(int dataIdSecsFormat)
```
    Parameters:
    
    dataIdSecsFormat - the dataIdSecsFormat to set
  - setEnableAllAlarms
```
public void setEnableAllAlarms(boolean enableAllAlarms)
```
    Parameters:
    
    enableAllEvents - the enableAllEvents to set
  - setEnableAllEvents
```
public void setEnableAllEvents(boolean enableAllEvents)
```
    Parameters:
    
    enableAllEvents - the enableAllEvents to set
  - setRptidSecsFormat
```
public void setRptidSecsFormat(int rptidSecsFormat)
```
    Parameters:
    
    rptidSecsFormat - the rptidSecsFormat to set
  - setTotsmpSecsFormat
```
public void setTotsmpSecsFormat(int totsmpSecsFormat)
```
    Parameters:
    
    totsmpSecsFormat - the totsmpSecsFormat to set
  - setTridSecsFormat
```
public void setTridSecsFormat(int tridSecsFormat)
```
    Parameters:
    
    tridSecsFormat - the tridSecsFormat
  - setVidSecsFormat
```
public void setVidSecsFormat(int vidSecsFormat)
```
    Parameters:
    
    vidSecsFormat - the vidSecsFormat to set
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class GemHostModel

Nested Class Summary

Nested classes/interfaces inherited from class com.ergotech.secs.gem.GemToolModelSnapshot

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.ergotech.secs.gem.GemToolModelSnapshot

Methods inherited from class java.lang.Object

Field Detail

alidSecsFormat

ceidSecsFormat

dataIdSecsFormat

enableAllAlarms

enableAllEvents

rptidSecsFormat

totsmpSecsFormat

tridSecsFormat

vidSecsFormat

Constructor Detail

GemHostModel

Method Detail

addS1F3Poll

addTRID

addVID

getAlidSecsFormat

getCeidSecsFormat

getDataIdSecsFormat

getremoveS1F3Poll

getremoveS1F3Poll

getRptidSecsFormat

getS1F3Polls

getTotsmpSecsFormat

getTRID

getTRID

getTrids

getTridSecsFormat

getVID

getVID

getVids

getVidSecsFormat

isEnableAllAlarms

isEnableAllEvents

removeS1F3Poll

removeTRID

removeVID

setAlidSecsFormat

setCeidSecsFormat

setDataIdSecsFormat

setEnableAllAlarms

setEnableAllEvents

setRptidSecsFormat

setTotsmpSecsFormat

setTridSecsFormat

setVidSecsFormat

toString