Package com.smartgridready.communicator.common.api.dto

Class DeviceInfo

java.lang.Object

com.smartgridready.communicator.common.api.dto.DeviceInfo

public class DeviceInfo
extends java.lang.Object

Implements a generic device information facade.

Constructor Summary

Constructors

Constructor

Description

DeviceInfo(java.lang.String name, java.lang.String manufacturer, java.lang.String versionNumber, java.lang.String softwareVersion, java.lang.String hardwareVersion, com.smartgridready.ns.v0.DeviceCategory deviceCategory, InterfaceType interfaceType, OperationEnvironment operationEnvironment, java.util.List<GenericAttribute> genericAttributes, java.util.List<ConfigurationValue> configurationInfo, java.util.List<FunctionalProfile> functionalProfiles)

Constructs a new instance.

Method Summary

Modifier and Type	Method	Description
java.util.List<ConfigurationValue>	getConfigurationInfo()	Gets the configuration parameters.
com.smartgridready.ns.v0.DeviceCategory	getDeviceCategory()	Gets the device category, defined by XML schema.
java.util.List<FunctionalProfile>	getFunctionalProfiles()	Gets the functional profiles.
java.util.List<GenericAttribute>	getGenericAttributes()	Gets the generic attributes at device-level.
java.lang.String	getHardwareVersion()	Gets the device hardware version compatible with the EID.
InterfaceType	getInterfaceType()	Gets the type of communication interface.
java.lang.String	getManufacturer()	Gets the device manufacturer name.
java.lang.String	getName()	Gets the device name.
OperationEnvironment	getOperationEnvironment()	Gets the device's operation environment.
java.lang.String	getSoftwareVersion()	Gets the device software version compatible with the EID.
java.util.List<DataPointValue>	getValues()	Reads all data point values from device.
java.lang.String	getVersionNumber()	Gets the EID version number.
java.util.List<DataPointValue>	readData()	Deprecated, for removal: This API element is subject to removal in a future version. Since version 2.1.0

Methods inherited from class java.lang.Object

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

Constructor Detail

DeviceInfo

public DeviceInfo(java.lang.String name,
                  java.lang.String manufacturer,
                  java.lang.String versionNumber,
                  java.lang.String softwareVersion,
                  java.lang.String hardwareVersion,
                  com.smartgridready.ns.v0.DeviceCategory deviceCategory,
                  InterfaceType interfaceType,
                  OperationEnvironment operationEnvironment,
                  java.util.List<GenericAttribute> genericAttributes,
                  java.util.List<ConfigurationValue> configurationInfo,
                  java.util.List<FunctionalProfile> functionalProfiles)

Constructs a new instance.

Parameters:

name - the device name

manufacturer - the device manufacturer

versionNumber - the EID version number

softwareVersion - the software version supported by the EID

hardwareVersion - the hardware version supported by the EID

deviceCategory - the device category

interfaceType - the type of communication interface

operationEnvironment - the environment the device operates in

genericAttributes - the generic attributes of the device

configurationInfo - the list of EID configuration parameters

functionalProfiles - the list of functional profiles

Method Detail

getName

public java.lang.String getName()

Gets the device name.

Returns:

a string

getManufacturer

public java.lang.String getManufacturer()

Gets the device manufacturer name.

Returns:

a string

getVersionNumber

public java.lang.String getVersionNumber()

Gets the EID version number.

Returns:

a string

getSoftwareVersion

public java.lang.String getSoftwareVersion()

Gets the device software version compatible with the EID.

Returns:

a string

getHardwareVersion

public java.lang.String getHardwareVersion()

Gets the device hardware version compatible with the EID.

Returns:

a string

getDeviceCategory

public com.smartgridready.ns.v0.DeviceCategory getDeviceCategory()

Gets the device category, defined by XML schema.

Returns:

an instance of DeviceCategory

getInterfaceType

public InterfaceType getInterfaceType()

Gets the type of communication interface.

Returns:

an instance of InterfaceType

getOperationEnvironment

public OperationEnvironment getOperationEnvironment()

Gets the device's operation environment.

Returns:

an instance of OperationEnvironment

getGenericAttributes

public java.util.List<GenericAttribute> getGenericAttributes()

Gets the generic attributes at device-level.

Returns:

a list of GenericAttribute

getConfigurationInfo

public java.util.List<ConfigurationValue> getConfigurationInfo()

Gets the configuration parameters.

Returns:

a list of ConfigurationValue

getFunctionalProfiles

public java.util.List<FunctionalProfile> getFunctionalProfiles()

Gets the functional profiles.

Returns:

a list of FunctionalProfile

getValues

public java.util.List<DataPointValue> getValues()

Reads all data point values from device.

Returns:

a list of DataPointValue

readData

@Deprecated(since="2.1.0",
            forRemoval=true)
public java.util.List<DataPointValue> readData()

Deprecated, for removal: This API element is subject to removal in a future version.

Since version 2.1.0

Reads all data point values from device.

Returns:

a list of DataPointValue