com.ergotech.util

Interface SimulationListener

All Known Subinterfaces:

ConstantSimulationListener

All Known Implementing Classes:

CachedDatabaseConnection, Constant, ControlLogixEthernetDeviceServer, ControlLogixEthernetDirectDeviceServer, CP243DeviceServer, CP243ITDeviceServer, CP243SlaveDeviceServer, CP343DeviceServer, DatabaseArrayRawLookup, DatabaseColumnMetaDataArray, DatabaseConnection, DatabaseRawLookup, DatabaseRawTableLookup, DatabaseRawWrite, DatabaseRowArrayLookup, DatabaseTableMetaDataArray, DF1DeviceServer, FinsDeviceServer, HistoricalDatabaseServer, HostLinkDeviceServer, HSMSSessionManager, HSMSSocketListener, LogixEthernetDeviceServer, MelsecDeviceServer, ModbusASCIIDeviceServer, ModbusDeviceServerBase, ModbusRTUDeviceServer, ModbusRTUDeviceServerBase, ModbusRTUOverBlueToothDeviceServer, ModbusRTUOverTCPDeviceServer, ModbusRTUSlave, ModbusSlave, ModbusSlaveBase, ModbusTCPDeviceServer, ModbusTCPDeviceServerBase, PLCDeviceServer, PortDeviceServer, PPIDeviceServer, PPIDeviceServerBase, RFC1006DeviceServer, SecsISessionManager, SerialPortDevice, SessionManager, SLC5EthernetDeviceServer, StartupTrigger, TriggeredHistorical

public interface SimulationListener

Objects that implement this interface can register for notification of simulation state changes.

Method Summary

Modifier and Type	Method and Description
void	setSimulationFlag(boolean simulationFlag) Force the listener to understand this method.
void	simulationStateChanged(SimulationChangedEvent simulationChangedEvent) This method will be called whenever the state of simulation changes.

Method Detail

setSimulationFlag

void setSimulationFlag(boolean simulationFlag)

Force the listener to understand this method. This method will be generated in the source code for any SimulationListener with a value of "false". This forces all systems to be live when deployed (unless the global simulation -D option is set.) This simulation flag may, or may not be controlled by the simulationChangedEvent above. For example, in the PLCs the simulationChangedEvent causes the global simulation flag to be set or reset, whereas the setSimulationFlag causes a local simulation flag to change. Again in the case of PLCs both flags must be false for the system to connect to the real device.

Parameters:

simulationFlag - will be written as "false" when code is generated.

simulationStateChanged

void simulationStateChanged(SimulationChangedEvent simulationChangedEvent)
                     throws java.lang.Exception

This method will be called whenever the state of simulation changes.

Throws:

java.lang.Exception - TODO