• Main Page
  • Classes
  • Files
  • File List

/Users/yzchen/ns/ns-allinone-2.33/ns-2.33/mobile/antenna.h

00001 /* -*-  Mode:C++; c-basic-offset:8; tab-width:8; indent-tabs-mode:t -*- */
00002 /*
00003  * Copyright (c) 1997 Regents of the University of California.
00004  * All rights reserved.
00005  *
00006  * Redistribution and use in source and binary forms, with or without
00007  * modification, are permitted provided that the following conditions
00008  * are met:
00009  * 1. Redistributions of source code must retain the above copyright
00010  *    notice, this list of conditions and the following disclaimer.
00011  * 2. Redistributions in binary form must reproduce the above copyright
00012  *    notice, this list of conditions and the following disclaimer in the
00013  *    documentation and/or other materials provided with the distribution.
00014  * 3. All advertising materials mentioning features or use of this software
00015  *    must display the following acknowledgement:
00016  *      This product includes software developed by the Computer Systems
00017  *      Engineering Group at Lawrence Berkeley Laboratory.
00018  * 4. Neither the name of the University nor of the Laboratory may be used
00019  *    to endorse or promote products derived from this software without
00020  *    specific prior written permission.
00021  *
00022  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
00023  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00024  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00025  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
00026  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 
00027  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
00028  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
00029  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
00030  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
00031  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00032  * SUCH DAMAGE.
00033  */
00034 /* Ported from CMU/Monarch's code, nov'98 -Padma.
00035    
00036    antenna.h
00037    super class for all antenna types
00038 */
00039 
00040 #ifndef ns_antenna_h
00041 #define ns_antenna_h
00042 
00043 #include "object.h"
00044 #include "lib/bsd-list.h"
00045 
00046 class Antenna;
00047 LIST_HEAD(an_head, Antenna);
00048 
00049 class Antenna : public TclObject {
00050 
00051 public:
00052   Antenna();
00053   
00054   virtual double getTxGain(double /*dX*/, double /*dY*/, double /*dZ*/,
00055                            double /*lambda*/);
00056   // return the gain for a signal to a node at vector dX, dY, dZ
00057   // from the transmitter at wavelength lambda
00058 
00059   virtual double getRxGain(double /*dX*/, double /*dY*/, double /*dZ*/,
00060                            double /*lambda*/);
00061   // return the gain for a signal from a node at vector dX, dY, dZ
00062   // from the receiver at wavelength lambda
00063   
00064   virtual Antenna * copy();
00065   // return a pointer to a copy of this antenna that will return the 
00066   // same thing for get{Rx,Tx}Gain that this one would at this point
00067   // in time.  This is needed b/c if a pkt is sent with a directable
00068   // antenna, this antenna may be have been redirected by the time we
00069   // call getTxGain on the copy to determine if the pkt is received.
00070 
00071   virtual void release();
00072   // release a copy created by copy() above
00073 
00074   inline void insert(struct an_head* head) {
00075     LIST_INSERT_HEAD(head, this, link);
00076   }
00077 
00078   virtual inline double getX() {return X_;}
00079   virtual inline double getY() {return Y_;}
00080   virtual inline double getZ() {return Z_;}
00081 
00082 private:
00083   LIST_ENTRY(Antenna) link;
00084   
00085 protected:  
00086   double X_;                    // position w.r.t. the node
00087   double Y_;
00088   double Z_;
00089 };
00090 
00091 
00092 #endif // ns_antenna_h

Generated on Tue Aug 10 2010 16:16:07 for ns-2.33 by  doxygen 1.7.1