com.ergotech.secs.gem

Class GemHostModel.GemValueVariable

java.lang.Object

com.ergotech.secs.gem.GemToolModelSnapshot.GemVariable

com.ergotech.secs.gem.GemHostModel.GemValueVariable

Enclosing class:

GemHostModel

public static class GemHostModel.GemValueVariable
extends GemToolModelSnapshot.GemVariable

This adds the "vid" variables.

Field Summary

Fields inherited from class com.ergotech.secs.gem.GemToolModelSnapshot.GemVariable

id, name

Constructor Summary

Constructors

Constructor and Description
GemValueVariable() Create the ID.
GemValueVariable(java.lang.String name, long id, int vidType, int valueType) Create the ID.

Method Summary

Modifier and Type	Method and Description
SecsFormat	getCurrentValue() Return the current value of the variable.
java.lang.String	getDataSourceName()
int	getValueType()
int	getVidType()
void	setCurrentValue(SecsFormat currentValue) Sets the value of this variable.
void	setValueType(int valueType)

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

getId, getName, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

GemValueVariable

public GemValueVariable()

Create the ID. Default constructor required for XML serialization.

GemValueVariable

public GemValueVariable(java.lang.String name,
                        long id,
                        int vidType,
                        int valueType)

Create the ID.

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 matching the SECS type, 10, 11, 20, 30, 31, 32, 34, 40, 41, 42, 44, etc.

Method Detail

getCurrentValue

public SecsFormat getCurrentValue()

Return the current value of the variable. This will be null if the value has never been received from the tool.

Returns:

the current value of this variable or null if it has not been sent by the tool.

getDataSourceName

public java.lang.String getDataSourceName()

Specified by:

getDataSourceName in class GemToolModelSnapshot.GemVariable

Returns:

the name of the variable's data source (eg VID.valuename, CEID.eventname, etc.)

getValueType

public int getValueType()

Returns:

the SecsFormat type corresponding to the value type.

getVidType

public int getVidType()

Returns:

the type of this vid

setCurrentValue

public void setCurrentValue(SecsFormat currentValue)

Sets the value of this variable.

Parameters:

currentValue - the value received in an event message from the tool.

setValueType

public void setValueType(int valueType)

Parameters:

valueType - the valueType to set