edu.nps.moves.dis.AcousticEmitter Maven / Gradle / Ivy

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

import java.io.*;

/**
 * Section 5.2.35. information about a specific UA emmtter
 *
 * 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 AcousticEmitter extends Object implements Serializable {

    /**
     * the system for a particular UA emitter, and an enumeration
     */
    protected int acousticName;

    /**
     * The function of the acoustic system
     */
    protected short function;

    /**
     * The UA emitter identification number relative to a specific system
     */
    protected short acousticIdNumber;

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

    public int getMarshalledSize() {
        int marshalSize = 0;

        marshalSize = marshalSize + 2;  // acousticName
        marshalSize = marshalSize + 1;  // function
        marshalSize = marshalSize + 1;  // acousticIdNumber

        return marshalSize;
    }

    public void setAcousticName(int pAcousticName) {
        acousticName = pAcousticName;
    }

    public int getAcousticName() {
        return acousticName;
    }

    public void setFunction(short pFunction) {
        function = pFunction;
    }

    public short getFunction() {
        return function;
    }

    public void setAcousticIdNumber(short pAcousticIdNumber) {
        acousticIdNumber = pAcousticIdNumber;
    }

    public short getAcousticIdNumber() {
        return acousticIdNumber;
    }

    /**
     * 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.putShort((short) acousticName);
        buff.put((byte) function);
        buff.put((byte) acousticIdNumber);
    } // 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) {
        acousticName = (int) (buff.getShort() & 0xFFFF);
        function = (short) (buff.get() & 0xFF);
        acousticIdNumber = (short) (buff.get() & 0xFF);
    } // 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 AcousticEmitter)) {
            return false;
        }

        final AcousticEmitter rhs = (AcousticEmitter) obj;

        if (!(acousticName == rhs.acousticName)) {
            ivarsEqual = false;
        }
        if (!(function == rhs.function)) {
            ivarsEqual = false;
        }
        if (!(acousticIdNumber == rhs.acousticIdNumber)) {
            ivarsEqual = false;
        }

        return ivarsEqual;
    }
} // end of class