org.eclipse.scada.da.server.io.common

Class BaseDeviceWrapper

java.lang.Object

org.eclipse.scada.da.server.io.common.BaseDeviceWrapper

All Implemented Interfaces:

ConnectionListener

public abstract class BaseDeviceWrapper
extends Object
implements ConnectionListener

Field Summary

Fields

Modifier and Type	Field and Description
protected FolderCommon	baseFolder
protected String	deviceTag
protected static int	RECONNECT_DELAY
protected ConnectionState	state

Constructor Summary

Constructors

Constructor and Description
BaseDeviceWrapper(HiveCommon hive, String deviceTag, ScheduledExecutorService scheduler, FolderCommon rootFolder)

Method Summary

Modifier and Type	Method and Description
void	closed(Throwable error) called when the data connection was lost
protected void	connect() perform a connect of the communication channel to the device
void	connectFailed(Throwable error) called when the data connection could not be opened
protected DataItemCommand	createCommand(String itemName) create a command item
protected abstract BaseDevice	createDevice()
protected DataItemInputChained	createInput(String itemName) create a new input item
protected HiveCommon	getHive()
String	getItemId(String item) generate an item name based on item name and device tag
protected abstract long	getTimeoutValue()
boolean	isConnected() get information if communication channel is connected
boolean	isDeviceOk() Check if the device communication is connected and the device communication is not timed out.
boolean	isTimeout()
boolean	isTimeoutCondition() get information if the communication to the device is timed out
protected void	onPostStateChange()
protected void	onPreStateChange(ConnectionState oldState, ConnectionState newState)
protected void	onTimeout(boolean timeout)
void	opened() called when the data connection is established
protected void	reconnect() schedule a reconnect if the device is disconnected it will set the state to ConnectionState.WAITING and schedule the connect call.
protected void	setConnectionState(ConnectionState state) set a new connection state
void	start()
void	stop()
protected void	tick()
protected void	tickLastInput()

Methods inherited from class java.lang.Object

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

Field Detail

RECONNECT_DELAY

protected static final int RECONNECT_DELAY

See Also:

Constant Field Values

deviceTag

protected String deviceTag

baseFolder

protected FolderCommon baseFolder

state

protected ConnectionState state

Constructor Detail

BaseDeviceWrapper

public BaseDeviceWrapper(HiveCommon hive,
                         String deviceTag,
                         ScheduledExecutorService scheduler,
                         FolderCommon rootFolder)

Method Detail

tick

protected void tick()

start

public void start()

stop

public void stop()

createDevice

protected abstract BaseDevice createDevice()

getItemId

public String getItemId(String item)

generate an item name based on item name and device tag

Parameters:

item - the requested item name

Returns:

the generated item name

createInput

protected DataItemInputChained createInput(String itemName)

create a new input item

Parameters:

itemName - the item name

Returns:

the input item

createCommand

protected DataItemCommand createCommand(String itemName)

create a command item

Parameters:

itemName - the item name

Returns:

the command item

setConnectionState

protected void setConnectionState(ConnectionState state)

set a new connection state

Parameters:

state - the new connection state

onPostStateChange

protected void onPostStateChange()

onPreStateChange

protected void onPreStateChange(ConnectionState oldState,
                                ConnectionState newState)

connect

protected void connect()

perform a connect of the communication channel to the device

reconnect

protected void reconnect()

schedule a reconnect
if the device is disconnected it will set the state to ConnectionState.WAITING and schedule the connect call.

isConnected

public boolean isConnected()

get information if communication channel is connected

Returns:

true if the connection is established

closed

public void closed(Throwable error)

called when the data connection was lost

Specified by:

closed in interface ConnectionListener

Parameters:

error - the error or null if no error is known

connectFailed

public void connectFailed(Throwable error)

called when the data connection could not be opened

Specified by:

connectFailed in interface ConnectionListener

Parameters:

error - the error or null if no error is known

opened

public void opened()

called when the data connection is established

Specified by:

opened in interface ConnectionListener

isDeviceOk

public boolean isDeviceOk()

Check if the device communication is connected and the device communication is not timed out.

Returns:

device state

isTimeoutCondition

public boolean isTimeoutCondition()

get information if the communication to the device is timed out

Returns:

true if the device is in time out

isTimeout

public boolean isTimeout()

getTimeoutValue

protected abstract long getTimeoutValue()

tickLastInput

protected void tickLastInput()

onTimeout

protected void onTimeout(boolean timeout)

getHive

protected HiveCommon getHive()