com.fivecolibs.devices

Class FCOCRAPDevice

java.lang.Object

com.fivecolibs.devices.FCOCDevice

com.fivecolibs.devices.FCOCRAPDevice

All Implemented Interfaces:

java.lang.Runnable

public class FCOCRAPDevice
extends FCOCDevice

Standard FiveCo's FRAP devices connection class

Version:

4.4

Author:

agardiol

Field Summary

Fields

Modifier and Type	Field and Description
static int	m_nINITMAXPACKETSIZE Initial FRAP packet size (before getting device infos)

Fields inherited from class com.fivecolibs.devices.FCOCDevice

m_aInterfacesInfo

Constructor Summary

Constructors

Constructor and Description
FCOCRAPDevice(int nNumberOfRegisters, int nBufferSize, FCOIPort CommunicationPort, int nLocalAddress, int nRemoteAddress, boolean isNested, int nInterface)
FCOCRAPDevice(int nNumberOfRegisters, int nBufferSize, long lThreadSleep, FCOIPort CommunicationPort, int nLocalAddress, int nRemoteAddress, boolean isNested, int nInterface)
FCOCRAPDevice(int nNumberOfRegisters, int nBufferSize, long lThreadSleep, int nParentMaxBufferSize, FCOIPort CommunicationPort, int nLocalAddress, int nRemoteAddress, boolean isNested, int nInterface)

Method Summary

Modifier and Type	Method and Description
void	addDeviceListener(FCOIDeviceEvent DevListener) Adds an DeviceListener to the device.
FCOCDevice	addOtherDevice(java.lang.String szOtherDeviceName, int nAddress, int nNumberOfRegisters) Add another device to this FRAP device (same main bus).
void	addRegister(java.lang.String szRegisterName, int nRegisterAddress, int nRegisterSize, int nRegisterAccessType, int nDataType, boolean isAutoReadEnabled) Add a new register to this device.
FCOCDevice	addSubDevice(java.lang.String szNestedDeviceName, int nSubAddress, int nNumberOfRegisters, int nInterface) Add a new nested device to this FRAP device.
void	delete() Ask device object to stop its communication thread.
FCOIPort	getCommunicationPort()
int	getInterface()
int	getMaxPacketSize()
int	getRemoteAddress()
void	removeDeviceListener(FCOIDeviceEvent DevListener) Removes an DeviceListener from the device.
void	removeOtherDevice(java.lang.String szOtherDeviceName) Remove another device to this FRAP device.
void	removeSubDevice(java.lang.String szNestedDeviceName) Remove a nested device to this FRAP device.
void	run() Main communication thread loop (threadLoop() in dot net lib)
void	setBufferSize(int nBufferSize) Change the current communication buffer size.
int	setMaxPacketSize(int nMaxPacketSize) Set Max Packet Size (properties provided only for main class)
void	setMaxParentBufferSize(int nParentMaxBufferSize) Tell device what is its parent interface max buffer size
void	setNewRemoteAddress(int nRemoteAddress)
void	setThreadLoopTime(long lThreadSleep) Set sleep time to wait for an answer to an ask packet.

Methods inherited from class com.fivecolibs.devices.FCOCDevice

addRegister, askGetInterfaceInfo, call, getBufferSize, getDeviceListeners, getLastValueRead, getLastValueWritten, getRegisterAddress, getThisInterfaceInfo, getThreadLoopTime, getValue, getValue, receivedGetInterfacesInfo, removeRegister, setAutoreadState, setAutoreadSupended, setDebugLogEnabled, setInterfaceComSupendedState, setValue, setValue

Methods inherited from class java.lang.Object

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

Field Detail

m_nINITMAXPACKETSIZE

public static final int m_nINITMAXPACKETSIZE

Initial FRAP packet size (before getting device infos)

See Also:

Constant Field Values

Constructor Detail

FCOCRAPDevice

