/Users/yzchen/ns/ns-allinone-2.33/ns-2.33/mac/wireless-phy.h

/* -*-  Mode:C++; c-basic-offset:8; tab-width:8; indent-tabs-mode:t -*-  *
 *
 * Copyright (c) 1997 Regents of the University of California.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *      This product includes software developed by the Computer Systems
 *      Engineering Group at Lawrence Berkeley Laboratory.
 * 4. Neither the name of the University nor of the Laboratory may be used
 *    to endorse or promote products derived from this software without
 *    specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 * $Header: /cvsroot/nsnam/ns-2/mac/wireless-phy.h,v 1.15 2007/01/30 05:00:50 tom_henderson Exp $
 *
 * Ported from CMU/Monarch's code, nov'98 -Padma Haldar.
 *
 * wireless-phy.h
 * -- a SharedMedia network interface
 */

#ifndef ns_WirelessPhy_h
#define ns_WirelessPhy_h

#include "propagation.h"
#include "modulation.h"
#include "omni-antenna.h"
#include "phy.h"
#include "mobilenode.h"
#include "timer-handler.h"

class Phy;
class Propagation;
class WirelessPhy;

class Sleep_Timer : public TimerHandler {
 public:
        Sleep_Timer(WirelessPhy *a) : TimerHandler() { a_ = a; }
 protected:
        virtual void expire(Event *e);
        WirelessPhy *a_;
};

//
class WirelessPhy : public Phy {
public:
        WirelessPhy();
        
        void sendDown(Packet *p);
        int sendUp(Packet *p);
        
        inline double getL() const {return L_;}
        inline double getLambda() const {return lambda_;}
        inline Node* node(void) const { return node_; }
        inline double getPtconsume() { return Pt_consume_; }

        double getDist(double Pr, double Pt, double Gt, double Gr, double hr,
                       double ht, double L, double lambda);
  
        virtual int command(int argc, const char*const* argv);
        virtual void dump(void) const;
        
        //void setnode (MobileNode *node) { node_ = node; }
        void node_on();
        void node_off();        

        /* -NEW- */
        inline double getAntennaZ() { return ant_->getZ(); }
        inline double getPt() { return Pt_; }
        inline double getRXThresh() { return RXThresh_; }
        inline double getCSThresh() { return CSThresh_; }
        inline double getFreq() { return freq_; }
        /* End -NEW- */

        void node_sleep();
        void node_wakeup();
        inline bool& Is_node_on() { return node_on_; }
        inline bool Is_sleeping() { if (status_==SLEEP) return(1); else return(0); }
        double T_sleep_;        // 2.31 change: Time at which sleeping is to be enabled (sec)

protected:
        double Pt_;             // transmitted signal power (W)
        double Pt_consume_;     // power consumption for transmission (W)
        double Pr_consume_;     // power consumption for reception (W)
        double P_idle_;         // idle power consumption (W)
        double P_sleep_;        // sleep power consumption (W)
        double P_transition_;   // power consumed when transiting from SLEEP mode to IDLE mode and vice versa.
        double T_transition_;   // time period to transit from SLEEP mode to IDLE mode and vice versa.
//

        double last_send_time_; // the last time the node sends somthing.
        double channel_idle_time_;      // channel idle time.
        double update_energy_time_;     // the last time we update energy.

        double freq_;           // frequency
        double lambda_;         // wavelength (m)
        double L_;              // system loss factor
  
        double RXThresh_;       // receive power threshold (W)
        double CSThresh_;       // carrier sense threshold (W)
        double CPThresh_;       // capture threshold (db)
  
        Antenna *ant_;
        Propagation *propagation_;      // Propagation Model
        Modulation *modulation_;        // Modulation Schem

        // Why phy has a node_ and this guy has it all over again??
//      MobileNode* node_;              // Mobile Node to which interface is attached .

        enum ChannelStatus { SLEEP, IDLE, RECV, SEND }; 
        bool node_on_; // on-off status of this node
        Sleep_Timer sleep_timer_;
        int status_;

private:
        inline int initialized() {
                return (node_ && uptarget_ && downtarget_ && propagation_);
        }
        void UpdateIdleEnergy();
        void UpdateSleepEnergy();

        // Convenience method
        EnergyModel* em() { return node()->energy_model(); }

        friend class Sleep_Timer;

};

#endif /* !ns_WirelessPhy_h */