gurux.dlms.GXDLMSTranslatorMessage 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;

import gurux.dlms.enums.InterfaceType;
import gurux.dlms.enums.RequestTypes;

/**
 * XML translator message detailed data.
 */
public class GXDLMSTranslatorMessage {
    /**
     * Message to convert to XML.
     */
    private GXByteBuffer message;

    /**
     * Converted XML.
     */
    private String xml;
    /**
     * Executed Command.
     */
    private int command;
    /**
     * System title from AARQ or AARE messages.
     */
    private byte[] systemTitle;

    /**
     * Dedicated key from AARQ messages.
     */
    private byte[] dedicatedKey;
    /**
     * Interface type.
     */
    private InterfaceType interfaceType;

    /**
     * Source address.
     */
    private int sourceAddress;
    /**
     * Target address.
     */
    private int targetAddress;
    /**
     * Is more data available. Return None if more data is not available or
     * Frame or Block type.
     */
    private java.util.Set moreData;
    /**
     * Occurred exception.
     */
    private RuntimeException exception;

    public final GXByteBuffer getMessage() {
        return message;
    }

    public final void setMessage(GXByteBuffer value) {
        message = value;
    }

    /**
     * @return Converted XML.
     */
    public final String getXml() {
        return xml;
    }

    /**
     * @param value
     *            Converted XML.
     */
    public final void setXml(String value) {
        xml = value;
    }

    /**
     * @return Executed Command.
     */
    public final int getCommand() {
        return command;
    }

    /**
     * @param value
     *            Executed Command.
     */
    public final void setCommand(int value) {
        command = value;
    }

    /**
     * @return System title from AARQ or AARE messages.
     */
    public final byte[] getSystemTitle() {
        return systemTitle;
    }

    /**
     * @param value
     *            System title from AARQ or AARE messages.
     */
    public final void setSystemTitle(byte[] value) {
        systemTitle = value;
    }

    /**
     * @return Dedicated key from AARQ messages.
     */
    public final byte[] getDedicatedKey() {
        return dedicatedKey;
    }

    /**
     * @param value
     *            Dedicated key from AARQ messages.
     */
    public final void setDedicatedKey(byte[] value) {
        dedicatedKey = value;
    }

    /**
     * @return Interface type.
     */
    public final InterfaceType getInterfaceType() {
        return interfaceType;
    }

    /**
     * @param value
     *            Interface type.
     */
    public final void setInterfaceType(final InterfaceType value) {
        interfaceType = value;
    }

    /**
     * @return Source address.
     */
    public final int getSourceAddress() {
        return sourceAddress;
    }

    /**
     * @param value
     *            Source address.
     */
    public final void setSourceAddress(final int value) {
        sourceAddress = value;
    }

    /**
     * @return Target address.
     */
    public final int getTargetAddress() {
        return targetAddress;
    }

    /**
     * @param value
     *            Target address.
     */
    public final void setTargetAddress(final int value) {
        targetAddress = value;
    }

    /**
     * @return Is more data available. Return None if more data is not available
     *         or Frame or Block type.
     */
    public final java.util.Set getMoreData() {
        return moreData;
    }

    /**
     * @param value
     *            Is more data available. Return None if more data is not
     *            available or Frame or Block type.
     */
    public final void setMoreData(final java.util.Set value) {
        moreData = value;
    }

    /**
     * @return Occurred exception.
     */
    public final RuntimeException getException() {
        return exception;
    }

    /**
     * @param value
     *            Occurred exception.
     */
    public final void setException(final RuntimeException value) {
        exception = value;
    }

}