wifi-phy-state-helper.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2005,2006 INRIA
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation;
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * Author: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
 */

#ifndef WIFI_PHY_STATE_HELPER_H
#define WIFI_PHY_STATE_HELPER_H

#include "wifi-phy.h"
#include "ns3/traced-callback.h"
#include "ns3/object.h"
#include <vector>

namespace ns3 {

class WifiPhyStateHelper : public Object
{
public:
  static TypeId GetTypeId (void);

  WifiPhyStateHelper ();

  void SetReceiveOkCallback (WifiPhy::RxOkCallback callback);
  void SetReceiveErrorCallback (WifiPhy::RxErrorCallback callback);
  void RegisterListener (WifiPhyListener *listener);
  void UnregisterListener (WifiPhyListener *listener);
  enum WifiPhy::State GetState (void);
  bool IsStateCcaBusy (void);
  bool IsStateIdle (void);
  bool IsStateBusy (void);
  bool IsStateRx (void);
  bool IsStateTx (void);
  bool IsStateSwitching (void);
  bool IsStateSleep (void);
  Time GetStateDuration (void);
  Time GetDelayUntilIdle (void);
  Time GetLastRxStartTime (void) const;

  void SwitchToTx (Time txDuration, Ptr<const Packet> packet, double txPowerDbm, WifiTxVector txVector, WifiPreamble preamble);
  void SwitchToRx (Time rxDuration);
  void SwitchToChannelSwitching (Time switchingDuration);
  void SwitchFromRxEndOk (Ptr<Packet> packet, double snr, WifiTxVector txVector, enum WifiPreamble preamble);
  void SwitchFromRxEndError (Ptr<const Packet> packet, double snr);
  void SwitchMaybeToCcaBusy (Time duration);
  void SwitchToSleep (void);
  void SwitchFromSleep (Time duration);

  TracedCallback<Time, Time, enum WifiPhy::State> m_stateLogger;

  typedef void (* StateTracedCallback)
    (Time start, Time duration, WifiPhy::State state);

  typedef void (* RxOkTracedCallback)
    (Ptr<const Packet> packet, double snr, WifiMode mode, WifiPreamble preamble);

  typedef void (* RxEndErrorTracedCallback)
    (Ptr<const Packet> packet, double snr);

  typedef void (* TxTracedCallback)
    (Ptr<const Packet> packet, WifiMode mode,
     WifiPreamble preamble, uint8_t power);


private:
  typedef std::vector<WifiPhyListener *> Listeners;
  typedef std::vector<WifiPhyListener *>::iterator ListenersI;

  void LogPreviousIdleAndCcaBusyStates (void);

  void NotifyTxStart (Time duration, double txPowerDbm);
  void NotifyRxStart (Time duration);
  void NotifyRxEndOk (void);
  void NotifyRxEndError (void);
  void NotifyMaybeCcaBusyStart (Time duration);
  void NotifySwitchingStart (Time duration);
  void NotifySleep (void);
  void NotifyWakeup (void);
  void DoSwitchFromRx (void);

  bool m_rxing;
  bool m_sleeping;
  Time m_endTx;
  Time m_endRx;
  Time m_endCcaBusy;
  Time m_endSwitching;
  Time m_startTx;
  Time m_startRx;
  Time m_startCcaBusy;
  Time m_startSwitching;
  Time m_startSleep;
  Time m_previousStateChangeTime;

  Listeners m_listeners;
  TracedCallback<Ptr<const Packet>, double, WifiMode, enum WifiPreamble> m_rxOkTrace;
  TracedCallback<Ptr<const Packet>, double> m_rxErrorTrace;
  TracedCallback<Ptr<const Packet>,WifiMode,WifiPreamble,uint8_t> m_txTrace;
  WifiPhy::RxOkCallback m_rxOkCallback;
  WifiPhy::RxErrorCallback m_rxErrorCallback;
};

} //namespace ns3

#endif /* WIFI_PHY_STATE_HELPER_H */