org.eclipse.kura.asset

Class AssetConfiguration

java.lang.Object

org.eclipse.kura.asset.AssetConfiguration

@Immutable
 @ThreadSafe
 @ProviderType
public class AssetConfiguration
extends java.lang.Object

The Class AssetConfiguration is responsible for storing the configuration for an industrial device (also known as Asset in the context of Eclipse Kura).

Since:

1.2

See Also:

Channel, ChannelType, DataType

Constructor Summary

Constructors

Constructor and Description
AssetConfiguration(java.lang.String description, java.lang.String driverPid, java.util.Map<java.lang.String,Channel> channels) Instantiates a new asset configuration.

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,Channel>	getAssetChannels() Gets the asset channels.
java.lang.String	getAssetDescription() Gets the asset description.
java.lang.String	getDriverPid() Gets the driver PID.
void	setAssetDescription(java.lang.String description) Sets the asset description.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AssetConfiguration

public AssetConfiguration(java.lang.String description,
                          java.lang.String driverPid,
                          java.util.Map<java.lang.String,Channel> channels)

Instantiates a new asset configuration.

Parameters:

description - the description of the asset

driverPid - the driver PID

channels - the map of all channel configurations

Throws:

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

Method Detail

getAssetChannels

public java.util.Map<java.lang.String,Channel> getAssetChannels()

Gets the asset channels.

Returns:

the asset channels

getAssetDescription

public java.lang.String getAssetDescription()

Gets the asset description.

Returns:

the asset description

getDriverPid

public java.lang.String getDriverPid()

Gets the driver PID.

Returns:

the driver PID

setAssetDescription

public void setAssetDescription(java.lang.String description)

Sets the asset description.

Parameters:

description - the new asset description

Throws:

java.lang.NullPointerException - if the argument is null

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object