gurux.dlms.objects.GXDLMSData 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
gurux.dlms.java package is used to communicate with DLMS devices.
There is a newer version: 4.0.72
//
// --------------------------------------------------------------------------
//  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 javax.xml.stream.XMLStreamException;

import gurux.dlms.GXDLMSConverter;
import gurux.dlms.GXDLMSSettings;
import gurux.dlms.GXDateTime;
import gurux.dlms.GXUInt32;
import gurux.dlms.GXUInt64;
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.GXDLMSData
 */
public class GXDLMSData extends GXDLMSObject implements IGXDLMSBase {
	/**
	 * Value of data object.

	 * Online help:

	 * https://www.gurux.fi/Gurux.DLMS.Objects.GXDLMSData
	 */
	private Object value;

	/**
	 * Constructor.
	 */
	public GXDLMSData() {
		this(null, 0);
	}

	/**
	 * Constructor.
	 * 
	 * @param ln Logical Name of the object.
	 */
	public GXDLMSData(final String ln) {
		this(ln, 0);
	}

	/**
	 * Constructor.
	 * 
	 * @param ln Logical Name of the object.
	 * @param sn Short Name of the object.
	 */
	public GXDLMSData(final String ln, final int sn) {
		super(ObjectType.DATA, ln, sn);
	}

	/**
	 * Online help:

	 * https://www.gurux.fi/Gurux.DLMS.Objects.GXDLMSData
	 * 
	 * @return Value of data object.
	 */
	public final Object getValue() {
		return value;
	}

	/**
	 * Online help:

	 * https://www.gurux.fi/Gurux.DLMS.Objects.GXDLMSData
	 * 
	 * @param forValue Value of data object.
	 */
	public final void setValue(final Object forValue) {
		value = forValue;
	}

	@Override
	public final Object[] getValues() {
		return new Object[] { getLogicalName(), getValue() };
	}

	/*
	 * 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);
		}
		// Value
		if (all || canRead(2)) {
			attributes.add(2);
		}
		return GXDLMSObjectHelpers.toIntArray(attributes);
	}

	/*
	 * Returns amount of attributes.
	 */
	@Override
	public final int getAttributeCount() {
		return 2;
	}

	/*
	 * 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 super.getDataType(index);
		}
		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 getValue();
		}
		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) {
			DataType dt = getDataType(2);
			if (e.getValue() != null && (dt == DataType.NONE || dt == DataType.DATETIME || dt == DataType.STRING)) {
				DataType dt2 = GXDLMSConverter.getDLMSDataType(e.getValue());
				if (dt != dt2) {
					setDataType(2, dt2);
				}
			}
			dt = getUIDataType(2);
			if (dt == DataType.DATETIME && (e.getValue() instanceof GXUInt32 || e.getValue() instanceof GXUInt64
					|| e.getValue() instanceof Integer || e.getValue() instanceof Long)) {
				setValue(GXDateTime.fromUnixTime(((Number) e.getValue()).longValue()));
			} else {
				setValue(e.getValue());
			}
		} else {
			e.setError(ErrorCode.READ_WRITE_DENIED);
		}
	}

	@Override
	public final void load(final GXXmlReader reader) throws XMLStreamException {
		value = reader.readElementContentAsObject("Value", null, this, 2);
	}

	@Override
	public final void save(final GXXmlWriter writer) throws XMLStreamException {
		DataType dt = getDataType(2);
		if (value != null && dt == DataType.NONE) {
			dt = GXDLMSConverter.getDLMSDataType(value);
		}
		writer.writeElementObject("Value", value, dt, getUIDataType(2));
	}

	@Override
	public final void postLoad(final GXXmlReader reader) {
	}

	@Override
	public String[] getNames() {
		return new String[] { "Logical Name", "Value" };
	}

	@Override
	public String[] getMethodNames() {
		return new String[0];
	}
}