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

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

import java.io.*;

/**
 * Contains electromagnetic emmission regeneration parameters that are variable
 * throught a scenario. Section 6.2.22.
 *
 * 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 EEFundamentalParameterData extends Object implements Serializable {

    /**
     * center frequency of the emission in hertz.
     */
    protected float frequency;

    /**
     * Bandwidth of the frequencies corresponding to the fequency field.
     */
    protected float frequencyRange;

    /**
     * Effective radiated power for the emission in DdBm. For a radar noise
     * jammer, indicates the peak of the transmitted power.
     */
    protected float effectiveRadiatedPower;

    /**
     * Average repetition frequency of the emission in hertz.
     */
    protected float pulseRepetitionFrequency;

    /**
     * Average pulse width of the emission in microseconds.
     */
    protected float pulseWidth;

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

    public int getMarshalledSize() {
        int marshalSize = 0;

        marshalSize = marshalSize + 4;  // frequency
        marshalSize = marshalSize + 4;  // frequencyRange
        marshalSize = marshalSize + 4;  // effectiveRadiatedPower
        marshalSize = marshalSize + 4;  // pulseRepetitionFrequency
        marshalSize = marshalSize + 4;  // pulseWidth

        return marshalSize;
    }

    public void setFrequency(float pFrequency) {
        frequency = pFrequency;
    }

    public float getFrequency() {
        return frequency;
    }

    public void setFrequencyRange(float pFrequencyRange) {
        frequencyRange = pFrequencyRange;
    }

    public float getFrequencyRange() {
        return frequencyRange;
    }

    public void setEffectiveRadiatedPower(float pEffectiveRadiatedPower) {
        effectiveRadiatedPower = pEffectiveRadiatedPower;
    }

    public float getEffectiveRadiatedPower() {
        return effectiveRadiatedPower;
    }

    public void setPulseRepetitionFrequency(float pPulseRepetitionFrequency) {
        pulseRepetitionFrequency = pPulseRepetitionFrequency;
    }

    public float getPulseRepetitionFrequency() {
        return pulseRepetitionFrequency;
    }

    public void setPulseWidth(float pPulseWidth) {
        pulseWidth = pPulseWidth;
    }

    public float getPulseWidth() {
        return pulseWidth;
    }

    public void marshal(DataOutputStream dos) {
        try {
            dos.writeFloat((float) frequency);
            dos.writeFloat((float) frequencyRange);
            dos.writeFloat((float) effectiveRadiatedPower);
            dos.writeFloat((float) pulseRepetitionFrequency);
            dos.writeFloat((float) pulseWidth);
        } // end try 
        catch (Exception e) {
            System.out.println(e);
        }
    } // end of marshal method

    public void unmarshal(DataInputStream dis) {
        try {
            frequency = dis.readFloat();
            frequencyRange = dis.readFloat();
            effectiveRadiatedPower = dis.readFloat();
            pulseRepetitionFrequency = dis.readFloat();
            pulseWidth = dis.readFloat();
        } // 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.putFloat((float) frequency);
        buff.putFloat((float) frequencyRange);
        buff.putFloat((float) effectiveRadiatedPower);
        buff.putFloat((float) pulseRepetitionFrequency);
        buff.putFloat((float) pulseWidth);
    } // 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) {
        frequency = buff.getFloat();
        frequencyRange = buff.getFloat();
        effectiveRadiatedPower = buff.getFloat();
        pulseRepetitionFrequency = buff.getFloat();
        pulseWidth = buff.getFloat();
    } // 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 EEFundamentalParameterData)) {
            return false;
        }

        final EEFundamentalParameterData rhs = (EEFundamentalParameterData) obj;

        if (!(frequency == rhs.frequency)) {
            ivarsEqual = false;
        }
        if (!(frequencyRange == rhs.frequencyRange)) {
            ivarsEqual = false;
        }
        if (!(effectiveRadiatedPower == rhs.effectiveRadiatedPower)) {
            ivarsEqual = false;
        }
        if (!(pulseRepetitionFrequency == rhs.pulseRepetitionFrequency)) {
            ivarsEqual = false;
        }
        if (!(pulseWidth == rhs.pulseWidth)) {
            ivarsEqual = false;
        }

        return ivarsEqual;
    }
} // end of class