Package edu.nps.moves.dis7.pdus
Class BeamAntennaPattern
java.lang.Object
edu.nps.moves.dis7.pdus.BeamAntennaPattern
- All Implemented Interfaces:
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 Summary
FieldsModifier and TypeFieldDescriptionprotected floatFull width of the beam to the -3dB power density points in the x-y plane of the beam coordinnate system.protected EulerAnglesThe rotation that transforms the reference coordinate sytem into the beam coordinate system.protected floatThis 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.protected floatThis 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 floatThis 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 bytePaddingprotected shortPaddingprotected intpaddingprotected floatThis field shall specify the phase angle between EZ and EX in radians.protected TransmitterAntennaPatternReferenceSystemThe reference coordinate system wrt which beam direction is specified. -
Constructor Summary
ConstructorsConstructorDescriptionConstructor creates and configures a new instance object -
Method Summary
Modifier and TypeMethodDescriptionbooleanbooleanequalsImpl(Object obj) Compare all fields that contribute to the state, ignoring transient and static fields, forthisand the supplied objectfloatGetter forazimuthBeamwidthGetter forbeamDirectionfloatGetter forelevationBeamwidthfloatgetEx()Getter forexfloatgetEz()Getter forezintReturns size of this serialized (marshalled) object in bytesbyteGetter forpadding1shortGetter forpadding2intGetter forpadding3floatgetPhase()Getter forphaseGetter forreferenceSysteminthashCode()voidmarshal(DataOutputStream dos) Serializes an object to a DataOutputStream.voidmarshal(ByteBuffer byteBuffer) Packs an object into the ByteBuffer.setAzimuthBeamwidth(float pAzimuthBeamwidth) Setter forazimuthBeamwidthsetBeamDirection(EulerAngles pBeamDirection) Setter forbeamDirectionsetElevationBeamwidth(float pElevationBeamwidth) Setter forelevationBeamwidthsetEx(float pEx) Setter forexsetEz(float pEz) Setter forezsetPadding1(byte pPadding1) Setter forpadding1setPadding1(int pPadding1) Utility setter forpadding1setPadding2(int pPadding2) Utility setter forpadding2setPadding2(short pPadding2) Setter forpadding2setPadding3(int pPadding3) Setter forpadding3setPhase(float pPhase) Setter forphasesetReferenceSystem(TransmitterAntennaPatternReferenceSystem pReferenceSystem) Setter forreferenceSystemtoString()intunmarshal(DataInputStream dis) Deserializes an object from a DataInputStream.intunmarshal(ByteBuffer byteBuffer) 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 azimuthBeamwidthFull 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 elevationBeamwidthThis 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
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 padding1Padding -
padding2
protected short padding2Padding -
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 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
Setter forbeamDirection- Parameters:
pBeamDirection- new value of interest- Returns:
- same object to permit progressive setters
-
getBeamDirection
-
setAzimuthBeamwidth
Setter forazimuthBeamwidth- Parameters:
pAzimuthBeamwidth- new value of interest- Returns:
- same object to permit progressive setters
-
getAzimuthBeamwidth
-
setElevationBeamwidth
Setter forelevationBeamwidth- Parameters:
pElevationBeamwidth- new value of interest- Returns:
- same object to permit progressive setters
-
getElevationBeamwidth
-
setReferenceSystem
public BeamAntennaPattern setReferenceSystem(TransmitterAntennaPatternReferenceSystem pReferenceSystem) Setter forreferenceSystem- Parameters:
pReferenceSystem- new value of interest- Returns:
- same object to permit progressive setters
-
getReferenceSystem
Getter forreferenceSystem- Returns:
- value of interest
-
setPadding1
Setter forpadding1- Parameters:
pPadding1- new value of interest- Returns:
- same object to permit progressive setters
-
setPadding1
Utility setter forpadding1- Parameters:
pPadding1- new value of interest- Returns:
- same object to permit progressive setters
-
getPadding1
-
setPadding2
Setter forpadding2- Parameters:
pPadding2- new value of interest- Returns:
- same object to permit progressive setters
-
setPadding2
Utility setter forpadding2- Parameters:
pPadding2- new value of interest- Returns:
- same object to permit progressive setters
-
getPadding2
-
setEz
Setter forez- Parameters:
pEz- new value of interest- Returns:
- same object to permit progressive setters
-
getEz
-
setEx
Setter forex- Parameters:
pEx- new value of interest- Returns:
- same object to permit progressive setters
-
getEx
-
setPhase
Setter forphase- Parameters:
pPhase- new value of interest- Returns:
- same object to permit progressive setters
-
getPhase
-
setPadding3
Setter forpadding3- Parameters:
pPadding3- new value of interest- Returns:
- same object to permit progressive setters
-
getPadding3
-
marshal
Serializes an object to a DataOutputStream.- Parameters:
dos- the OutputStream- Throws:
Exception- if something goes wrong- See Also:
-
unmarshal
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
Packs an object into the ByteBuffer.- Parameters:
byteBuffer- The ByteBuffer at the position to begin writing- Throws:
BufferOverflowException- if byteBuffer is too smallReadOnlyBufferException- if byteBuffer is read onlyException- ByteBuffer-generated exception- See Also:
-
unmarshal
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 smallException- ByteBuffer-generated exception- See Also:
-
equals
-
equalsImpl
Compare all fields that contribute to the state, ignoring transient and static fields, forthisand the supplied object- Parameters:
obj- the object to compare to- Returns:
- true if the objects are equal, false otherwise.
-
toString
-
hashCode
-