edu.wisc.trace.uch.tdm.gc100.lib
Interface IGC100ControlPoint

All Known Implementing Classes:

GC100ControlPoint

public interface IGC100ControlPoint

Manages connections, disconnections and action of the devices attached to the GC-100 devices.

Version:

$Revision: 1.3 $

Author:

Parikshit Thakur & Team, Trace R&D Center

Field Summary

static int	BAUD_RATE_VALUE_1200
static int	BAUD_RATE_VALUE_19200
static int	BAUD_RATE_VALUE_2400
static int	BAUD_RATE_VALUE_38400
static int	BAUD_RATE_VALUE_4800
static int	BAUD_RATE_VALUE_57600
static int	BAUD_RATE_VALUE_9600
static java.lang.String	FLOW_CONTROL_VALUE_FLOW_HARDWARE
static java.lang.String	FLOW_CONTROL_VALUE_FLOW_NONE
static java.lang.String	PARITY_VALUE_PARITY_EVEN
static java.lang.String	PARITY_VALUE_PARITY_NO
static java.lang.String	PARITY_VALUE_PARITY_ODD

Method Summary

boolean	addGCDeviceChangeListener(IGCDeviceChangeListener gcDeviceChangeListener) Add IGCDeviceChangeListener.
boolean	addGCUpdateListener(java.lang.String uuid, int module, int connector, IGCUpdateListener gcUpdateListener) Add the IGCUpdateListener.
java.lang.String	confugureDevice(java.lang.String uuid, java.lang.String configData) Configure specified GC100 Device.
boolean	connectTarget(java.lang.String uuid, int module, int connector) Method to connect to the specified target device connected to the specified 'module' and 'connector'.
void	disConnectTarget(java.lang.String uuid, int module, int connector) Called when any target is disconnected.
java.lang.String	doAction(java.lang.String uuid, int module, int connector, java.lang.String code) Call the action on specific GC-100 device using 'uuid' and get requested values.
java.util.Set<GCDevice>	getAvailableDevices() Get available GC100 Devices.
boolean	removeGCDeviceChangeListener(IGCDeviceChangeListener gcDeviceChangeListener) Remove IGCDeviceChangeListener.
boolean	removeGCUpdateListener(java.lang.String uuid, int module, int connector, IGCUpdateListener gcUpdateListener) Remove the IGCUpdateListener.

Field Detail

BAUD_RATE_VALUE_1200

static final int BAUD_RATE_VALUE_1200

See Also:

Constant Field Values

BAUD_RATE_VALUE_2400

static final int BAUD_RATE_VALUE_2400

See Also:

Constant Field Values

BAUD_RATE_VALUE_4800

static final int BAUD_RATE_VALUE_4800

See Also:

Constant Field Values

BAUD_RATE_VALUE_9600

static final int BAUD_RATE_VALUE_9600

See Also:

Constant Field Values

BAUD_RATE_VALUE_19200

static final int BAUD_RATE_VALUE_19200

See Also:

Constant Field Values

BAUD_RATE_VALUE_38400

static final int BAUD_RATE_VALUE_38400

See Also:

Constant Field Values

BAUD_RATE_VALUE_57600

static final int BAUD_RATE_VALUE_57600

See Also:

Constant Field Values

FLOW_CONTROL_VALUE_FLOW_HARDWARE

static final java.lang.String FLOW_CONTROL_VALUE_FLOW_HARDWARE

See Also:

Constant Field Values

FLOW_CONTROL_VALUE_FLOW_NONE

static final java.lang.String FLOW_CONTROL_VALUE_FLOW_NONE

See Also:

Constant Field Values

PARITY_VALUE_PARITY_NO

static final java.lang.String PARITY_VALUE_PARITY_NO

See Also:

Constant Field Values

PARITY_VALUE_PARITY_ODD

static final java.lang.String PARITY_VALUE_PARITY_ODD

See Also:

Constant Field Values

PARITY_VALUE_PARITY_EVEN

static final java.lang.String PARITY_VALUE_PARITY_EVEN

See Also:

Constant Field Values

Method Detail

doAction

java.lang.String doAction(java.lang.String uuid,
                          int module,
                          int connector,
                          java.lang.String code)

Call the action on specific GC-100 device using 'uuid' and get requested values.

Parameters:

uuid - a String value of uuid

module - an integer value of module

connector - an integer value of connector

code - a String value of code

Returns:

a String value of response

connectTarget

boolean connectTarget(java.lang.String uuid,
                      int module,
                      int connector)

Method to connect to the specified target device connected to the specified 'module' and 'connector'.

Parameters:

uuid - a String value of uuid

module - an integer value of module

connector - an integer value of connector

Returns:

a boolean whether device is connected to the specified module or not.

disConnectTarget

void disConnectTarget(java.lang.String uuid,
                      int module,
                      int connector)

Called when any target is disconnected.

Parameters:

uuid - a String value of uuid

module - an integer value of module

connector - an integer value of connector

addGCDeviceChangeListener

boolean addGCDeviceChangeListener(IGCDeviceChangeListener gcDeviceChangeListener)

Add IGCDeviceChangeListener.

Parameters:

gcDeviceChangeListener - an object of IGCDeviceChangeListener.

Returns:

a boolean value.

removeGCDeviceChangeListener

boolean removeGCDeviceChangeListener(IGCDeviceChangeListener gcDeviceChangeListener)

Remove IGCDeviceChangeListener.

Parameters:

gcDeviceChangeListener - an object of IGCDeviceChangeListener.

Returns:

a boolean value.

addGCUpdateListener

boolean addGCUpdateListener(java.lang.String uuid,
                            int module,
                            int connector,
                            IGCUpdateListener gcUpdateListener)

Add the IGCUpdateListener.

Parameters:

gcUpdateListener - an object of IGCUpdateListener.

uuid - a String value of UUID

module - an int value of Module

connector - an int value of Connector

Returns:

a boolean value.

removeGCUpdateListener

boolean removeGCUpdateListener(java.lang.String uuid,
                               int module,
                               int connector,
                               IGCUpdateListener gcUpdateListener)

Remove the IGCUpdateListener.

Parameters:

gcUpdateListener - an object of IGCUpdateListener.

uuid - a String value of UUID

module - an integer value of Module

connector - an integer value of Connector

Returns:

a boolean value.

getAvailableDevices

java.util.Set<GCDevice> getAvailableDevices()

Get available GC100 Devices.

Returns:

an Object of Set<GCDevices> specifies available devices

confugureDevice

java.lang.String confugureDevice(java.lang.String uuid,
                                 java.lang.String configData)

Configure specified GC100 Device.

Parameters:

uuid - a String value of UUID

configData - a String specifies configuration data

Returns:

a String specifies configuration response