com.inductiveautomation.xopc.driver.configuration.meta

Interface DeviceConfiguration

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

DeviceReconfiguration

public interface DeviceConfiguration
extends java.io.Serializable

Method Summary

Modifier and Type	Method and Description
int	getBrowseTimeout() Gets the timeout (in ms) for browse operations on this device.
java.lang.String	getDeviceName() Returns the name of this device.
java.lang.String	getDriverClassName() Returns the full driver class name this device will use.
java.lang.String	getGroup() The name of the group this device belongs to.
java.util.Map<java.lang.String,DriverPropertyValue>	getProperties() Maps a DriverProperty.getId() -> DriverPropertyValue
int	getReadTimeout() Gets the timeout (in ms) for read operations on this device.
int	getWriteTimeout() Gets the timeout (in ms) for write operations on this device.
boolean	isEnabled() Gets whether or not this device should currently be enabled.

Method Detail

getDeviceName

java.lang.String getDeviceName()

Returns the name of this device.

Returns:

The name of this device.

getGroup

java.lang.String getGroup()

The name of the group this device belongs to. This is arbitrary and helps only with organizing the device list presented in the gateway.

Returns:

The group name this device belongs to.

getDriverClassName

java.lang.String getDriverClassName()

Returns the full driver class name this device will use.

Returns:

full driver class name.

getProperties

java.util.Map<java.lang.String,DriverPropertyValue> getProperties()

Maps a DriverProperty.getId() -> DriverPropertyValue

Returns:

getBrowseTimeout

int getBrowseTimeout()

Gets the timeout (in ms) for browse operations on this device.

Returns:

timeout (in ms)

getReadTimeout

int getReadTimeout()

Gets the timeout (in ms) for read operations on this device.

Returns:

timeout (in ms)

getWriteTimeout

int getWriteTimeout()

Gets the timeout (in ms) for write operations on this device.

Returns:

timeout (in ms)

isEnabled

boolean isEnabled()

Gets whether or not this device should currently be enabled. Disabled devices will not show up in the address space.

Returns: