edu.cmu.emulator.world
Class YagiAntenna

java.lang.Object
  edu.cmu.emulator.world.MovableObject
      edu.cmu.emulator.world.Antenna
          edu.cmu.emulator.world.YagiAntenna

public class YagiAntenna
extends Antenna

Implementation of the behavior of a Directional antenna: Yagi antenna. Extends the basic Antenna object.

See MovableObject for methods used in setting the orientation of this antenna.

Field Summary

static int	AM_DIR
static int	AM_OMNI
protected int	yagiAntennaMode

Fields inherited from class edu.cmu.emulator.world.Antenna

antennaIndex, elementN, emulatedTransmitPower, emuNIC, emuPortID, hardwareTransmitPower, txAmpGain

Fields inherited from class edu.cmu.emulator.world.MovableObject

accelerationMPS2, attributeMap, children, dirOrientation, groupWorker, ID_ACCELERATION_MPS2, ID_ORIENTATION, ID_POSITION, ID_ROTATION, ID_VELOCITY_MPS, name, navigator, OM_PARENT, OM_VELOCITY, orientation, orientationMode, parent, position, rotation, segmentEndMillis, segmentEndPos, segmentListenerManager, segmentStartMillis, segmentStartPos, uName, velocityMPS

Constructor Summary

YagiAntenna(EmuNIC emuNIC, int hwXmitPower, int emuPortID, int antennaIndex, int elementN)

Method Summary

double	getGain(double[] direction) Abstract method that returns the Gain of the antenna in the direction specified.
void	setAntennaMode(int antennaMode) Returns the gain in a particular direction.

Methods inherited from class edu.cmu.emulator.world.Antenna

getAntennaIndex, getElementN, getEmulatedTransmitPower, getEmuPortID, getEmuPortIndex, getHardwareTransmitPower, getNIC, getTxAmpGain, setEmulatedTransmitPower, setTxAmpGain

Methods inherited from class edu.cmu.emulator.world.MovableObject

addChild, addSegmentListener, addWaypointListener, addWaypointListener, endSegment, fixOrientation, getAbsAcceleration, getAbsAcceleration, getAbsOrientation, getAbsOrientation, getAbsPosition, getAbsPosition, getAbsRotation, getAbsRotation, getAbsVelocity, getAbsVelocity, getAcceleration, getAttribute, getChild, getDistance, getName, getNumChildren, getOrientation, getOrientation, getOrientationMode, getParent, getPosition, getRotation, getUName, getVelocity, isMoving, moveToOverTime, moveToOverTime, moveToOverTime, moveToOverTime, moveToWithSpeed, moveToWithSpeed, moveToWithSpeed, notifySegmentListeners, removeSegmentListener, removeWaypointListener, setAttribute, setName, setOrientationMode, setStationaryAtPos, setUName, startRoute, startSegment, stopInPlace, update

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

yagiAntennaMode

protected int yagiAntennaMode

AM_DIR

public static final int AM_DIR

See Also:

Constant Field Values

AM_OMNI

public static final int AM_OMNI

See Also:

Constant Field Values

Constructor Detail

YagiAntenna

public YagiAntenna(EmuNIC emuNIC,
                   int hwXmitPower,
                   int emuPortID,
                   int antennaIndex,
                   int elementN)

Method Detail

setAntennaMode

public void setAntennaMode(int antennaMode)

Returns the gain in a particular direction. Typically only called by the system.

getGain

public double getGain(double[] direction)

Description copied from class: Antenna

Abstract method that returns the Gain of the antenna in the direction specified. This method needs to be overridden by all subclasses.

Specified by:

getGain in class Antenna

Parameters:

direction - The EVector representation of the antenna orientation

Returns:

The calculated value of the Antenna gain.