gurux.dlms.objects.GXDLMSLimiter Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of gurux.dlms Show documentation
Show all versions of gurux.dlms Show documentation
gurux.dlms.java package is used to communicate with DLMS devices.
//
// --------------------------------------------------------------------------
// Gurux Ltd
//
//
//
// Filename: $HeadURL$
//
// Version: $Revision$,
// $Date$
// $Author$
//
// Copyright (c) Gurux Ltd
//
//---------------------------------------------------------------------------
//
// DESCRIPTION
//
// This file is a part of Gurux Device Framework.
//
// Gurux Device Framework is Open Source software; you can redistribute it
// and/or modify it under the terms of the GNU General Public License
// as published by the Free Software Foundation; version 2 of the License.
// Gurux Device Framework is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
// See the GNU General Public License for more details.
//
// More information of Gurux products: https://www.gurux.org
//
// This code is licensed under the GNU General Public License v2.
// Full text may be retrieved at http://www.gnu.org/licenses/gpl-2.0.txt
//---------------------------------------------------------------------------
package gurux.dlms.objects;
import java.util.ArrayList;
import java.util.List;
import javax.xml.stream.XMLStreamException;
import gurux.dlms.GXByteBuffer;
import gurux.dlms.GXDLMSClient;
import gurux.dlms.GXDLMSSettings;
import gurux.dlms.GXDateTime;
import gurux.dlms.ValueEventArgs;
import gurux.dlms.enums.DataType;
import gurux.dlms.enums.ErrorCode;
import gurux.dlms.enums.ObjectType;
import gurux.dlms.internal.GXCommon;
/**
* Online help:
* https://www.gurux.fi/Gurux.DLMS.Objects.GXDLMSLimiter
*/
public class GXDLMSLimiter extends GXDLMSObject implements IGXDLMSBase {
private GXDLMSObject monitoredValue;
private int monitoredAttributeIndex;
private Object thresholdActive;
private Object thresholdNormal;
private Object thresholdEmergency;
private long minOverThresholdDuration;
private long minUnderThresholdDuration;
private GXDLMSEmergencyProfile emergencyProfile;
private int[] emergencyProfileGroupIDs;
private boolean emergencyProfileActive;
private GXDLMSActionItem actionOverThreshold;
private GXDLMSActionItem actionUnderThreshold;
/**
* Constructor.
*/
public GXDLMSLimiter() {
super(ObjectType.LIMITER);
emergencyProfile = new GXDLMSEmergencyProfile();
actionOverThreshold = new GXDLMSActionItem();
actionUnderThreshold = new GXDLMSActionItem();
}
/**
* Constructor.
*
* @param ln
* Logical Name of the object.
*/
public GXDLMSLimiter(final String ln) {
super(ObjectType.LIMITER, ln, 0);
emergencyProfile = new GXDLMSEmergencyProfile();
actionOverThreshold = new GXDLMSActionItem();
actionUnderThreshold = new GXDLMSActionItem();
}
/**
* Constructor.
*
* @param ln
* Logical Name of the object.
* @param sn
* Short Name of the object.
*/
public GXDLMSLimiter(final String ln, final int sn) {
super(ObjectType.LIMITER, ln, sn);
emergencyProfile = new GXDLMSEmergencyProfile();
actionOverThreshold = new GXDLMSActionItem();
actionUnderThreshold = new GXDLMSActionItem();
}
/**
* @return Defines an attribute of an object to be monitored.
*/
public final GXDLMSObject getMonitoredValue() {
return monitoredValue;
}
/**
* @param value
* Defines an attribute of an object to be monitored.
*/
public final void setMonitoredValue(final GXDLMSObject value) {
monitoredValue = value;
}
public final int getmonitoredAttributeIndex() {
return monitoredAttributeIndex;
}
public final void setmonitoredAttributeIndex(final int value) {
monitoredAttributeIndex = value;
}
/**
* @return Provides the active threshold value to which the attribute
* monitored is compared.
*/
public final Object getThresholdActive() {
return thresholdActive;
}
/**
* @param value
* Provides the active threshold value to which the attribute
* monitored is compared.
*/
public final void setThresholdActive(final Object value) {
thresholdActive = value;
}
/**
* @return Provides the threshold value to which the attribute monitored is
* compared when in normal operation.
*/
public final Object getThresholdNormal() {
return thresholdNormal;
}
/**
* @param value
* Provides the threshold value to which the attribute monitored
* is compared when in normal operation.
*/
public final void setThresholdNormal(final Object value) {
thresholdNormal = value;
}
/**
* @return Provides the threshold value to which the attribute monitored is
* compared when an emergency profile is active.
*/
public final Object getThresholdEmergency() {
return thresholdEmergency;
}
/**
* @param value
* Provides the threshold value to which the attribute monitored
* is compared when an emergency profile is active.
*/
public final void setThresholdEmergency(final Object value) {
thresholdEmergency = value;
}
/**
* @return Defines minimal over threshold duration in seconds required to
* execute the over threshold action.
*/
public final long getMinOverThresholdDuration() {
return minOverThresholdDuration;
}
/**
* @param value
* Defines minimal over threshold duration in seconds required to
* execute the over threshold action.
*/
public final void setMinOverThresholdDuration(final long value) {
minOverThresholdDuration = value;
}
/**
* @return Defines minimal under threshold duration in seconds required to
* execute the under threshold action.
*/
public final long getMinUnderThresholdDuration() {
return minUnderThresholdDuration;
}
/**
* @param value
* Defines minimal under threshold duration in seconds required
* to execute the under threshold action.
*/
public final void setMinUnderThresholdDuration(final long value) {
minUnderThresholdDuration = value;
}
/**
* @return Emergency profile.
*/
public final GXDLMSEmergencyProfile getEmergencyProfile() {
return emergencyProfile;
}
/**
* @param value
* Emergency profile.
*/
public final void setEmergencyProfile(final GXDLMSEmergencyProfile value) {
emergencyProfile = value;
}
/**
* @return Emergency profile group IDs.
*/
public final int[] getEmergencyProfileGroupIDs() {
return emergencyProfileGroupIDs;
}
/**
* @param value
* Emergency profile group IDs.
*/
public final void setEmergencyProfileGroupIDs(final int[] value) {
emergencyProfileGroupIDs = value;
}
/**
* @return Is Emergency Profile active.
*/
public final boolean getEmergencyProfileActive() {
return emergencyProfileActive;
}
/**
* @param value
* Is Emergency Profile active.
*/
public final void setEmergencyProfileActive(final boolean value) {
emergencyProfileActive = value;
}
/**
* @return Defines the scripts to be executed when the monitored value
* crosses the threshold for minimal duration time.
*/
public final GXDLMSActionItem getActionOverThreshold() {
return actionOverThreshold;
}
/**
* @param value
* Defines the scripts to be executed when the monitored value
* crosses the threshold for minimal duration time.
*/
public final void setActionOverThreshold(final GXDLMSActionItem value) {
actionOverThreshold = value;
}
/**
* @return Defines the scripts to be executed when the monitored value
* crosses the threshold for minimal duration time.
*/
public final GXDLMSActionItem getActionUnderThreshold() {
return actionUnderThreshold;
}
/**
* @param value
* Defines the scripts to be executed when the monitored value
* crosses the threshold for minimal duration time.
*/
public final void setActionUnderThreshold(final GXDLMSActionItem value) {
actionUnderThreshold = value;
}
@Override
public final Object[] getValues() {
return new Object[] { getLogicalName(), monitoredValue, thresholdActive, thresholdNormal, thresholdEmergency,
minOverThresholdDuration, minUnderThresholdDuration, emergencyProfile, emergencyProfileGroupIDs,
emergencyProfileActive, new Object[] { actionOverThreshold, actionUnderThreshold } };
}
@Override
public final int[] getAttributeIndexToRead(final boolean all) {
java.util.ArrayList attributes = new java.util.ArrayList();
// LN is static and read only once.
if (all || getLogicalName() == null || getLogicalName().compareTo("") == 0) {
attributes.add(1);
}
// MonitoredValue
if (all || canRead(2)) {
attributes.add(2);
}
// ThresholdActive
if (all || canRead(3)) {
attributes.add(3);
}
// ThresholdNormal
if (all || canRead(4)) {
attributes.add(4);
}
// ThresholdEmergency
if (all || canRead(5)) {
attributes.add(5);
}
// MinOverThresholdDuration
if (all || canRead(6)) {
attributes.add(6);
}
// MinUnderThresholdDuration
if (all || canRead(7)) {
attributes.add(7);
}
// EmergencyProfile
if (all || canRead(8)) {
attributes.add(8);
}
// EmergencyProfileGroup
if (all || canRead(9)) {
attributes.add(9);
}
// EmergencyProfileActive
if (all || canRead(10)) {
attributes.add(10);
}
// Actions
if (all || canRead(11)) {
attributes.add(11);
}
return GXDLMSObjectHelpers.toIntArray(attributes);
}
/*
* Returns amount of attributes.
*/
@Override
public final int getAttributeCount() {
return 11;
}
/*
* Returns amount of methods.
*/
@Override
public final int getMethodCount() {
return 0;
}
@Override
public final DataType getDataType(final int index) {
if (index == 1) {
return DataType.OCTET_STRING;
}
if (index == 2) {
return DataType.STRUCTURE;
}
if (index == 3) {
return super.getDataType(index);
}
if (index == 4) {
return super.getDataType(index);
}
if (index == 5) {
return super.getDataType(index);
}
if (index == 6) {
return DataType.UINT32;
}
if (index == 7) {
return DataType.UINT32;
}
if (index == 8) {
return DataType.STRUCTURE;
}
if (index == 9) {
return DataType.ARRAY;
}
if (index == 10) {
return DataType.BOOLEAN;
}
if (index == 11) {
return DataType.STRUCTURE;
}
throw new IllegalArgumentException("getDataType failed. Invalid attribute index.");
}
/*
* Returns value of given attribute.
*/
@Override
public final Object getValue(final GXDLMSSettings settings, final ValueEventArgs e) {
if (e.getIndex() == 1) {
return GXCommon.logicalNameToBytes(getLogicalName());
} else if (e.getIndex() == 2) {
GXByteBuffer data = new GXByteBuffer();
data.setUInt8(DataType.STRUCTURE.getValue());
data.setUInt8(3);
if (monitoredValue == null) {
GXCommon.setData(settings, data, DataType.UINT16, 0);
GXCommon.setData(settings, data, DataType.OCTET_STRING, GXCommon.logicalNameToBytes(null));
GXCommon.setData(settings, data, DataType.INT8, 0);
} else {
GXCommon.setData(settings, data, DataType.UINT16, monitoredValue.getObjectType().getValue());
GXCommon.setData(settings, data, DataType.OCTET_STRING,
GXCommon.logicalNameToBytes(monitoredValue.getLogicalName()));
GXCommon.setData(settings, data, DataType.INT8, monitoredAttributeIndex);
}
return data.array();
} else if (e.getIndex() == 3) {
return thresholdActive;
} else if (e.getIndex() == 4) {
return thresholdNormal;
} else if (e.getIndex() == 5) {
return thresholdEmergency;
} else if (e.getIndex() == 6) {
return minOverThresholdDuration;
} else if (e.getIndex() == 7) {
return minUnderThresholdDuration;
} else if (e.getIndex() == 8) {
GXByteBuffer data = new GXByteBuffer();
data.setUInt8(DataType.STRUCTURE.getValue());
data.setUInt8(3);
GXCommon.setData(settings, data, DataType.UINT16, emergencyProfile.getID());
GXCommon.setData(settings, data, DataType.OCTET_STRING, emergencyProfile.getActivationTime());
GXCommon.setData(settings, data, DataType.UINT32, emergencyProfile.getDuration());
return data.array();
} else if (e.getIndex() == 9) {
GXByteBuffer data = new GXByteBuffer();
data.setUInt8((byte) DataType.ARRAY.getValue());
data.setUInt8((byte) emergencyProfileGroupIDs.length);
for (Object it : emergencyProfileGroupIDs) {
GXCommon.setData(settings, data, DataType.UINT16, it);
}
return data.array();
} else if (e.getIndex() == 10) {
return emergencyProfileActive;
} else if (e.getIndex() == 11) {
GXByteBuffer data = new GXByteBuffer();
data.setUInt8(DataType.STRUCTURE.getValue());
data.setUInt8(2);
data.setUInt8(DataType.STRUCTURE.getValue());
data.setUInt8(2);
GXCommon.setData(settings, data, DataType.OCTET_STRING,
GXCommon.logicalNameToBytes(actionOverThreshold.getLogicalName()));
GXCommon.setData(settings, data, DataType.UINT16, actionOverThreshold.getScriptSelector());
data.setUInt8(DataType.STRUCTURE.getValue());
data.setUInt8(2);
GXCommon.setData(settings, data, DataType.OCTET_STRING,
GXCommon.logicalNameToBytes(actionUnderThreshold.getLogicalName()));
GXCommon.setData(settings, data, DataType.UINT16, actionUnderThreshold.getScriptSelector());
return data.array();
}
e.setError(ErrorCode.READ_WRITE_DENIED);
return null;
}
/*
* Set value of given attribute.
*/
@Override
public final void setValue(final GXDLMSSettings settings, final ValueEventArgs e) {
if (e.getIndex() == 1) {
setLogicalName(GXCommon.toLogicalName(e.getValue()));
} else if (e.getIndex() == 2) {
ObjectType ot = ObjectType.forValue(((Number) (((List) e.getValue()).get(0))).intValue());
String ln = GXCommon.toLogicalName(((List) e.getValue()).get(1));
monitoredAttributeIndex = ((Number) (((List) e.getValue()).get(2))).intValue();
if (ot != ObjectType.NONE) {
monitoredValue = settings.getObjects().findByLN(ot, ln);
if (monitoredValue == null) {
monitoredValue = GXDLMSClient.createObject(ot);
monitoredValue.setLogicalName(ln);
}
}
} else if (e.getIndex() == 3) {
thresholdActive = e.getValue();
} else if (e.getIndex() == 4) {
thresholdNormal = e.getValue();
} else if (e.getIndex() == 5) {
thresholdEmergency = e.getValue();
} else if (e.getIndex() == 6) {
minOverThresholdDuration = ((Number) e.getValue()).longValue();
} else if (e.getIndex() == 7) {
minUnderThresholdDuration = ((Number) e.getValue()).longValue();
} else if (e.getIndex() == 8) {
List tmp = (List) e.getValue();
emergencyProfile.setID(((Number) tmp.get(0)).intValue());
emergencyProfile.setActivationTime(
(GXDateTime) GXDLMSClient.changeType((byte[]) tmp.get(1), DataType.DATETIME, e.getSettings()));
emergencyProfile.setDuration(((Number) tmp.get(2)).longValue());
} else if (e.getIndex() == 9) {
java.util.ArrayList list = new java.util.ArrayList();
if (e.getValue() != null) {
for (Object it : (List) e.getValue()) {
list.add(((Number) it).intValue());
}
}
emergencyProfileGroupIDs = GXDLMSObjectHelpers.toIntArray(list);
} else if (e.getIndex() == 10) {
emergencyProfileActive = ((Boolean) e.getValue()).booleanValue();
} else if (e.getIndex() == 11) {
List tmp = (List) e.getValue();
List tmp1 = (List) tmp.get(0);
List tmp2 = (List) tmp.get(1);
actionOverThreshold.setLogicalName(GXCommon.toLogicalName(tmp1.get(0)));
actionOverThreshold.setScriptSelector(((Number) tmp1.get(1)).intValue());
actionUnderThreshold.setLogicalName(GXCommon.toLogicalName(tmp2.get(0)));
actionUnderThreshold.setScriptSelector(((Number) tmp2.get(1)).intValue());
} else {
e.setError(ErrorCode.READ_WRITE_DENIED);
}
}
@Override
public final void load(final GXXmlReader reader) throws XMLStreamException {
if (reader.isStartElement("MonitoredValue", true)) {
ObjectType ot = ObjectType.forValue(reader.readElementContentAsInt("ObjectType"));
String ln = reader.readElementContentAsString("LN");
if (ot != ObjectType.NONE && ln != null) {
monitoredValue = reader.getObjects().findByLN(ot, ln);
// If item is not serialized yet.
if (monitoredValue == null) {
monitoredValue = GXDLMSClient.createObject(ot);
monitoredValue.setLogicalName(ln);
}
}
reader.readEndElement("MonitoredValue");
}
thresholdActive = reader.readElementContentAsObject("ThresholdActive", null, this, 3);
thresholdNormal = reader.readElementContentAsObject("ThresholdNormal", null, this, 4);
thresholdEmergency = reader.readElementContentAsObject("ThresholdEmergency", null, this, 5);
minOverThresholdDuration = reader.readElementContentAsInt("MinOverThresholdDuration");
minUnderThresholdDuration = reader.readElementContentAsInt("MinUnderThresholdDuration");
if (reader.isStartElement("EmergencyProfile", true)) {
emergencyProfile.setID(reader.readElementContentAsInt("ID"));
emergencyProfile.setActivationTime(reader.readElementContentAsDateTime("Time"));
emergencyProfile.setDuration(reader.readElementContentAsInt("Duration"));
reader.readEndElement("EmergencyProfile");
}
List list = new ArrayList();
if (reader.isStartElement("EmergencyProfileGroupIDs", true)) {
while (reader.isStartElement("Value", false)) {
list.add(reader.readElementContentAsInt("Value"));
}
reader.readEndElement("EmergencyProfileGroupIDs");
}
emergencyProfileGroupIDs = GXCommon.toIntArray(list);
emergencyProfileActive = reader.readElementContentAsInt("Active") != 0;
if (reader.isStartElement("ActionOverThreshold", true)) {
actionOverThreshold.setLogicalName(reader.readElementContentAsString("LN"));
actionOverThreshold.setScriptSelector(reader.readElementContentAsInt("ScriptSelector"));
reader.readEndElement("ActionOverThreshold");
}
if (reader.isStartElement("ActionUnderThreshold", true)) {
actionUnderThreshold.setLogicalName(reader.readElementContentAsString("LN"));
actionUnderThreshold.setScriptSelector(reader.readElementContentAsInt("ScriptSelector"));
reader.readEndElement("ActionUnderThreshold");
}
}
@Override
public final void save(final GXXmlWriter writer) throws XMLStreamException {
if (monitoredValue != null) {
writer.writeStartElement("MonitoredValue");
writer.writeElementString("ObjectType", monitoredValue.getObjectType().getValue());
writer.writeElementString("LN", monitoredValue.getLogicalName());
writer.writeEndElement();
}
writer.writeElementObject("ThresholdActive", thresholdActive, getDataType(3), getUIDataType(3));
writer.writeElementObject("ThresholdNormal", thresholdNormal, getDataType(4), getUIDataType(4));
writer.writeElementObject("ThresholdEmergency", thresholdEmergency, getDataType(5), getUIDataType(5));
writer.writeElementString("MinOverThresholdDuration", minOverThresholdDuration);
writer.writeElementString("MinUnderThresholdDuration", minUnderThresholdDuration);
if (emergencyProfile != null) {
writer.writeStartElement("EmergencyProfile");
writer.writeElementString("ID", emergencyProfile.getID());
writer.writeElementString("Time", emergencyProfile.getActivationTime());
writer.writeElementString("Duration", emergencyProfile.getDuration());
writer.writeEndElement();
}
if (emergencyProfileGroupIDs != null) {
writer.writeStartElement("EmergencyProfileGroupIDs");
for (int it : emergencyProfileGroupIDs) {
writer.writeElementString("Value", it);
}
writer.writeEndElement();
}
writer.writeElementString("Active", emergencyProfileActive);
if (actionOverThreshold != null) {
writer.writeStartElement("ActionOverThreshold");
writer.writeElementString("LN", actionOverThreshold.getLogicalName());
writer.writeElementString("ScriptSelector", actionOverThreshold.getScriptSelector());
writer.writeEndElement();
}
if (actionUnderThreshold != null) {
writer.writeStartElement("ActionUnderThreshold");
writer.writeElementString("LN", actionUnderThreshold.getLogicalName());
writer.writeElementString("ScriptSelector", actionUnderThreshold.getScriptSelector());
writer.writeEndElement();
}
}
@Override
public final void postLoad(final GXXmlReader reader) {
// Upload Monitored Value after load.
if (monitoredValue != null) {
GXDLMSObject target =
reader.getObjects().findByLN(monitoredValue.getObjectType(), monitoredValue.getLogicalName());
if (target != null && target != monitoredValue) {
monitoredValue = target;
}
}
}
@Override
public String[] getNames() {
return new String[] { "Logical Name", "Monitored Value", "Active Threshold", "Normal Threshold",
"Emergency Threshold", "Threshold Duration Min Over", "Threshold Duration Min Under",
"Emergency Profile", "Emergency Profile Group", "Emergency Profile Active", "Actions" };
}
@Override
public String[] getMethodNames() {
return new String[0];
}
}