src/lte/model/bearer-qos-parameters.h
changeset 8749 4462ac63d4cf
parent 8748 87a141a38088
parent 8747 2aec19a85c73
child 8750 b3db7d51f260
child 8765 b89660102b63
equal deleted inserted replaced
8748:87a141a38088 8749:4462ac63d4cf
     1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
       
     2 /*
       
     3  * Copyright (c) 2010 TELEMATICS LAB, DEE - Politecnico di Bari
       
     4  *
       
     5  * This program is free software; you can redistribute it and/or modify
       
     6  * it under the terms of the GNU General Public License version 2 as
       
     7  * published by the Free Software Foundation;
       
     8  *
       
     9  * This program is distributed in the hope that it will be useful,
       
    10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
       
    11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
       
    12  * GNU General Public License for more details.
       
    13  *
       
    14  * You should have received a copy of the GNU General Public License
       
    15  * along with this program; if not, write to the Free Software
       
    16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
       
    17  *
       
    18  * Author: Giuseppe Piro  <g.piro@poliba.it>
       
    19  */
       
    20 
       
    21 #ifndef BEARER_QOS_PARAMETERS_H
       
    22 #define BEARER_QOS_PARAMETERS_H
       
    23 
       
    24 #include "ns3/object.h"
       
    25 
       
    26 namespace ns3 {
       
    27 
       
    28 
       
    29 /**
       
    30  * \ingroup lte
       
    31  *
       
    32  * \brief the BearerQosParameters class implements a set of Qos
       
    33  * parameters associated to the bearer.
       
    34  * Bearer Level Qos (TS 23.401, Clause 4.7.3)
       
    35  * A bearer uniquely identifies traffic flows that receive a
       
    36  * common Qos treatment.
       
    37  */
       
    38 class BearerQosParameters : public Object
       
    39 {
       
    40 public:
       
    41   BearerQosParameters (void);
       
    42 
       
    43   /**
       
    44    * \brief Create a Qos Parameters Set
       
    45    *
       
    46    * \param qci the Qos Class Identifier
       
    47    * \param gbr the maximum bit rate to guarantee
       
    48    * \param mbr the minimum bit rate to guarantee
       
    49    */
       
    50   BearerQosParameters (int qci,
       
    51                        double gbr,
       
    52                        double mbr);
       
    53 
       
    54   /**
       
    55    * \brief Create a Qos Parameters Set
       
    56    *
       
    57    * \param qci the Qos Class Identifier
       
    58    * \param apec the Allocation and Retention Priority of pre-emption capability
       
    59    * \param apev the Allocation and Retention Priority of pre-emption vulnerability
       
    60    * \param gbr the maximum bit rate to guarantee
       
    61    * \param mbr the minimum bit rate to guarantee
       
    62    */
       
    63   BearerQosParameters (int qci,
       
    64                        bool apec,
       
    65                        bool apev,
       
    66                        double gbr,
       
    67                        double mbr);
       
    68 
       
    69   virtual ~BearerQosParameters (void);
       
    70 
       
    71   /**
       
    72    * Type og bearer (GBR or non GBR)
       
    73    */
       
    74   enum BearerQosType
       
    75   {
       
    76     BEARER_TYPE_GBR, BEARER_TYPE_NGBR
       
    77   };
       
    78 
       
    79   /**
       
    80    * \brief Set the Qos type of the bearer
       
    81    * \param QosType the Qos type
       
    82    */
       
    83   void SetBearerQosType (BearerQosType QosType);
       
    84 
       
    85   /**
       
    86    * \brief Get the Qos type of the bearer
       
    87    * \return the Qos tyope of the bearer
       
    88    */
       
    89   BearerQosType GetBearerQosType (void) const;
       
    90 
       
    91 
       
    92   /**
       
    93    * \param qci the Qos Class Identifier
       
    94    */
       
    95   void SetQci (int qci);
       
    96   /**
       
    97    * \return the QCI value
       
    98    */
       
    99   int GetQci (void) const;
       
   100 
       
   101   /**
       
   102    * \param apec the Allocation and Retention Priority of pre-emption capability
       
   103    */
       
   104   void SetArpPreEmptionCapability (bool apec);
       
   105   /**
       
   106    * \return the ArpPreEmptionCapability value
       
   107    */
       
   108   bool GetArpPreEmptionCapability (void) const;
       
   109 
       
   110   /**
       
   111    * \param apev the Allocation and Retention Priority of pre-emption vulnerability
       
   112    */
       
   113   void SetArpPreEmptionVulnerability (bool apev);
       
   114   /**
       
   115    * \return the ArpPreEmptionVulnerability value
       
   116    */
       
   117   bool GetArpPreEmptionVulnerability (void) const;
       
   118 
       
   119   /**
       
   120    * \param gbr the maximum bit rate to guarantee
       
   121    */
       
   122   void SetGbr (double gbr);
       
   123   /**
       
   124    * \return the maximum bit rate
       
   125    */
       
   126   double GetGbr (void) const;
       
   127 
       
   128   /**
       
   129    * \param mbr the minimum bit rate to guarantee
       
   130    */
       
   131   void SetMbr (double mbr);
       
   132   /**
       
   133    * \return the minimum bit rate
       
   134    */
       
   135   double GetMbr (void) const;
       
   136 
       
   137   /**
       
   138    * \param targetDelay the target delay
       
   139    */
       
   140   void SetMaxDelay (double targetDelay);
       
   141   /**
       
   142    * \return the targetDelay value
       
   143    */
       
   144   double GetMaxDelay (void) const;
       
   145 
       
   146 private:
       
   147   BearerQosType m_bearerQosType;
       
   148 
       
   149   int m_qci;
       
   150   bool m_arpPreEmptionCapability;
       
   151   bool m_arpPreEmptionVulnerability;
       
   152   double m_gbr;
       
   153   double m_mbr;
       
   154   double m_maxDelay;
       
   155 };
       
   156 
       
   157 
       
   158 }
       
   159 #endif /* BEARER_QOS_PARAMETERS_H */