Package com.smartgridready.communicator.messaging.api

Interface GenDeviceApi4Messaging

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, GenDeviceApi

All Known Implementing Classes:

SGrMessagingDevice

public interface GenDeviceApi4Messaging
extends GenDeviceApi, java.io.Closeable

Defines the interface of a message-based device communication interface.

Method Summary

Modifier and Type	Method	Description
Value	getVal(java.lang.String profileName, java.lang.String dataPointName, long timeoutMs)	Gets a value from the device by reading
Value	getVal(java.lang.String profileName, java.lang.String dataPointName, java.util.Properties parameters, long timeoutMs)	Gets a value from the device by reading

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface com.smartgridready.communicator.common.api.GenDeviceApi

canSubscribe, connect, disconnect, getDataPoint, getDataPoints, getDeviceConfigurationInfo, getDeviceInfo, getFunctionalProfile, getFunctionalProfiles, getVal, getVal, getValues, isConnected, setVal, subscribe, unsubscribe

Method Detail

getVal

Value getVal(java.lang.String profileName,
             java.lang.String dataPointName,
             long timeoutMs)
      throws com.smartgridready.driver.api.common.GenDriverException

Gets a value from the device by reading

Parameters:

profileName - The functional profile name

dataPointName - The data point name

timeoutMs - The read timeout in milliseconds

Returns:

The value received from the device

Throws:

com.smartgridready.driver.api.common.GenDriverException - if an error occurs

getVal

Value getVal(java.lang.String profileName,
             java.lang.String dataPointName,
             java.util.Properties parameters,
             long timeoutMs)
      throws com.smartgridready.driver.api.common.GenDriverException

Gets a value from the device by reading

Parameters:

profileName - The functional profile name

dataPointName - The data point name

parameters - The request-specific parameters

timeoutMs - The read timeout in milliseconds

Returns:

The value received from the device

Throws:

com.smartgridready.driver.api.common.GenDriverException - if an error occurs