org.eclipse.kura.asset

Interface Asset

@ProviderType
public interface Asset

This interface Asset provides higher level abstraction to operate or perform actions on the industrial device. This actually propagates the necessary operations to the associated device driver. The asset exposes the generic operations to perform read, write and monitor operations. The asset only specifies the channel specific configuration (which is very channel descriptor specific) and the associated driver is mainly responsible for performing all the lower level tasks on the provided channel configuration.

Since:

1.2

See Also:

AssetRecord, AssetConfiguration

Method Summary

Modifier and Type	Method and Description
AssetConfiguration	getAssetConfiguration() Gets the asset configuration.
java.util.List<ChannelRecord>	read(java.util.Set<java.lang.String> channelNames) Reads the communication channels identified by the set of channel names provided as argument.
java.util.List<ChannelRecord>	readAllChannels() Performs a read on all READ or READ_WRITE channels that are defined on this asset and returns the result as a list of ChannelRecord instances.
void	registerChannelListener(java.lang.String channelName, ChannelListener channelListener) Registers a channel listener for the provided channel name for a monitor operation on it.
void	unregisterChannelListener(ChannelListener channelListener) Unregisters a already registered channel listener which has been registered for a monitor operation
void	write(java.util.List<ChannelRecord> channelRecords) Writes the data to the provided communication channels that correspond to the given channel records.

Method Detail

getAssetConfiguration

AssetConfiguration getAssetConfiguration()

Gets the asset configuration.

Returns:

the asset configuration

read

java.util.List<ChannelRecord> read(java.util.Set<java.lang.String> channelNames)
                            throws KuraException

Reads the communication channels identified by the set of channel names provided as argument. The read result is returned as a list of channel records. If for some reason the value of a channel cannot be read, a channel record containing a proper channel flag should be returned anyways. The channel flag shall best describe the reason of failure. If the connection to the asset is interrupted, then any necessary resources that correspond to this connection should be cleaned up and a KuraException shall be thrown.

Parameters:

channelNames - the set of channel names which are to be read. The channel name must be unique for every channel belonging to an asset. Channel names are case sensitive.

Returns:

the list of channel records which comprises the currently read value in case of success or the reason of failure

Throws:

KuraRuntimeException - if the method is not implemented by the asset then specific error code KuraErrorCode#OPERATION_NOT_SUPPORTED needs to be set in the thrown KuraRuntimeException

KuraException - if the connection to the asset was interrupted, then error code KuraErrorCode#CONNECTION_FAILED needs to be set in the thrown KuraException.

java.lang.NullPointerException - if argument is null

readAllChannels

java.util.List<ChannelRecord> readAllChannels()
                                       throws KuraException

Performs a read on all READ or READ_WRITE channels that are defined on this asset and returns the result as a list of ChannelRecord instances.

Returns:

the list of channel records which comprises the currently read value in case of success or the reason of failure

Throws:

KuraRuntimeException - if the method is not implemented by the asset then specific error code KuraErrorCode#OPERATION_NOT_SUPPORTED needs to be set in the thrown KuraRuntimeException

KuraException - if the connection to the asset was interrupted, then error code KuraErrorCode#CONNECTION_FAILED needs to be set in the thrown KuraException.

See Also:

Asset#read(List)

registerChannelListener

void registerChannelListener(java.lang.String channelName,
                             ChannelListener channelListener)
                      throws KuraException

Registers a channel listener for the provided channel name for a monitor operation on it.

Parameters:

channelName - the channel name. The channel name must be unique for every channel belonging to an asset. Channel names are case sensitive.

channelListener - the channel listener

Throws:

KuraRuntimeException - if the method is not implemented by the asset then specific error code KuraErrorCode.OPERATION_NOT_SUPPORTED needs to be set in the thrown KuraRuntimeException

KuraException - if the connection to the asset was interrupted, then error code KuraErrorCode.CONNECTION_FAILED needs to be set in the thrown KuraException and if the channel is not present, error code KuraErrorCode.INTERNAL_ERROR needs to be set in the thrown KuraException. For any other internal exception, then error code KuraErrorCode.INTERNAL_ERROR will be set.

java.lang.NullPointerException - if any of the arguments is null

java.lang.IllegalArgumentException - If the provided channel name is not present in the configuration of this asset

unregisterChannelListener

void unregisterChannelListener(ChannelListener channelListener)
                        throws KuraException

Unregisters a already registered channel listener which has been registered for a monitor operation

Parameters:

channelListener - the channel listener to unregister

Throws:

KuraRuntimeException - if the method is not implemented by the asset then specific error code KuraErrorCode#OPERATION_NOT_SUPPORTED needs to be set in the thrown KuraRuntimeException

KuraException - For any other internal exception, then error code KuraErrorCode#INTERNAL_ERROR will be set.

java.lang.NullPointerException - if argument is null

write

void write(java.util.List<ChannelRecord> channelRecords)
    throws KuraException

Writes the data to the provided communication channels that correspond to the given channel records. The write result is returned by setting the channel flag ChannelFlag.SUCCESS in the provided channel records. If the connection to the asset is interrupted, then any necessary resources that correspond to this connection should be cleaned up and a KuraException with a suitable error code shall be thrown.

Parameters:

channelRecords - the channel records hold the information of what channels are to be written and the values that are to be written. They will be filled by this function with a channel flag stating whether the write process is successful or not.

Throws:

KuraRuntimeException - if the method is not implemented by the asset then specific error code KuraErrorCode#OPERATION_NOT_SUPPORTED needs to be set in the thrown KuraRuntimeException

KuraException - if the connection to the asset was interrupted, then error code KuraErrorCode#CONNECTION_FAILED needs to be set in the thrown KuraException

java.lang.NullPointerException - if argument is null