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

Class FunctionalProfile

java.lang.Object

com.smartgridready.communicator.common.api.dto.FunctionalProfile

public class FunctionalProfile
extends java.lang.Object

Implements a generic functional profile facade.

Constructor Summary

Constructors

Constructor	Description
FunctionalProfile(java.lang.String name, java.lang.String profileType, com.smartgridready.ns.v0.FunctionalProfileCategory category, java.util.List<GenericAttribute> genericAttributes, java.util.List<DataPoint> dataPoints)	Constructs a new instance.

Method Summary

Modifier and Type	Method	Description
com.smartgridready.ns.v0.FunctionalProfileCategory	getCategory()	Gets the functional profile category.
java.util.List<DataPoint>	getDataPoints()	Gets the data points.
java.util.List<GenericAttribute>	getGenericAttributes()	Gets the generic attributes.
java.lang.String	getName()	Gets the functional profile name.
java.lang.String	getProfileType()	Gets the functional profile type.
java.util.List<DataPointValue>	getValues()	Reads all data point values from device.
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

FunctionalProfile

public FunctionalProfile(java.lang.String name,
                         java.lang.String profileType,
                         com.smartgridready.ns.v0.FunctionalProfileCategory category,
                         java.util.List<GenericAttribute> genericAttributes,
                         java.util.List<DataPoint> dataPoints)

Constructs a new instance.

Parameters:

name - the functional profile name

profileType - the functional profile type

category - the functional profile category

genericAttributes - the generic attributes

dataPoints - the functional profile's data points

Method Detail

getName

public java.lang.String getName()

Gets the functional profile name.

Returns:

a string

getProfileType

public java.lang.String getProfileType()

Gets the functional profile type.

Returns:

a string

getCategory

public com.smartgridready.ns.v0.FunctionalProfileCategory getCategory()

Gets the functional profile category.

Returns:

an instance of FunctionalProfileCategory

getGenericAttributes

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

Gets the generic attributes.

Returns:

a list of GenericAttribute

getDataPoints

public java.util.List<DataPoint> getDataPoints()

Gets the data points.

Returns:

a list of DataPoint

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