public FCOCRAPDevice(int nNumberOfRegisters,
                     int nBufferSize,
                     long lThreadSleep,
                     int nParentMaxBufferSize,
                     FCOIPort CommunicationPort,
                     int nLocalAddress,
                     int nRemoteAddress,
                     boolean isNested,
                     int nInterface)
              throws java.io.IOException

Parameters:

nNumberOfRegisters - Max number of registers of this device

nBufferSize - Communication link buffer size in bytes (max 16383 in current implementation)

lThreadSleep - Sleep time in milliseconds

nParentMaxBufferSize - Communication link buffer size in bytes of the parent device (for nested devices)

CommunicationPort - FiveCo communication port object implementing FCOIport

nLocalAddress - FRAP protocol local address (1-255)

nRemoteAddress - FRAP protocol remote (device) address (0-255)

isNested - Is this device the main one or a nested one ? Use also true for other devices on the main com with -1 as interface.

nInterface - Interface number of this device (0-15)

Throws:

java.io.IOException - Occurs when com parameters failed.

FCOCRAPDevice

public FCOCRAPDevice(int nNumberOfRegisters,
                     int nBufferSize,
                     long lThreadSleep,
                     FCOIPort CommunicationPort,
                     int nLocalAddress,
                     int nRemoteAddress,
                     boolean isNested,
                     int nInterface)
              throws java.io.IOException

Parameters:

nNumberOfRegisters - Max number of registers of this device

nBufferSize - Communication link buffer size in bytes (max 16383 in current implementation)

lThreadSleep - Sleep time in milliseconds

CommunicationPort - FiveCo communication port object implementing FCOIport

nLocalAddress - FRAP protocol local address (1-255)

nRemoteAddress - FRAP protocol remote (device) address (0-255)

isNested - Is this device the main one or a nested one ? Use also true for other devices on the main com with -1 as interface.

nInterface - Interface number of this device (0-15)

Throws:

java.io.IOException - Occurs when com parameters failed.

FCOCRAPDevice

public FCOCRAPDevice(int nNumberOfRegisters,
                     int nBufferSize,
                     FCOIPort CommunicationPort,
                     int nLocalAddress,
                     int nRemoteAddress,
                     boolean isNested,
                     int nInterface)
              throws java.io.IOException

Parameters:

nNumberOfRegisters - Max number of registers of this device

nBufferSize - Communication link buffer size in bytes (max 127 in current implementation)

CommunicationPort - FiveCo communication port object implementing FCOIport

nLocalAddress - FRAP protocol local address (1-255)

nRemoteAddress - FRAP protocol remote (device) address (0-255)

isNested - Is this device the main one or a nested one ? Use also true for other devices on the main com with -1 as interface.

nInterface - Interface number of this device (0-15)

Throws:

java.io.IOException - Occurs when communication parameters failed.

Method Detail

delete

public void delete()

Description copied from class: FCOCDevice

Ask device object to stop its communication thread.

Specified by:

delete in class FCOCDevice

addDeviceListener

public void addDeviceListener(FCOIDeviceEvent DevListener)

Description copied from class: FCOCDevice

Adds an DeviceListener to the device.

Overrides:

addDeviceListener in class FCOCDevice

Parameters:

DevListener - the DeviceListener to be added

removeDeviceListener

public void removeDeviceListener(FCOIDeviceEvent DevListener)

Description copied from class: FCOCDevice

Removes an DeviceListener from the device.

Overrides:

removeDeviceListener in class FCOCDevice

Parameters:

DevListener - the listener to be removed

addRegister

public void addRegister(java.lang.String szRegisterName,
                        int nRegisterAddress,
                        int nRegisterSize,
                        int nRegisterAccessType,
                        int nDataType,
                        boolean isAutoReadEnabled)
                 throws java.lang.IllegalArgumentException

Add a new register to this device.

Overrides:

addRegister in class FCOCDevice

Parameters:

szRegisterName - Name of the register

nRegisterAddress - Register index in registers table

nRegisterSize - Register's size

