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

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

import java.io.*;

/**
 * Section 5.3.4. abstract superclass for fire and detonation pdus that have
 * shared information. COMPLETE
 *
 * 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 WarfareFamilyPdu extends Pdu implements Serializable {

    /**
     * ID of the entity that shot
     */
    protected EntityID firingEntityID = new EntityID();

    /**
     * ID of the entity that is being shot at
     */
    protected EntityID targetEntityID = new EntityID();

    /**
     * Constructor
     */
    public WarfareFamilyPdu() {
        setProtocolFamily((short) 2);
    }

    public int getMarshalledSize() {
        int marshalSize = 0;

        marshalSize = super.getMarshalledSize();
        marshalSize = marshalSize + firingEntityID.getMarshalledSize();  // firingEntityID
        marshalSize = marshalSize + targetEntityID.getMarshalledSize();  // targetEntityID

        return marshalSize;
    }

    public void setFiringEntityID(EntityID pFiringEntityID) {
        firingEntityID = pFiringEntityID;
    }

    public EntityID getFiringEntityID() {
        return firingEntityID;
    }

    public void setTargetEntityID(EntityID pTargetEntityID) {
        targetEntityID = pTargetEntityID;
    }

    public EntityID getTargetEntityID() {
        return targetEntityID;
    }

    /**
     * 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) {
        super.marshal(buff);
        firingEntityID.marshal(buff);
        targetEntityID.marshal(buff);
    } // 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) {
        super.unmarshal(buff);

        firingEntityID.unmarshal(buff);
        targetEntityID.unmarshal(buff);
    } // 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);
    }

    @Override
    public boolean equalsImpl(Object obj) {
        boolean ivarsEqual = true;

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

        final WarfareFamilyPdu rhs = (WarfareFamilyPdu) obj;

        if (!(firingEntityID.equals(rhs.firingEntityID))) {
            ivarsEqual = false;
        }
        if (!(targetEntityID.equals(rhs.targetEntityID))) {
            ivarsEqual = false;
        }

        return ivarsEqual && super.equalsImpl(rhs);
    }
} // end of class