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

import gurux.dlms.enums.ErrorCode;
import gurux.dlms.objects.GXDLMSObject;

/**
 * Access item is used to generate Access Service message.
 */
public class GXDLMSAccessItem {
    /**
     * COSEM target object.
     */
    private GXDLMSObject target;
    /**
     * Executed command type.
     */
    private int command;

    /**
     * Attribute index.
     */
    private int index;

    /**
     * Reply error code.
     */
    private ErrorCode error;

    /*
     * Reply value.
     */
    private Object value;

    /**
     * @return COSEM target object.
     */
    public final GXDLMSObject getTarget() {
        return target;
    }

    /**
     * @param value
     *            COSEM target object.
     */
    public final void setTarget(final GXDLMSObject value) {
        target = value;
    }

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

    /**
     * @return Attribute index.
     */
    public final int getIndex() {
        return index;
    }

    /**
     * @param value
     *            Attribute index.
     */
    public final void setIndex(final int value) {
        index = value;
    }

    /**
     * Constructor.
     */
    public GXDLMSAccessItem() {
    }

    /**
     * Constructor.
     * 
     * @param commandType
     *            Command to execute.
     * @param targetObject
     *            COSEM target object.
     * @param attributeIndex
     *            Attribute index.
     */
    public GXDLMSAccessItem(final int commandType,
            final GXDLMSObject targetObject, final int attributeIndex) {
        command = commandType;
        target = targetObject;
        index = attributeIndex;
    }

    /**
     * @return Reply error code.
     */
    public ErrorCode getError() {
        return error;
    }

    /**
     * @param error
     *            Reply error code.
     */
    public void setError(final ErrorCode error) {
        this.error = error;
    }

    /**
     * @return Reply value.
     */
    public Object getValue() {
        return value;
    }

    /**
     * @param val
     *            Reply value
     */
    public void setValue(final Object val) {
        value = val;
    }
}