com.ergotech.secs.gem

Class GemToolModelSnapshot

java.lang.Object

com.ergotech.secs.gem.GemToolModelSnapshot

Direct Known Subclasses:

GemHostModel, GemToolPersistentModelSnapshot

public class GemToolModelSnapshot
extends java.lang.Object

Instances of this object are created and then stored by the GEM Handler - and the reverse from which a GEMHandler is configured. This model is not the definitive model for the equipment side interface. It is created by the host and is the definitive model for configuring the host messages sent to the tool. This is not the entire GEM model. No servers should be created based on the information stored here. The snapshot model simply maintains the dynamic state of the variables in the system. So, for example, TransSECS will create the CEIDs, but does not know whether a particular CEID was enabled. GEM requires that this be persisted across restarts of the GEM server, so the serialized version of this snapshot will "remember" the enabled state of the CEID and set it accordingly. However, if that CEID no longer exists, then it will be ignored (and not created). Similarly for alarms, reports, limits, etc.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GemToolModelSnapshot.GemAlarmVariable This adds the "set" variable that the tool side uses to store the current state of the alarm.
static class	GemToolModelSnapshot.GemLimitVariable This adds the configuration for a limit id.
static class	GemToolModelSnapshot.GemReportVariable This adds a list of VIDs that are associated with this report.
static class	GemToolModelSnapshot.GemVariable Storage for an ID/value pair.

Constructor Summary

Constructors

Constructor and Description
GemToolModelSnapshot() Default constructor.

Method Summary

Modifier and Type	Method and Description
GemToolModelSnapshot.GemAlarmVariable	addAlarm(java.lang.String name, long id) Add an alarm variable.
GemToolModelSnapshot.GemReportVariable	addCeid(java.lang.String name, long id, java.util.List<java.lang.Long> rptids, boolean configured) Add a ceid.
GemToolModelSnapshot.GemReportVariable	addReport(java.lang.String name, long id, java.util.List<java.lang.Long> vids, boolean configured) Add a report.
GemToolModelSnapshot.GemAlarmVariable	getALID(long alid) Return a variable associated with the provided ceid, or null if the ceid is unknown.
java.util.List<GemToolModelSnapshot.GemAlarmVariable>	getAlids()
GemToolModelSnapshot.GemReportVariable	getCEID(long ceid) Return a variable associated with the provided ceid, or null if the ceid is unknown.
GemToolModelSnapshot.GemReportVariable	getCEID(java.lang.String ceidName) Return a variable associated with the provided ceid, or null if the ceid is unknown.
java.util.List<GemToolModelSnapshot.GemReportVariable>	getCeids()
java.util.List<GemToolModelSnapshot.GemLimitVariable>	getLimitids()
GemToolModelSnapshot.GemReportVariable	getRPTID(long rptid) Return a variable associated with the provided rptid, or null if the rptid is unknown.
java.util.List<GemToolModelSnapshot.GemReportVariable>	getRptids()
void	removeAlarm(long id) Remove the given ceid.
void	removeCEID(long id) Remove the given ceid.
void	removeRPTID(long id) Remove the given ceid.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GemToolModelSnapshot

public GemToolModelSnapshot()

Default constructor.

Method Detail

addAlarm

public GemToolModelSnapshot.GemAlarmVariable addAlarm(java.lang.String name,
                                                      long id)

Add an alarm variable.

addCeid

public GemToolModelSnapshot.GemReportVariable addCeid(java.lang.String name,
                                                      long id,
                                                      java.util.List<java.lang.Long> rptids,
                                                      boolean configured)

Add a ceid.

Parameters:

name - the name of the ceid

id - the id

rptids - the associated report ids (can be null)

configured - true if the tool has this a default ceid and so this host should not configure it.

Returns:

the newly created ceid

addReport

public GemToolModelSnapshot.GemReportVariable addReport(java.lang.String name,
                                                        long id,
                                                        java.util.List<java.lang.Long> vids,
                                                        boolean configured)

Add a report.

Parameters:

name - the name of the report

id - the id

rptids - the associated vids ids (can be null)

configured - true if the tool has this a default report and so this host should not configure it.

Returns:

the newly created report

getALID

public GemToolModelSnapshot.GemAlarmVariable getALID(long alid)

Return a variable associated with the provided ceid, or null if the ceid is unknown.

Parameters:

ceid - the ceid to check

Returns:

a variable or null if the ceid is unknown.

getAlids

public java.util.List<GemToolModelSnapshot.GemAlarmVariable> getAlids()

Returns:

the configured alids

getCEID

public GemToolModelSnapshot.GemReportVariable getCEID(long ceid)

Return a variable associated with the provided ceid, or null if the ceid is unknown.

Parameters:

ceid - the ceid to check

Returns:

a variable or null if the ceid is unknown.

getCEID

public GemToolModelSnapshot.GemReportVariable getCEID(java.lang.String ceidName)

Return a variable associated with the provided ceid, or null if the ceid is unknown.

Parameters:

ceid - the ceid to check

Returns:

a variable or null if the ceid is unknown.

getCeids

public java.util.List<GemToolModelSnapshot.GemReportVariable> getCeids()

Returns:

the configured ceids

getLimitids

public java.util.List<GemToolModelSnapshot.GemLimitVariable> getLimitids()

Returns:

the configured limit ids

getRPTID

public GemToolModelSnapshot.GemReportVariable getRPTID(long rptid)

Return a variable associated with the provided rptid, or null if the rptid is unknown.

Parameters:

rptid - the rptid to check

Returns:

a variable or null if the rptid is unknown.

getRptids

public java.util.List<GemToolModelSnapshot.GemReportVariable> getRptids()

Returns:

the configured rptids

removeAlarm

public void removeAlarm(long id)

Remove the given ceid.

removeCEID

public void removeCEID(long id)

Remove the given ceid.

removeRPTID

public void removeRPTID(long id)

Remove the given ceid.