edu.nps.moves.dis7.LayerHeader Maven / Gradle / Ivy

Go to download
package edu.nps.moves.dis7;

import java.io.*;

/**
 * The identification of the additional information layer number, layer-specific
 * information, and the length of the layer. Section 6.2.51
 *
 * Copyright (c) 2008-2016, MOVES Institute, Naval Postgraduate School. All
 * rights reserved. This work is licensed under the BSD open source license,
 * available at https://www.movesinstitute.org/licenses/bsd.html
 *
 * @author DMcG
 */
public class LayerHeader extends Object implements Serializable {

    protected short layerNumber;

    /**
     * field shall specify layer-specific information that varies by System Type
     * (see 6.2.86) and Layer Number.
     */
    protected short layerSpecificInformation;

    /**
     * This field shall specify the length in octets of the layer, including the
     * Layer Header record
     */
    protected int length;

    /**
     * Constructor
     */
    public LayerHeader() {
    }

    public int getMarshalledSize() {
        int marshalSize = 0;

        marshalSize = marshalSize + 1;  // layerNumber
        marshalSize = marshalSize + 1;  // layerSpecificInformation
        marshalSize = marshalSize + 2;  // length

        return marshalSize;
    }

    public void setLayerNumber(short pLayerNumber) {
        layerNumber = pLayerNumber;
    }

    public short getLayerNumber() {
        return layerNumber;
    }

    public void setLayerSpecificInformation(short pLayerSpecificInformation) {
        layerSpecificInformation = pLayerSpecificInformation;
    }

    public short getLayerSpecificInformation() {
        return layerSpecificInformation;
    }

    public void setLength(int pLength) {
        length = pLength;
    }

    public int getLength() {
        return length;
    }

    public void marshal(DataOutputStream dos) {
        try {
            dos.writeByte((byte) layerNumber);
            dos.writeByte((byte) layerSpecificInformation);
            dos.writeShort((short) length);
        } // end try 
        catch (Exception e) {
            System.out.println(e);
        }
    } // end of marshal method

    public void unmarshal(DataInputStream dis) {
        try {
            layerNumber = (short) dis.readUnsignedByte();
            layerSpecificInformation = (short) dis.readUnsignedByte();
            length = (int) dis.readUnsignedShort();
        } // end try 
        catch (Exception e) {
            System.out.println(e);
        }
    } // end of unmarshal method 

    /**
     * Packs a Pdu into the ByteBuffer.
     *
     * @throws java.nio.BufferOverflowException if buff is too small
     * @throws java.nio.ReadOnlyBufferException if buff is read only
     * @see java.nio.ByteBuffer
     * @param buff The ByteBuffer at the position to begin writing
     * @since ??
     */
    public void marshal(java.nio.ByteBuffer buff) {
        buff.put((byte) layerNumber);
        buff.put((byte) layerSpecificInformation);
        buff.putShort((short) length);
    } // end of marshal method

    /**
     * Unpacks a Pdu from the underlying data.
     *
     * @throws java.nio.BufferUnderflowException if buff is too small
     * @see java.nio.ByteBuffer
     * @param buff The ByteBuffer at the position to begin reading
     * @since ??
     */
    public void unmarshal(java.nio.ByteBuffer buff) {
        layerNumber = (short) (buff.get() & 0xFF);
        layerSpecificInformation = (short) (buff.get() & 0xFF);
        length = (int) (buff.getShort() & 0xFFFF);
    } // end of unmarshal method 


    /*
  * The equals method doesn't always work--mostly it works only on classes that consist only of primitives. Be careful.
     */
    @Override
    public boolean equals(Object obj) {

        if (this == obj) {
            return true;
        }

        if (obj == null) {
            return false;
        }

        if (getClass() != obj.getClass()) {
            return false;
        }

        return equalsImpl(obj);
    }

    /**
     * Compare all fields that contribute to the state, ignoring transient and
     * static fields, for this and the supplied object
     *
     * @param obj the object to compare to
     * @return true if the objects are equal, false otherwise.
     */
    public boolean equalsImpl(Object obj) {
        boolean ivarsEqual = true;

        if (!(obj instanceof LayerHeader)) {
            return false;
        }

        final LayerHeader rhs = (LayerHeader) obj;

        if (!(layerNumber == rhs.layerNumber)) {
            ivarsEqual = false;
        }
        if (!(layerSpecificInformation == rhs.layerSpecificInformation)) {
            ivarsEqual = false;
        }
        if (!(length == rhs.length)) {
            ivarsEqual = false;
        }

        return ivarsEqual;
    }
} // end of class