Package edu.nps.moves.dis7
Class BeamAntennaPattern
java.lang.Object
edu.nps.moves.dis7.BeamAntennaPattern
- All Implemented Interfaces:
java.io.Serializable
public class BeamAntennaPattern
extends java.lang.Object
implements java.io.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
IEEE Std 1278.1-2012, IEEE Standard for Distributed Interactive Simulation—Application Protocols
- See Also:
- Serialized Form
-
Field Summary
Fields Modifier and Type Field Description protected float
azimuthBeamwidth
protected EulerAngles
beamDirection
The rotation that transforms the reference coordinate sytem into the beam coordinate system.protected float
elevationBeamwidth
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.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.protected byte
padding1
protected short
padding2
protected int
padding3
paddingprotected float
phase
This field shall specify the phase angle between EZ and EX in radians.protected TransmitterAntennaPatternReferenceSystem
referenceSystem
uid 168 -
Constructor Summary
Constructors Constructor Description BeamAntennaPattern()
Constructor -
Method Summary
Modifier and Type Method Description boolean
equals(java.lang.Object obj)
boolean
equalsImpl(java.lang.Object obj)
Compare all fields that contribute to the state, ignoring transient and static fields, forthis
and the supplied objectfloat
getAzimuthBeamwidth()
Getter forazimuthBeamwidth
EulerAngles
getBeamDirection()
Getter forbeamDirection
float
getElevationBeamwidth()
Getter forelevationBeamwidth
float
getEx()
Getter forex
float
getEz()
Getter forez
int
getMarshalledSize()
Returns the size of this serialized object in bytesbyte
getPadding1()
Getter forpadding1
short
getPadding2()
Getter forpadding2
int
getPadding3()
Getter forpadding3
float
getPhase()
Getter forphase
TransmitterAntennaPatternReferenceSystem
getReferenceSystem()
Getter forreferenceSystem
void
marshal(java.io.DataOutputStream dos)
Serializes an object to a DataOutputStream.void
marshal(java.nio.ByteBuffer buff)
Packs an object into the ByteBuffer.BeamAntennaPattern
setAzimuthBeamwidth(float pAzimuthBeamwidth)
Setter forazimuthBeamwidth
BeamAntennaPattern
setBeamDirection(EulerAngles pBeamDirection)
Setter forbeamDirection
BeamAntennaPattern
setElevationBeamwidth(float pElevationBeamwidth)
Setter forelevationBeamwidth
BeamAntennaPattern
setEx(float pEx)
Setter forex
BeamAntennaPattern
setEz(float pEz)
Setter forez
BeamAntennaPattern
setPadding1(byte pPadding1)
Setter forpadding1
BeamAntennaPattern
setPadding2(short pPadding2)
Setter forpadding2
BeamAntennaPattern
setPadding3(int pPadding3)
Setter forpadding3
BeamAntennaPattern
setPhase(float pPhase)
Setter forphase
BeamAntennaPattern
setReferenceSystem(TransmitterAntennaPatternReferenceSystem pReferenceSystem)
Setter forreferenceSystem
java.lang.String
toString()
int
unmarshal(java.io.DataInputStream dis)
Unserializes an object from a DataInputStream.int
unmarshal(java.nio.ByteBuffer buff)
Unpacks a Pdu from the underlying data.
-
Field Details
-
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 -
elevationBeamwidth
protected float elevationBeamwidth -
referenceSystem
uid 168 -
padding1
protected byte padding1 -
padding2
protected short padding2 -
ez
protected float ezThis 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 exThis 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 phaseThis 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 padding3padding
-
-
Constructor Details
-
BeamAntennaPattern
public BeamAntennaPattern()Constructor
-
-
Method Details
-
getMarshalledSize
public int getMarshalledSize()Returns the size of this serialized object in bytes -
setBeamDirection
Setter forbeamDirection
-
getBeamDirection
Getter forbeamDirection
-
setAzimuthBeamwidth
Setter forazimuthBeamwidth
-
getAzimuthBeamwidth
public float getAzimuthBeamwidth()Getter forazimuthBeamwidth
-
setElevationBeamwidth
Setter forelevationBeamwidth
-
getElevationBeamwidth
public float getElevationBeamwidth()Getter forelevationBeamwidth
-
setReferenceSystem
public BeamAntennaPattern setReferenceSystem(TransmitterAntennaPatternReferenceSystem pReferenceSystem)Setter forreferenceSystem
-
getReferenceSystem
Getter forreferenceSystem
-
setPadding1
Setter forpadding1
-
getPadding1
public byte getPadding1()Getter forpadding1
-
setPadding2
Setter forpadding2
-
getPadding2
public short getPadding2()Getter forpadding2
-
setEz
Setter forez
-
getEz
public float getEz()Getter forez
-
setEx
Setter forex
-
getEx
public float getEx()Getter forex
-
setPhase
Setter forphase
-
getPhase
public float getPhase()Getter forphase
-
setPadding3
Setter forpadding3
-
getPadding3
public int getPadding3()Getter forpadding3
-
marshal
public void marshal(java.io.DataOutputStream dos) throws java.lang.ExceptionSerializes an object to a DataOutputStream.- Parameters:
dos
- the OutputStream- Throws:
java.lang.Exception
- if something goes wrong- See Also:
DataOutputStream
-
unmarshal
public int unmarshal(java.io.DataInputStream dis) throws java.lang.ExceptionUnserializes an object from a DataInputStream.- Parameters:
dis
- the InputStream- Returns:
- unmarshalled size
- Throws:
java.lang.Exception
- if something goes wrong- See Also:
DataInputStream
-
marshal
public void marshal(java.nio.ByteBuffer buff) throws java.lang.ExceptionPacks an object into the ByteBuffer.- Parameters:
buff
- The ByteBuffer at the position to begin writing- Throws:
java.nio.BufferOverflowException
- if buff is too smalljava.nio.ReadOnlyBufferException
- if buff is read onlyjava.lang.Exception
- ByteBuffer-generated exception- See Also:
ByteBuffer
-
unmarshal
public int unmarshal(java.nio.ByteBuffer buff) throws java.lang.ExceptionUnpacks a Pdu from the underlying data.- Parameters:
buff
- The ByteBuffer at the position to begin reading- Returns:
- marshalled size
- Throws:
java.nio.BufferUnderflowException
- if buff is too smalljava.lang.Exception
- ByteBuffer-generated exception- See Also:
ByteBuffer
-
equals
public boolean equals(java.lang.Object obj)- Overrides:
equals
in classjava.lang.Object
-
equalsImpl
public boolean equalsImpl(java.lang.Object obj)Compare all fields that contribute to the state, ignoring transient and static fields, forthis
and the supplied object- Parameters:
obj
- the object to compare to- Returns:
- true if the objects are equal, false otherwise.
-
toString
public java.lang.String toString()- Overrides:
toString
in classjava.lang.Object
-