stella.net.modbus

Class TcpMaster

java.lang.Object

util.PropertyContainer

io.AbstractDriver

io.AbstractSimulatingDriver

stella.net.modbus.TcpMaster

All Implemented Interfaces:

Driver, Cloneable, ExitCleaning, Initializable, Preserving, PropertySupplying, Simulating

Direct Known Subclasses:

MasterPollingRead

public abstract class TcpMaster
extends AbstractSimulatingDriver
implements Initializable

This is an abstract implementation of a moxa driver with the capabilities to open a connection and read it.

Field Summary

Fields

Modifier and Type	Field and Description
private static int	DEFMODBUSPORT Default moxa port.
private static boolean	DEFPERSISTENT Default persistent.
static String	KEY_MODBUSIP Points to the IP-address of the moxa module (tested with IP.IP.IP.IP)
static String	KEY_MODBUSPORT Point to the port of the moxa connection.
static String	KEY_MODBUSTIMEOUT Allowed timeout for the connection, probably milliseconds.
static String	KEY_PERSISTENT If true, connection is held open after first open.
private com.ghgande.j2mod.modbus.net.TCPMasterConnection	moxa The connection to the modbus slave.
private com.ghgande.j2mod.modbus.io.ModbusTCPTransaction	talk The transaction for the modbus commands.

Fields inherited from class io.AbstractSimulatingDriver

KEY_KEEPCOMMANDTIMES

Fields inherited from class io.AbstractDriver

KEY_DRIVERNAME

Fields inherited from class util.PropertyContainer

KEY_LISTSEPARATOR, KEY_MAPKEYVALUECHAR, KEY_MAPSEPARATOR

Fields inherited from interface util.PropertySupplying

CONFIG, KEY_CLASS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TcpMaster(Map<String,String> prop) Creates a new generic modbus driver as a modbus master (CLient)

Method Summary

Modifier and Type	Method and Description
boolean	close() We close the connection if the tcp master is not null.
(package private) com.ghgande.j2mod.modbus.io.ModbusTCPTransaction	getTransaction() ACess to the transport layer of the modbus.
void	init() If no explicit name is set, we use the IP-address as a driver name.
boolean	isOpen() We are considered open if the tcp master is not null and connected.
boolean	open() We open the connection by issuing a library command.
String	toString()

Methods inherited from class io.AbstractSimulatingDriver

accelerate, addCommandTime, exit, getAcceleration, getCommandTimeAverage, getCommandTimeRandomSample, getCommandTimeSigma, getSimulationStart, isSimulate, preserve, restore, simulateSince, startSimulate, stopSimulate

Methods inherited from class io.AbstractDriver

createDriver, equals, getDriverName, hashCode

Methods inherited from class util.PropertyContainer

augment, augment, augment, augment, augment, clone, defaultBoolean, defaultChar, defaultDouble, defaultFloat, defaultInt, defaultLong, defaultObject, defaultObject, defaultProperties, defaultProperty, getAsBoolean, getAsChar, getAsDouble, getAsEnums, getAsFloat, getAsInt, getAsList, getAsLong, getAsMap, getAsMap, getAsObject, getAsObject, getProperties, getProperty, has, initProperties, isNew, parseObject, parseObject, reload, reload, removeProperty, requires, rescanned, setObject, setProperties, setProperty, stringProperties

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

KEY_MODBUSIP

public static final String KEY_MODBUSIP

Points to the IP-address of the moxa module (tested with IP.IP.IP.IP)

See Also:

Constant Field Values

KEY_MODBUSPORT

public static final String KEY_MODBUSPORT

Point to the port of the moxa connection.

See Also:

Constant Field Values

KEY_MODBUSTIMEOUT

public static final String KEY_MODBUSTIMEOUT

Allowed timeout for the connection, probably milliseconds.

See Also:

Constant Field Values

KEY_PERSISTENT

public static final String KEY_PERSISTENT

If true, connection is held open after first open.

See Also:

Constant Field Values

DEFMODBUSPORT

private static final int DEFMODBUSPORT

Default moxa port.

See Also:

Constant Field Values

DEFPERSISTENT

private static final boolean DEFPERSISTENT

Default persistent.

See Also:

Constant Field Values

moxa

private transient com.ghgande.j2mod.modbus.net.TCPMasterConnection moxa

The connection to the modbus slave. For the work, talk.

talk

private transient com.ghgande.j2mod.modbus.io.ModbusTCPTransaction talk

The transaction for the modbus commands. Reused.

Constructor Detail

TcpMaster

protected TcpMaster(Map<String,String> prop)

Creates a new generic modbus driver as a modbus master (CLient)

Method Detail

init

public void init()
          throws InitException

If no explicit name is set, we use the IP-address as a driver name.

Specified by:

init in interface Initializable

Throws:

InitException

getTransaction

com.ghgande.j2mod.modbus.io.ModbusTCPTransaction getTransaction()

ACess to the transport layer of the modbus. Subclasses need access to actually do something with the modbus connection.

Note: Synchronize on it, if multiple thread are using the same modbus slave.

open

public boolean open()
             throws IOException

We open the connection by issuing a library command. If successful, we keep the handle, otherwise we throw an exception

Specified by:

open in interface Driver

Returns:

True if initialization was successful.

Throws:

IOException

close

public boolean close()
              throws IOException

We close the connection if the tcp master is not null.

Specified by:

close in interface Driver

Returns:

True if clean-up was successful.

Throws:

IOException

isOpen

public boolean isOpen()

We are considered open if the tcp master is not null and connected.

Specified by:

isOpen in interface Driver

Returns:

True, if a previous initialization was successful

toString

public String toString()

Overrides:

toString in class PropertyContainer