uan-tx-mode.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2009 University of Washington
 *
 * 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: Leonard Tracy <lentracy@gmail.com>
 */

#ifndef UAN_TX_MODE_H
#define UAN_TX_MODE_H

#include "ns3/object.h"
#include <map>

namespace ns3 {

class UanTxModeFactory;
class UanTxMode;

class UanTxMode
{
public:
  UanTxMode ();   
  ~UanTxMode ();  

  typedef enum {
    PSK,   
    QAM,   
    FSK,   
    OTHER  
  } ModulationType;
  ModulationType GetModType (void) const;
  uint32_t GetDataRateBps (void) const;
  uint32_t GetPhyRateSps (void) const;
  uint32_t GetCenterFreqHz (void) const;
  uint32_t GetBandwidthHz (void) const;
  uint32_t GetConstellationSize (void) const;
  std::string GetName (void) const;
  uint32_t GetUid (void) const;

private:
  friend class UanTxModeFactory;
  friend std::ostream &operator<< (std::ostream & os, const UanTxMode &mode);
  friend std::istream &operator>> (std::istream & is, UanTxMode &mode);


  uint32_t m_uid;  

};  // class UanTxMode

  
std::ostream & operator << (std::ostream & os, const UanTxMode &mode);
std::istream & operator >> (std::istream & is, UanTxMode &mode);

class UanTxModeFactory
{
public:
  UanTxModeFactory ();   
  ~UanTxModeFactory ();  

  static UanTxMode CreateMode (UanTxMode::ModulationType type,
                               uint32_t dataRateBps,
                               uint32_t phyRateSps,
                               uint32_t cfHz,
                               uint32_t bwHz,
                               uint32_t constSize,
                               std::string name);

  static UanTxMode GetMode (std::string name);
  static UanTxMode GetMode (uint32_t uid);

private:
  friend class UanTxMode;
  uint32_t m_nextUid;                  

  struct UanTxModeItem
  {
    UanTxMode::ModulationType m_type;  
    uint32_t m_cfHz;                   
    uint32_t m_bwHz;                   
    uint32_t m_dataRateBps;            
    uint32_t m_phyRateSps;             
    uint32_t m_constSize;              
    uint32_t m_uid;                    
    std::string m_name;                
  };

  std::map<uint32_t, UanTxModeItem> m_modes;

  bool NameUsed (std::string name);

  static UanTxModeFactory &GetFactory (void);

  UanTxModeItem &GetModeItem (uint32_t uid);

  UanTxModeItem &GetModeItem (std::string name);

  UanTxMode MakeModeFromItem (const UanTxModeItem &item);

};  // class UanTxModeFactory

class UanModesList
{
public:
  UanModesList ();           
  virtual ~UanModesList ();  

  void AppendMode (UanTxMode mode);
  void DeleteMode (uint32_t num);
  UanTxMode operator[] (uint32_t index) const;
  uint32_t GetNModes (void) const;


private:
  std::vector<UanTxMode> m_modes;
  
  friend std::ostream &operator << (std::ostream &os, const UanModesList &ml);
  friend std::istream &operator >> (std::istream &is, UanModesList &ml);

};  // class UanModesList

std::ostream &operator << (std::ostream &os, const UanModesList &ml);
std::istream &operator >> (std::istream &is, UanModesList &ml);

ATTRIBUTE_HELPER_HEADER (UanModesList);

} // namespace ns3

#endif /* UAN_TX_MODE_H */