nRegisterAccessType - Access type between nAT_FCT, nAT_R, nAT_W and nAT_RW

nDataType - Data packing class type between nDT_INT (Long), nDT_UINT (Long), nDT_BIN (BitSet), nDT_PERCENT (Double 0-100), nDT_TEXT (string), nDT_ARRAY (Byte[]), nDT_FIXEDP (Double)

isAutoReadEnabled - Ask thread to read this register at each communication loop

Throws:

java.lang.IllegalArgumentException - If one parameter is not valid (see console)

addSubDevice

public FCOCDevice addSubDevice(java.lang.String szNestedDeviceName,
                               int nSubAddress,
                               int nNumberOfRegisters,
                               int nInterface)
                        throws java.io.IOException

Add a new nested device to this FRAP device.

Specified by:

addSubDevice in class FCOCDevice

Parameters:

szNestedDeviceName - Name of this nested device for further reference

nSubAddress - New sub device address

nNumberOfRegisters - Maximum registers count of the sub device

nInterface - Interface number of the sub device (0-15)

Returns:

FRAP sub device object

Throws:

java.io.IOException - Exception thrown if a parameter is invalid

removeSubDevice

public void removeSubDevice(java.lang.String szNestedDeviceName)

Remove a nested device to this FRAP device.

Specified by:

removeSubDevice in class FCOCDevice

Parameters:

szNestedDeviceName - Name of the nested device to remove

setThreadLoopTime

public void setThreadLoopTime(long lThreadSleep)

Set sleep time to wait for an answer to an ask packet.

Overrides:

setThreadLoopTime in class FCOCDevice

Parameters:

lThreadSleep - Sleep time in milliseconds

getInterface

public int getInterface()

Specified by:

getInterface in class FCOCDevice

Returns:

Device interface number

addOtherDevice

public FCOCDevice addOtherDevice(java.lang.String szOtherDeviceName,
                                 int nAddress,
                                 int nNumberOfRegisters)
                          throws java.io.IOException

Add another device to this FRAP device (same main bus).

Parameters:

szOtherDeviceName - Name of this device for further reference

nAddress - New device address

nNumberOfRegisters - Maximum registers count of the sub device

Returns:

FRAP device object

Throws:

java.io.IOException - Exception thrown if a parameter is invalid

removeOtherDevice

public void removeOtherDevice(java.lang.String szOtherDeviceName)

Remove another device to this FRAP device.

Parameters:

szOtherDeviceName - Name of the device to remove

setNewRemoteAddress

public void setNewRemoteAddress(int nRemoteAddress)

Parameters:

nRemoteAddress - New remote address

getRemoteAddress

public int getRemoteAddress()

Returns:

this device remote address

getCommunicationPort

public FCOIPort getCommunicationPort()

Returns:

Communication Port object

setMaxParentBufferSize

public void setMaxParentBufferSize(int nParentMaxBufferSize)

Description copied from class: FCOCDevice

Tell device what is its parent interface max buffer size

Overrides:

setMaxParentBufferSize in class FCOCDevice

Parameters:

nParentMaxBufferSize - Parent buffer size

setBufferSize

public void setBufferSize(int nBufferSize)

Description copied from class: FCOCDevice

Change the current communication buffer size. WARNING: Sub classes must check buffer size to apply changes.

Overrides:

setBufferSize in class FCOCDevice

Parameters:

nBufferSize - New buffer size

setMaxPacketSize

public int setMaxPacketSize(int nMaxPacketSize)

Set Max Packet Size (properties provided only for main class)

Parameters:

nMaxPacketSize - New max packet size (truncated if too big)

Returns:

New max packet size applied (can be minimized by parent max buffer size)

getMaxPacketSize

public int getMaxPacketSize()

Returns:

Current max packet size

run

public void run()

Description copied from class: FCOCDevice

Main communication thread loop (threadLoop() in dot net lib)

Specified by:

run in interface java.lang.Runnable

Specified by:

run in class FCOCDevice