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

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

import java.util.*;
import java.io.*;

/**
 * Section 5.3.9.3 Information initiating the dyanic allocation and control of
 * simulation entities between two simulation applications. Requires manual
 * cleanup. The padding between record sets is variable. UNFINISHED
 *
 * 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 TransferControlRequestPdu extends EntityManagementFamilyPdu implements Serializable {

    /**
     * ID of entity originating request
     */
    protected EntityID orginatingEntityID = new EntityID();

    /**
     * ID of entity receiving request
     */
    protected EntityID recevingEntityID = new EntityID();

    /**
     * ID ofrequest
     */
    protected long requestID;

    /**
     * required level of reliabliity service.
     */
    protected short requiredReliabilityService;

    /**
     * type of transfer desired
     */
    protected short tranferType;

    /**
     * The entity for which control is being requested to transfer
     */
    protected EntityID transferEntityID = new EntityID();

    /**
     * number of record sets to transfer
     */
    protected short numberOfRecordSets;

    /**
     * ^^^This is wrong--the RecordSet class needs more work
     */
    protected List< RecordSet> recordSets = new ArrayList< RecordSet>();

    /**
     * Constructor
     */
    public TransferControlRequestPdu() {
        setPduType((short) 35);
    }

    public int getMarshalledSize() {
        int marshalSize = 0;

        marshalSize = super.getMarshalledSize();
        marshalSize = marshalSize + orginatingEntityID.getMarshalledSize();  // orginatingEntityID
        marshalSize = marshalSize + recevingEntityID.getMarshalledSize();  // recevingEntityID
        marshalSize = marshalSize + 4;  // requestID
        marshalSize = marshalSize + 1;  // requiredReliabilityService
        marshalSize = marshalSize + 1;  // tranferType
        marshalSize = marshalSize + transferEntityID.getMarshalledSize();  // transferEntityID
        marshalSize = marshalSize + 1;  // numberOfRecordSets
        for (int idx = 0; idx < recordSets.size(); idx++) {
            RecordSet listElement = recordSets.get(idx);
            marshalSize = marshalSize + listElement.getMarshalledSize();
        }

        return marshalSize;
    }

    public void setOrginatingEntityID(EntityID pOrginatingEntityID) {
        orginatingEntityID = pOrginatingEntityID;
    }

    public EntityID getOrginatingEntityID() {
        return orginatingEntityID;
    }

    public void setRecevingEntityID(EntityID pRecevingEntityID) {
        recevingEntityID = pRecevingEntityID;
    }

    public EntityID getRecevingEntityID() {
        return recevingEntityID;
    }

    public void setRequestID(long pRequestID) {
        requestID = pRequestID;
    }

    public long getRequestID() {
        return requestID;
    }

    public void setRequiredReliabilityService(short pRequiredReliabilityService) {
        requiredReliabilityService = pRequiredReliabilityService;
    }

    public short getRequiredReliabilityService() {
        return requiredReliabilityService;
    }

    public void setTranferType(short pTranferType) {
        tranferType = pTranferType;
    }

    public short getTranferType() {
        return tranferType;
    }

    public void setTransferEntityID(EntityID pTransferEntityID) {
        transferEntityID = pTransferEntityID;
    }

    public EntityID getTransferEntityID() {
        return transferEntityID;
    }

    public short getNumberOfRecordSets() {
        return (short) recordSets.size();
    }

    /**
     * Note that setting this value will not change the marshalled value. The
     * list whose length this describes is used for that purpose. The
     * getnumberOfRecordSets method will also be based on the actual list length
     * rather than this value. The method is simply here for java bean
     * completeness.
     */
    public void setNumberOfRecordSets(short pNumberOfRecordSets) {
        numberOfRecordSets = pNumberOfRecordSets;
    }

    public void setRecordSets(List pRecordSets) {
        recordSets = pRecordSets;
    }

    public List getRecordSets() {
        return recordSets;
    }

    /**
     * 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);
        orginatingEntityID.marshal(buff);
        recevingEntityID.marshal(buff);
        buff.putInt((int) requestID);
        buff.put((byte) requiredReliabilityService);
        buff.put((byte) tranferType);
        transferEntityID.marshal(buff);
        buff.put((byte) recordSets.size());

        for (int idx = 0; idx < recordSets.size(); idx++) {
            RecordSet aRecordSet = (RecordSet) recordSets.get(idx);
            aRecordSet.marshal(buff);
        } // end of list marshalling

    } // 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);

        orginatingEntityID.unmarshal(buff);
        recevingEntityID.unmarshal(buff);
        requestID = buff.getInt();
        requiredReliabilityService = (short) (buff.get() & 0xFF);
        tranferType = (short) (buff.get() & 0xFF);
        transferEntityID.unmarshal(buff);
        numberOfRecordSets = (short) (buff.get() & 0xFF);
        for (int idx = 0; idx < numberOfRecordSets; idx++) {
            RecordSet anX = new RecordSet();
            anX.unmarshal(buff);
            recordSets.add(anX);
        }

    } // 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 TransferControlRequestPdu)) {
            return false;
        }

        final TransferControlRequestPdu rhs = (TransferControlRequestPdu) obj;

        if (!(orginatingEntityID.equals(rhs.orginatingEntityID))) {
            ivarsEqual = false;
        }
        if (!(recevingEntityID.equals(rhs.recevingEntityID))) {
            ivarsEqual = false;
        }
        if (!(requestID == rhs.requestID)) {
            ivarsEqual = false;
        }
        if (!(requiredReliabilityService == rhs.requiredReliabilityService)) {
            ivarsEqual = false;
        }
        if (!(tranferType == rhs.tranferType)) {
            ivarsEqual = false;
        }
        if (!(transferEntityID.equals(rhs.transferEntityID))) {
            ivarsEqual = false;
        }
        if (!(numberOfRecordSets == rhs.numberOfRecordSets)) {
            ivarsEqual = false;
        }

        for (int idx = 0; idx < recordSets.size(); idx++) {
            if (!(recordSets.get(idx).equals(rhs.recordSets.get(idx)))) {
                ivarsEqual = false;
            }
        }

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