gurux.dlms.objects.GXDLMSAutoAnswer 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.
The newest version!
//
// --------------------------------------------------------------------------
// 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.AbstractMap.SimpleEntry;
import java.util.ArrayList;
import java.util.List;
import java.util.Map.Entry;
import javax.xml.stream.XMLStreamException;
import gurux.dlms.GXByteBuffer;
import gurux.dlms.GXDLMSClient;
import gurux.dlms.GXDLMSSettings;
import gurux.dlms.GXDateTime;
import gurux.dlms.GXSimpleEntry;
import gurux.dlms.ValueEventArgs;
import gurux.dlms.enums.DataType;
import gurux.dlms.enums.ErrorCode;
import gurux.dlms.enums.ObjectType;
import gurux.dlms.internal.GXCommon;
import gurux.dlms.objects.enums.AutoAnswerMode;
import gurux.dlms.objects.enums.AutoAnswerStatus;
/**
* Online help:
* https://www.gurux.fi/Gurux.DLMS.Objects.GXDLMSAutoAnswer
*/
public class GXDLMSAutoAnswer extends GXDLMSObject implements IGXDLMSBase {
private AutoAnswerMode mode;
private List> listeningWindow;
private AutoAnswerStatus status;
private int numberOfCalls;
private int numberOfRingsInListeningWindow, numberOfRingsOutListeningWindow;
/**
* Constructor.
*/
public GXDLMSAutoAnswer() {
this("0.0.2.2.0.255", 0);
}
/**
* Constructor.
*
* @param ln
* Logical Name of the object.
*/
public GXDLMSAutoAnswer(final String ln) {
this(ln, 0);
}
/**
* Constructor.
*
* @param ln
* Logical Name of the object.
* @param sn
* Short Name of the object.
*/
public GXDLMSAutoAnswer(final String ln, final int sn) {
super(ObjectType.AUTO_ANSWER, ln, sn);
listeningWindow = new ArrayList>();
mode = AutoAnswerMode.NONE;
status = AutoAnswerStatus.INACTIVE;
}
public final AutoAnswerMode getMode() {
return mode;
}
public final void setMode(final AutoAnswerMode value) {
mode = value;
}
public final List> getListeningWindow() {
return listeningWindow;
}
public final void setListeningWindow(final List> value) {
listeningWindow = value;
}
public final AutoAnswerStatus getStatus() {
return status;
}
public final void setStatus(final AutoAnswerStatus value) {
status = value;
}
public final int getNumberOfCalls() {
return numberOfCalls;
}
public final void setNumberOfCalls(final int value) {
numberOfCalls = value;
}
/*
* Number of rings within the window defined by ListeningWindow.
*/
public final int getNumberOfRingsInListeningWindow() {
return numberOfRingsInListeningWindow;
}
public final void setNumberOfRingsInListeningWindow(final int value) {
numberOfRingsInListeningWindow = value;
}
/*
* Number of rings outside the window defined by ListeningWindow.
*/
public final int getNumberOfRingsOutListeningWindow() {
return numberOfRingsOutListeningWindow;
}
public final void setNumberOfRingsOutListeningWindow(final int value) {
numberOfRingsOutListeningWindow = value;
}
@Override
public final Object[] getValues() {
String str = String.valueOf(numberOfRingsInListeningWindow) + "/"
+ String.valueOf(numberOfRingsOutListeningWindow);
return new Object[] { getLogicalName(), getMode(), getListeningWindow(), getStatus(),
getNumberOfCalls(), str };
}
/*
* Returns collection of attributes to read. If attribute is static and
* already read or device is returned HW error it is not returned.
*/
@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);
}
// Mode is static and read only once.
if (all || !isRead(2)) {
attributes.add(2);
}
// ListeningWindow is static and read only once.
if (all || !isRead(3)) {
attributes.add(3);
}
// Status is not static.
if (all || canRead(4)) {
attributes.add(4);
}
// NumberOfCalls is static and read only once.
if (all || !isRead(5)) {
attributes.add(5);
}
// NumberOfRingsInListeningWindow is static and read only once.
if (all || !isRead(6)) {
attributes.add(6);
}
return GXDLMSObjectHelpers.toIntArray(attributes);
}
/*
* Returns amount of attributes.
*/
@Override
public final int getAttributeCount() {
return 6;
}
/*
* 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.ENUM;
}
if (index == 3) {
return DataType.ARRAY;
}
if (index == 4) {
return DataType.ENUM;
}
if (index == 5) {
return DataType.UINT8;
}
if (index == 6) {
return DataType.ARRAY;
}
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());
}
if (e.getIndex() == 2) {
return getMode().ordinal();
}
if (e.getIndex() == 3) {
int cnt = getListeningWindow().size();
GXByteBuffer buff = new GXByteBuffer();
buff.setUInt8(DataType.ARRAY.getValue());
// Add count
GXCommon.setObjectCount(cnt, buff);
if (cnt != 0) {
for (Entry it : listeningWindow) {
buff.setUInt8(DataType.STRUCTURE.getValue());
// Count
buff.setUInt8(2);
// Start time
GXCommon.setData(null, buff, DataType.OCTET_STRING, it.getKey());
// End time
GXCommon.setData(null, buff, DataType.OCTET_STRING, it.getValue());
}
}
return buff.array();
}
if (e.getIndex() == 4) {
return getStatus().getValue();
}
if (e.getIndex() == 5) {
return getNumberOfCalls();
}
if (e.getIndex() == 6) {
GXByteBuffer buff = new GXByteBuffer();
buff.setUInt8(DataType.STRUCTURE.getValue());
GXCommon.setObjectCount(2, buff);
GXCommon.setData(null, buff, DataType.UINT8, numberOfRingsInListeningWindow);
GXCommon.setData(null, buff, DataType.UINT8, numberOfRingsOutListeningWindow);
return buff.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) {
setMode(AutoAnswerMode.values()[(((Number) e.getValue()).byteValue() & 0xFF)]);
} else if (e.getIndex() == 3) {
getListeningWindow().clear();
if (e.getValue() != null) {
for (Object item : (List) e.getValue()) {
GXDateTime start =
(GXDateTime) GXDLMSClient.changeType((byte[]) ((List) item).get(0),
DataType.DATETIME, e.getSettings());
GXDateTime end =
(GXDateTime) GXDLMSClient.changeType((byte[]) ((List) item).get(1),
DataType.DATETIME, e.getSettings());
getListeningWindow().add(new GXSimpleEntry(start, end));
}
}
} else if (e.getIndex() == 4) {
setStatus(AutoAnswerStatus.forValue(((Number) e.getValue()).intValue()));
} else if (e.getIndex() == 5) {
setNumberOfCalls(((Number) e.getValue()).intValue());
} else if (e.getIndex() == 6) {
numberOfRingsInListeningWindow = 0;
numberOfRingsOutListeningWindow = 0;
if (e.getValue() != null) {
numberOfRingsInListeningWindow =
((Number) ((List) e.getValue()).get(0)).intValue();
numberOfRingsOutListeningWindow =
((Number) ((List) e.getValue()).get(1)).intValue();
}
} else {
e.setError(ErrorCode.READ_WRITE_DENIED);
}
}
@Override
public final void load(final GXXmlReader reader) throws XMLStreamException {
mode = AutoAnswerMode.values()[reader.readElementContentAsInt("Mode")];
listeningWindow.clear();
if (reader.isStartElement("ListeningWindow", true)) {
while (reader.isStartElement("Item", true)) {
GXDateTime start = reader.readElementContentAsDateTime("Start");
GXDateTime end = reader.readElementContentAsDateTime("End");
listeningWindow.add(new SimpleEntry(start, end));
}
reader.readEndElement("ListeningWindow");
}
status = AutoAnswerStatus.values()[reader.readElementContentAsInt("Status")];
numberOfCalls = reader.readElementContentAsInt("NumberOfCalls");
numberOfRingsInListeningWindow =
reader.readElementContentAsInt("NumberOfRingsInListeningWindow");
numberOfRingsOutListeningWindow =
reader.readElementContentAsInt("NumberOfRingsOutListeningWindow");
}
@Override
public final void save(final GXXmlWriter writer) throws XMLStreamException {
if (mode != null) {
writer.writeElementString("Mode", mode.ordinal());
}
if (listeningWindow != null) {
writer.writeStartElement("ListeningWindow");
for (Entry it : listeningWindow) {
writer.writeStartElement("Item");
writer.writeElementString("Start", it.getKey());
writer.writeElementString("End", it.getValue());
writer.writeEndElement();
}
writer.writeEndElement();
}
if (status != null) {
writer.writeElementString("Status", status.getValue());
}
writer.writeElementString("NumberOfCalls", numberOfCalls);
writer.writeElementString("NumberOfRingsInListeningWindow", numberOfRingsInListeningWindow);
writer.writeElementString("NumberOfRingsOutListeningWindow",
numberOfRingsOutListeningWindow);
}
@Override
public final void postLoad(final GXXmlReader reader) {
// Not needed for this object.
}
@Override
public String[] getNames() {
return new String[] { "Logical Name", "Mode", "Listening Window", "Status",
"Number Of Calls", "Number Of Rings In Listening Window" };
}
@Override
public String[] getMethodNames() {
return new String[0];
}
}