Class BeamAntennaPattern

java.lang.Object
edu.nps.moves.dis7.pdus.BeamAntennaPattern
All Implemented Interfaces:
Serializable
public class BeamAntennaPattern extends Object implements Serializable
Used when the antenna pattern type field has a value of 1. Specifies the direction, pattern, and polarization of radiation from an antenna. Section 6.2.9.2
See Also:

  • Field Details

    • beamDirection

      protected EulerAngles beamDirection
      The rotation that transforms the reference coordinate sytem into the beam coordinate system. Either world coordinates or entity coordinates may be used as the reference coordinate system, as specified by the reference system field of the antenna pattern record.

    • azimuthBeamwidth

      protected float azimuthBeamwidth
      Full width of the beam to the -3dB power density points in the x-y plane of the beam coordinnate system. Elevation beamwidth is represented by a 32-bit floating point number in units of radians.

    • elevationBeamwidth

      protected float elevationBeamwidth
      This field shall specify the full width of the beam to the –3 dB power density points in the x-z plane of the beam coordinate system. Elevation beamwidth shall be represented by a 32-bit floating point number in units of radians.

    • referenceSystem

      protected TransmitterAntennaPatternReferenceSystem referenceSystem
      The reference coordinate system wrt which beam direction is specified. This field should not change over the duration of an exercise. World coordindate systemis prefered for exercises. The entity coordinate system should be used only when highly directional antennas must be precisely modeled. uid 168

    • padding1

      protected byte padding1
      Padding

    • padding2

      protected short padding2
      Padding

    • ez

      protected float ez
      This field shall specify the magnitude of the Z-component (in beam coordinates) of the Electrical field at some arbitrary single point in the main beam and in the far field of the antenna.

    • ex

      protected float ex
      This field shall specify the magnitude of the X-component (in beam coordinates) of the Electri- cal field at some arbitrary single point in the main beam and in the far field of the antenna.

    • phase

      protected float phase
      This field shall specify the phase angle between EZ and EX in radians. If fully omni-direc- tional antenna is modeled using beam pattern type one, the omni-directional antenna shall be repre- sented by beam direction Euler angles psi, theta, and phi of zero, an azimuth beamwidth of 2PI, and an elevation beamwidth of PI

    • padding3

      protected int padding3
      padding

  • Constructor Details

    • BeamAntennaPattern

      public BeamAntennaPattern()
      Constructor creates and configures a new instance object

  • Method Details

    • getMarshalledSize

      public int getMarshalledSize()
      Returns size of this serialized (marshalled) object in bytes
      Returns:
      serialized size in bytes
      See Also:

    • setBeamDirection

      public BeamAntennaPattern setBeamDirection(EulerAngles pBeamDirection)
      Setter for beamDirection
      Parameters:
      pBeamDirection - new value of interest
      Returns:
      same object to permit progressive setters

    • getBeamDirection

      public EulerAngles getBeamDirection()
      Getter for beamDirection
      Returns:
      value of interest

    • setAzimuthBeamwidth

      public BeamAntennaPattern setAzimuthBeamwidth(float pAzimuthBeamwidth)
      Setter for azimuthBeamwidth
      Parameters:
      pAzimuthBeamwidth - new value of interest
      Returns:
      same object to permit progressive setters

    • getAzimuthBeamwidth

      public float getAzimuthBeamwidth()
      Getter for azimuthBeamwidth
      Returns:
      value of interest

    • setElevationBeamwidth

      public BeamAntennaPattern setElevationBeamwidth(float pElevationBeamwidth)
      Setter for elevationBeamwidth
      Parameters:
      pElevationBeamwidth - new value of interest
      Returns:
      same object to permit progressive setters

    • getElevationBeamwidth

      public float getElevationBeamwidth()
      Getter for elevationBeamwidth
      Returns:
      value of interest

    • setReferenceSystem

      public BeamAntennaPattern setReferenceSystem(TransmitterAntennaPatternReferenceSystem pReferenceSystem)
      Setter for referenceSystem
      Parameters:
      pReferenceSystem - new value of interest
      Returns:
      same object to permit progressive setters

    • getReferenceSystem

      public TransmitterAntennaPatternReferenceSystem getReferenceSystem()
      Getter for referenceSystem
      Returns:
      value of interest

    • setPadding1

      public BeamAntennaPattern setPadding1(byte pPadding1)
      Setter for padding1
      Parameters:
      pPadding1 - new value of interest
      Returns:
      same object to permit progressive setters

    • setPadding1

      public BeamAntennaPattern setPadding1(int pPadding1)
      Utility setter for padding1
      Parameters:
      pPadding1 - new value of interest
      Returns:
      same object to permit progressive setters

    • getPadding1

      public byte getPadding1()
      Getter for padding1
      Returns:
      value of interest

    • setPadding2

      public BeamAntennaPattern setPadding2(short pPadding2)
      Setter for padding2
      Parameters:
      pPadding2 - new value of interest
      Returns:
      same object to permit progressive setters

    • setPadding2

      public BeamAntennaPattern setPadding2(int pPadding2)
      Utility setter for padding2
      Parameters:
      pPadding2 - new value of interest
      Returns:
      same object to permit progressive setters

    • getPadding2

      public short getPadding2()
      Getter for padding2
      Returns:
      value of interest

    • setEz

      public BeamAntennaPattern setEz(float pEz)
      Setter for ez
      Parameters:
      pEz - new value of interest
      Returns:
      same object to permit progressive setters

    • getEz

      public float getEz()
      Getter for ez
      Returns:
      value of interest

    • setEx

      public BeamAntennaPattern setEx(float pEx)
      Setter for ex
      Parameters:
      pEx - new value of interest
      Returns:
      same object to permit progressive setters

    • getEx

      public float getEx()
      Getter for ex
      Returns:
      value of interest

    • setPhase

      public BeamAntennaPattern setPhase(float pPhase)
      Setter for phase
      Parameters:
      pPhase - new value of interest
      Returns:
      same object to permit progressive setters

    • getPhase

      public float getPhase()
      Getter for phase
      Returns:
      value of interest

    • setPadding3

      public BeamAntennaPattern setPadding3(int pPadding3)
      Setter for padding3
      Parameters:
      pPadding3 - new value of interest
      Returns:
      same object to permit progressive setters

    • getPadding3

      public int getPadding3()
      Getter for padding3
      Returns:
      value of interest

    • marshal

      public void marshal(DataOutputStream dos) throws Exception
      Serializes an object to a DataOutputStream.
      Parameters:
      dos - the OutputStream
      Throws:
      Exception - if something goes wrong
      See Also:

    • unmarshal

      public int unmarshal(DataInputStream dis) throws Exception
      Deserializes an object from a DataInputStream.
      Parameters:
      dis - the InputStream
      Returns:
      marshalled serialized size in bytes
      Throws:
      Exception - if something goes wrong
      See Also:

    • marshal

      public void marshal(ByteBuffer byteBuffer) throws Exception
      Packs an object into the ByteBuffer.
      Parameters:
      byteBuffer - The ByteBuffer at the position to begin writing
      Throws:
      BufferOverflowException - if byteBuffer is too small
      ReadOnlyBufferException - if byteBuffer is read only
      Exception - ByteBuffer-generated exception
      See Also:

    • unmarshal

      public int unmarshal(ByteBuffer byteBuffer) throws Exception
      Unpacks a Pdu from the underlying data.
      Parameters:
      byteBuffer - The ByteBuffer at the position to begin reading
      Returns:
      marshalled serialized size in bytes
      Throws:
      BufferUnderflowException - if byteBuffer is too small
      Exception - ByteBuffer-generated exception
      See Also:

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsImpl

      public boolean equalsImpl(Object obj)
      Compare all fields that contribute to the state, ignoring transient and static fields, for this and the supplied object
      Parameters:
      obj - the object to compare to
      Returns:
      true if the objects are equal, false otherwise.

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object