DRCL J-Sim API

drcl.inet.mac
Class SwitchedBeamAntenna

java.lang.Object
  extended bydrcl.DrclObj
      extended bydrcl.comp.Component
          extended bydrcl.inet.mac.Antenna
              extended bydrcl.inet.mac.SwitchedBeamAntenna
All Implemented Interfaces:
java.lang.Cloneable, ObjectCloneable, ObjectDuplicable, java.io.Serializable

public class SwitchedBeamAntenna
extends Antenna

This class is derived from class Antenna.java Before using, it has to be initialized with pattern files. A simple example: "mkdir drcl.inet.mac.WirelessPhy phy inject "create SwitchedBeam Antenna" phy/.antenna@ inject "azimuthpatterns = azimuth_file" phy/.antenna@ (required) inject "elevationpatterns = elevation_file" phy/.antenna@ (optional, if occur, has to be after the above line)"

Author:
Chunyu Hu
See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class drcl.inet.mac.Antenna
Antenna.Orientation
 
Nested classes inherited from class drcl.comp.Component
Component.Locks
 
Field Summary
static java.lang.String INITIALIZE_PORT_ID
           
 
Fields inherited from class drcl.inet.mac.Antenna
ANTENNA_ANGLE_RESOLUTION, OMNIDIRECTIONAL_PATTERN_INDEX, UNINITIALIZED_GAIN_VALUE
 
Fields inherited from class drcl.comp.Component
FLAG_COMPONENT_NOTIFICATION, FLAG_DEBUG_ENABLED, FLAG_DIRECT_OUTPUT_ENABLED, FLAG_ENABLED, FLAG_ERROR_ENABLED, FLAG_EVENT_ENABLED, FLAG_GARBAGE_DISPLAY_ENABLED, FLAG_GARBAGE_ENABLED, FLAG_PORT_NOTIFICATION, FLAG_STARTED, FLAG_STOPPED, FLAG_TRACE_ENABLED, FLAG_UNDEFINED_START, id, infoPort, locks, name, parent, PortGroup_DEFAULT_GROUP, PortGroup_EVENT, PortGroup_SERVICE, Root, Trace_DATA, Trace_SEND
 
Constructor Summary
SwitchedBeamAntenna()
          Creates a new instance of SwitchedBeamAntenna
 
Method Summary
 float getGain_dBi_wPatternX_atOrientX(int patternIndex_, Antenna.Orientation orient_)
          Get the gain of pattern at direction .
 float getGain_dBi(Antenna.Orientation orient_)
          Get the gain using the current activePattern at the given angle.
 int getPattern_withMaxGain(Antenna.Orientation orient_)
          Find the pattern using which the antenna can receive a signal in the arriving direction with maximum gain.
 boolean lockAtSignal(Antenna.Orientation orient_)
          Lock an incoming signal from direction
 void process(java.lang.Object data_, Port inPort_)
          Process incoming data
 java.lang.String QueryType()
           
 
Methods inherited from class drcl.inet.mac.Antenna
getActivePattern, getGain_dBi, initAzimuthPatterns, initElevationPatterns, isLocked, lockAtSignal, normalizeAzimuthAngle, normalizeElevationAngle, setActivePattern, unlock
 
Methods inherited from class drcl.comp.Component
addComponent, addComponent, addEventPort, addEventPort, addForkPort, addPort, addPort, addPort, addPort, addPort, addPort, addPort, addPort, addServerPort, addServerPort, cancelFork, connect, containsComponent, containsComponent, containsPort, debug, disconnectAll, disconnectAllPeers, disconnectAllPorts, drop, drop, duplicate, error, error, expose, exposeEventPorts, exposePort, exposePort, exposePort, exposePort, exposePort, findAvailable, findAvailable, findAvailable, fork, forkAt, getAllComponents, getAllPorts, getAllPorts, getAllWiresInside, getAllWiresInsideOut, getAllWiresOut, getComponent, getComponentFlag, getComponentFlag, getContract, getContractHT, getContractHT, getDebugFlagsInBinary, getDebugLevelNames, getID, getName, getParent, getPort, getPort, getRoot, getTime, iduplicate, info, isAncestorOf, isContainer, isDebugEnabled, isDebugEnabledAt, isDirectlyRelatedTo, isDirectOutputEnabled, isEnabled, isErrorNoticeEnabled, isEventExportEnabled, isGarbageDisplayEnabled, isGarbageEnabled, isPortRemovable, isStarted, isStopped, isTraceEnabled, lock, notify, notifyAll, operate, reboot, removeAll, removeAllComponents, removeAllPorts, removeAllPorts, removeComponent, removeComponent, removePort, removePort, removePort, reset, resume, run, sduplicate, send, sendAt, setComponentFlag, setComponentFlag, setDebugEnabled, setDebugEnabled, setDebugEnabledAt, setDebugEnabledAt, setDebugEnabledAt, setDirectOutputEnabled, setDirectOutputEnabled, setEnabled, setErrorNoticeEnabled, setErrorNoticeEnabled, setEventExportEnabled, setEventExportEnabled, setExecutionBoundary, setGarbageDisplayEnabled, setGarbageDisplayEnabled, setGarbageEnabled, setGarbageEnabled, setID, setID, setName, setPort, setPort, setTraceEnabled, setTraceEnabled, sleepFor, sleepUntil, stop, toString, unexpose, unlock, useLocalForkManager, useLocalForkManager, wait
 
Methods inherited from class drcl.DrclObj
clone
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

INITIALIZE_PORT_ID

public static final java.lang.String INITIALIZE_PORT_ID
See Also:
Constant Field Values
Constructor Detail

SwitchedBeamAntenna

public SwitchedBeamAntenna()
Creates a new instance of SwitchedBeamAntenna

Method Detail

QueryType

public java.lang.String QueryType()
Overrides:
QueryType in class Antenna

getGain_dBi

public float getGain_dBi(Antenna.Orientation orient_)
Get the gain using the current activePattern at the given angle.

Overrides:
getGain_dBi in class Antenna

getGain_dBi_wPatternX_atOrientX

public float getGain_dBi_wPatternX_atOrientX(int patternIndex_,
                                             Antenna.Orientation orient_)
Get the gain of pattern at direction .


getPattern_withMaxGain

public int getPattern_withMaxGain(Antenna.Orientation orient_)
Find the pattern using which the antenna can receive a signal in the arriving direction with maximum gain.


lockAtSignal

public boolean lockAtSignal(Antenna.Orientation orient_)
Lock an incoming signal from direction

Overrides:
lockAtSignal in class Antenna

process

public void process(java.lang.Object data_,
                    Port inPort_)
Process incoming data

Overrides:
process in class Antenna
Parameters:
data_ - = name of object to be initialized. 1. data_ = "height = ...", case insensitive 2. data_ = "omniGain_dBi = ...", case insensitive 3. data_ = "azimuthPatterns = ", case insensitive 4. data)->item = "elevationPatterns = ", case insensitive

DRCL J-Sim API

Copyright © 1998-2003 Distributed Real-time Computing Lab (DRCL). All Rights Reserved.     ~ To J-Sim Home ~