src/lte/model/lte-radio-bearer-tag.h
author Robert Ammon <ammo6818@vandals.uidaho.edu>
Fri, 02 Jun 2017 14:45:29 +0200
changeset 12904 e949b994faad
parent 12753 3fbb703f257f
permissions -rw-r--r--
lte: Additional doxygen corrections (patch set 5)
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
7886
b65c16d4da83 LENA project first public release
CTTC
parents:
diff changeset
     1
/* -*-  Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
b65c16d4da83 LENA project first public release
CTTC
parents:
diff changeset
     2
/*
9763
038d5627c5a9 Trim excess copies from PacketTagList::Remove, add PacketTagList::Replace, documentation.
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9743
diff changeset
     3
 * Copyright (c) 2011 Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)
7886
b65c16d4da83 LENA project first public release
CTTC
parents:
diff changeset
     4
 *
b65c16d4da83 LENA project first public release
CTTC
parents:
diff changeset
     5
 * This program is free software; you can redistribute it and/or modify
b65c16d4da83 LENA project first public release
CTTC
parents:
diff changeset
     6
 * it under the terms of the GNU General Public License version 2 as
b65c16d4da83 LENA project first public release
CTTC
parents:
diff changeset
     7
 * published by the Free Software Foundation;
b65c16d4da83 LENA project first public release
CTTC
parents:
diff changeset
     8
 *
b65c16d4da83 LENA project first public release
CTTC
parents:
diff changeset
     9
 * This program is distributed in the hope that it will be useful,
b65c16d4da83 LENA project first public release
CTTC
parents:
diff changeset
    10
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
b65c16d4da83 LENA project first public release
CTTC
parents:
diff changeset
    11
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
b65c16d4da83 LENA project first public release
CTTC
parents:
diff changeset
    12
 * GNU General Public License for more details.
b65c16d4da83 LENA project first public release
CTTC
parents:
diff changeset
    13
 *
b65c16d4da83 LENA project first public release
CTTC
parents:
diff changeset
    14
 * You should have received a copy of the GNU General Public License
b65c16d4da83 LENA project first public release
CTTC
parents:
diff changeset
    15
 * along with this program; if not, write to the Free Software
b65c16d4da83 LENA project first public release
CTTC
parents:
diff changeset
    16
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
b65c16d4da83 LENA project first public release
CTTC
parents:
diff changeset
    17
 *
9763
038d5627c5a9 Trim excess copies from PacketTagList::Remove, add PacketTagList::Replace, documentation.
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9743
diff changeset
    18
 * Author: Author: Marco Miozzo  <marco.miozzo@cttc.es>
7886
b65c16d4da83 LENA project first public release
CTTC
parents:
diff changeset
    19
 */
9763
038d5627c5a9 Trim excess copies from PacketTagList::Remove, add PacketTagList::Replace, documentation.
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9743
diff changeset
    20
#ifndef LTE_RADIO_BEARER_TAG_H
038d5627c5a9 Trim excess copies from PacketTagList::Remove, add PacketTagList::Replace, documentation.
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9743
diff changeset
    21
#define LTE_RADIO_BEARER_TAG_H
7886
b65c16d4da83 LENA project first public release
CTTC
parents:
diff changeset
    22
8696
3979745b2835 lte module coding style issues pointed out by Mathieu
Nicola Baldo <nbaldo@cttc.es>
parents: 8462
diff changeset
    23
#include "ns3/tag.h"
7886
b65c16d4da83 LENA project first public release
CTTC
parents:
diff changeset
    24
b65c16d4da83 LENA project first public release
CTTC
parents:
diff changeset
    25
namespace ns3 {
b65c16d4da83 LENA project first public release
CTTC
parents:
diff changeset
    26
b65c16d4da83 LENA project first public release
CTTC
parents:
diff changeset
    27
class Tag;
b65c16d4da83 LENA project first public release
CTTC
parents:
diff changeset
    28
b65c16d4da83 LENA project first public release
CTTC
parents:
diff changeset
    29
b65c16d4da83 LENA project first public release
CTTC
parents:
diff changeset
    30
/**
9763
038d5627c5a9 Trim excess copies from PacketTagList::Remove, add PacketTagList::Replace, documentation.
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9743
diff changeset
    31
 * Tag used to define the RNTI and LC id for each MAC packet trasmitted
7886
b65c16d4da83 LENA project first public release
CTTC
parents:
diff changeset
    32
 */
b65c16d4da83 LENA project first public release
CTTC
parents:
diff changeset
    33
9763
038d5627c5a9 Trim excess copies from PacketTagList::Remove, add PacketTagList::Replace, documentation.
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9743
diff changeset
    34
class LteRadioBearerTag : public Tag
7886
b65c16d4da83 LENA project first public release
CTTC
parents:
diff changeset
    35
{
b65c16d4da83 LENA project first public release
CTTC
parents:
diff changeset
    36
public:
12753
3fbb703f257f lte: doxygen updates of model (many thanks to Robert Ammon for initial patch)
Biljana Bojovic <biljana.bojovic@gmail.com>
parents: 10425
diff changeset
    37
  /**
3fbb703f257f lte: doxygen updates of model (many thanks to Robert Ammon for initial patch)
Biljana Bojovic <biljana.bojovic@gmail.com>
parents: 10425
diff changeset
    38
   * \brief Get the type ID.
3fbb703f257f lte: doxygen updates of model (many thanks to Robert Ammon for initial patch)
Biljana Bojovic <biljana.bojovic@gmail.com>
parents: 10425
diff changeset
    39
   * \return the object TypeId
3fbb703f257f lte: doxygen updates of model (many thanks to Robert Ammon for initial patch)
Biljana Bojovic <biljana.bojovic@gmail.com>
parents: 10425
diff changeset
    40
   */
7886
b65c16d4da83 LENA project first public release
CTTC
parents:
diff changeset
    41
  static TypeId GetTypeId (void);
b65c16d4da83 LENA project first public release
CTTC
parents:
diff changeset
    42
  virtual TypeId GetInstanceTypeId (void) const;
b65c16d4da83 LENA project first public release
CTTC
parents:
diff changeset
    43
b65c16d4da83 LENA project first public release
CTTC
parents:
diff changeset
    44
  /**
9763
038d5627c5a9 Trim excess copies from PacketTagList::Remove, add PacketTagList::Replace, documentation.
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9743
diff changeset
    45
   * Create an empty LteRadioBearerTag
7886
b65c16d4da83 LENA project first public release
CTTC
parents:
diff changeset
    46
   */
9763
038d5627c5a9 Trim excess copies from PacketTagList::Remove, add PacketTagList::Replace, documentation.
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9743
diff changeset
    47
  LteRadioBearerTag ();
7886
b65c16d4da83 LENA project first public release
CTTC
parents:
diff changeset
    48
b65c16d4da83 LENA project first public release
CTTC
parents:
diff changeset
    49
  /**
9763
038d5627c5a9 Trim excess copies from PacketTagList::Remove, add PacketTagList::Replace, documentation.
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9743
diff changeset
    50
   * Create a LteRadioBearerTag with the given RNTI and LC id
12904
e949b994faad lte: Additional doxygen corrections (patch set 5)
Robert Ammon <ammo6818@vandals.uidaho.edu>
parents: 12753
diff changeset
    51
   * \param rnti the RNTI
e949b994faad lte: Additional doxygen corrections (patch set 5)
Robert Ammon <ammo6818@vandals.uidaho.edu>
parents: 12753
diff changeset
    52
   * \param lcId the LCID
7886
b65c16d4da83 LENA project first public release
CTTC
parents:
diff changeset
    53
   */
9763
038d5627c5a9 Trim excess copies from PacketTagList::Remove, add PacketTagList::Replace, documentation.
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9743
diff changeset
    54
  LteRadioBearerTag (uint16_t  rnti, uint8_t lcId);
8714
398bbcbb3f42 Add MIMO model, test and documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents: 8462
diff changeset
    55
  
398bbcbb3f42 Add MIMO model, test and documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents: 8462
diff changeset
    56
  /**
9763
038d5627c5a9 Trim excess copies from PacketTagList::Remove, add PacketTagList::Replace, documentation.
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9743
diff changeset
    57
  * Create a LteRadioBearerTag with the given RNTI, LC id and layer
12904
e949b994faad lte: Additional doxygen corrections (patch set 5)
Robert Ammon <ammo6818@vandals.uidaho.edu>
parents: 12753
diff changeset
    58
   * \param rnti the RNTI
e949b994faad lte: Additional doxygen corrections (patch set 5)
Robert Ammon <ammo6818@vandals.uidaho.edu>
parents: 12753
diff changeset
    59
   * \param lcId the LCID
e949b994faad lte: Additional doxygen corrections (patch set 5)
Robert Ammon <ammo6818@vandals.uidaho.edu>
parents: 12753
diff changeset
    60
   * \param layer the layer
9763
038d5627c5a9 Trim excess copies from PacketTagList::Remove, add PacketTagList::Replace, documentation.
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9743
diff changeset
    61
  */
038d5627c5a9 Trim excess copies from PacketTagList::Remove, add PacketTagList::Replace, documentation.
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9743
diff changeset
    62
  LteRadioBearerTag (uint16_t  rnti, uint8_t lcId, uint8_t layer);
038d5627c5a9 Trim excess copies from PacketTagList::Remove, add PacketTagList::Replace, documentation.
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9743
diff changeset
    63
038d5627c5a9 Trim excess copies from PacketTagList::Remove, add PacketTagList::Replace, documentation.
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9743
diff changeset
    64
  /**
7886
b65c16d4da83 LENA project first public release
CTTC
parents:
diff changeset
    65
   * Set the RNTI to the given value.
b65c16d4da83 LENA project first public release
CTTC
parents:
diff changeset
    66
   *
b65c16d4da83 LENA project first public release
CTTC
parents:
diff changeset
    67
   * @param rnti the value of the RNTI to set
b65c16d4da83 LENA project first public release
CTTC
parents:
diff changeset
    68
   */
10425
1867d8c25aa7 doxygen warnings for lte module
Budiarto Herman <budiarto.herman@magister.fi>
parents: 9771
diff changeset
    69
  void SetRnti (uint16_t rnti);
7886
b65c16d4da83 LENA project first public release
CTTC
parents:
diff changeset
    70
b65c16d4da83 LENA project first public release
CTTC
parents:
diff changeset
    71
  /**
9763
038d5627c5a9 Trim excess copies from PacketTagList::Remove, add PacketTagList::Replace, documentation.
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9743
diff changeset
    72
   * Set the LC id to the given value.
7886
b65c16d4da83 LENA project first public release
CTTC
parents:
diff changeset
    73
   *
9763
038d5627c5a9 Trim excess copies from PacketTagList::Remove, add PacketTagList::Replace, documentation.
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9743
diff changeset
    74
   * @param lcid the value of the RNTI to set
7886
b65c16d4da83 LENA project first public release
CTTC
parents:
diff changeset
    75
   */
9763
038d5627c5a9 Trim excess copies from PacketTagList::Remove, add PacketTagList::Replace, documentation.
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9743
diff changeset
    76
  void SetLcid (uint8_t lcid);
038d5627c5a9 Trim excess copies from PacketTagList::Remove, add PacketTagList::Replace, documentation.
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9743
diff changeset
    77
  
038d5627c5a9 Trim excess copies from PacketTagList::Remove, add PacketTagList::Replace, documentation.
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9743
diff changeset
    78
  /**
038d5627c5a9 Trim excess copies from PacketTagList::Remove, add PacketTagList::Replace, documentation.
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9743
diff changeset
    79
  * Set the layer id to the given value.
038d5627c5a9 Trim excess copies from PacketTagList::Remove, add PacketTagList::Replace, documentation.
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9743
diff changeset
    80
  *
038d5627c5a9 Trim excess copies from PacketTagList::Remove, add PacketTagList::Replace, documentation.
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9743
diff changeset
    81
  * @param layer the value of the layer to set
038d5627c5a9 Trim excess copies from PacketTagList::Remove, add PacketTagList::Replace, documentation.
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9743
diff changeset
    82
  */
10425
1867d8c25aa7 doxygen warnings for lte module
Budiarto Herman <budiarto.herman@magister.fi>
parents: 9771
diff changeset
    83
  void SetLayer (uint8_t layer);
9763
038d5627c5a9 Trim excess copies from PacketTagList::Remove, add PacketTagList::Replace, documentation.
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9743
diff changeset
    84
7886
b65c16d4da83 LENA project first public release
CTTC
parents:
diff changeset
    85
b65c16d4da83 LENA project first public release
CTTC
parents:
diff changeset
    86
  virtual void Serialize (TagBuffer i) const;
b65c16d4da83 LENA project first public release
CTTC
parents:
diff changeset
    87
  virtual void Deserialize (TagBuffer i);
b65c16d4da83 LENA project first public release
CTTC
parents:
diff changeset
    88
  virtual uint32_t GetSerializedSize () const;
b65c16d4da83 LENA project first public release
CTTC
parents:
diff changeset
    89
  virtual void Print (std::ostream &os) const;
b65c16d4da83 LENA project first public release
CTTC
parents:
diff changeset
    90
12753
3fbb703f257f lte: doxygen updates of model (many thanks to Robert Ammon for initial patch)
Biljana Bojovic <biljana.bojovic@gmail.com>
parents: 10425
diff changeset
    91
  /**
3fbb703f257f lte: doxygen updates of model (many thanks to Robert Ammon for initial patch)
Biljana Bojovic <biljana.bojovic@gmail.com>
parents: 10425
diff changeset
    92
   * Get RNTI function
3fbb703f257f lte: doxygen updates of model (many thanks to Robert Ammon for initial patch)
Biljana Bojovic <biljana.bojovic@gmail.com>
parents: 10425
diff changeset
    93
   *
3fbb703f257f lte: doxygen updates of model (many thanks to Robert Ammon for initial patch)
Biljana Bojovic <biljana.bojovic@gmail.com>
parents: 10425
diff changeset
    94
   * \returns RNTI
3fbb703f257f lte: doxygen updates of model (many thanks to Robert Ammon for initial patch)
Biljana Bojovic <biljana.bojovic@gmail.com>
parents: 10425
diff changeset
    95
   */
7886
b65c16d4da83 LENA project first public release
CTTC
parents:
diff changeset
    96
  uint16_t GetRnti (void) const;
12753
3fbb703f257f lte: doxygen updates of model (many thanks to Robert Ammon for initial patch)
Biljana Bojovic <biljana.bojovic@gmail.com>
parents: 10425
diff changeset
    97
  /**
3fbb703f257f lte: doxygen updates of model (many thanks to Robert Ammon for initial patch)
Biljana Bojovic <biljana.bojovic@gmail.com>
parents: 10425
diff changeset
    98
   * Get LCID function
3fbb703f257f lte: doxygen updates of model (many thanks to Robert Ammon for initial patch)
Biljana Bojovic <biljana.bojovic@gmail.com>
parents: 10425
diff changeset
    99
   *
3fbb703f257f lte: doxygen updates of model (many thanks to Robert Ammon for initial patch)
Biljana Bojovic <biljana.bojovic@gmail.com>
parents: 10425
diff changeset
   100
   * \returns LCID
3fbb703f257f lte: doxygen updates of model (many thanks to Robert Ammon for initial patch)
Biljana Bojovic <biljana.bojovic@gmail.com>
parents: 10425
diff changeset
   101
   */
9763
038d5627c5a9 Trim excess copies from PacketTagList::Remove, add PacketTagList::Replace, documentation.
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9743
diff changeset
   102
  uint8_t GetLcid (void) const;
12753
3fbb703f257f lte: doxygen updates of model (many thanks to Robert Ammon for initial patch)
Biljana Bojovic <biljana.bojovic@gmail.com>
parents: 10425
diff changeset
   103
  /**
3fbb703f257f lte: doxygen updates of model (many thanks to Robert Ammon for initial patch)
Biljana Bojovic <biljana.bojovic@gmail.com>
parents: 10425
diff changeset
   104
   * Get layer function
3fbb703f257f lte: doxygen updates of model (many thanks to Robert Ammon for initial patch)
Biljana Bojovic <biljana.bojovic@gmail.com>
parents: 10425
diff changeset
   105
   *
3fbb703f257f lte: doxygen updates of model (many thanks to Robert Ammon for initial patch)
Biljana Bojovic <biljana.bojovic@gmail.com>
parents: 10425
diff changeset
   106
   * \returns layer
3fbb703f257f lte: doxygen updates of model (many thanks to Robert Ammon for initial patch)
Biljana Bojovic <biljana.bojovic@gmail.com>
parents: 10425
diff changeset
   107
   */
9763
038d5627c5a9 Trim excess copies from PacketTagList::Remove, add PacketTagList::Replace, documentation.
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9743
diff changeset
   108
  uint8_t GetLayer (void) const;
7886
b65c16d4da83 LENA project first public release
CTTC
parents:
diff changeset
   109
b65c16d4da83 LENA project first public release
CTTC
parents:
diff changeset
   110
private:
12753
3fbb703f257f lte: doxygen updates of model (many thanks to Robert Ammon for initial patch)
Biljana Bojovic <biljana.bojovic@gmail.com>
parents: 10425
diff changeset
   111
  uint16_t m_rnti; ///< RNTI
3fbb703f257f lte: doxygen updates of model (many thanks to Robert Ammon for initial patch)
Biljana Bojovic <biljana.bojovic@gmail.com>
parents: 10425
diff changeset
   112
  uint8_t m_lcid; ///< LCID
3fbb703f257f lte: doxygen updates of model (many thanks to Robert Ammon for initial patch)
Biljana Bojovic <biljana.bojovic@gmail.com>
parents: 10425
diff changeset
   113
  uint8_t m_layer; ///< layer
7886
b65c16d4da83 LENA project first public release
CTTC
parents:
diff changeset
   114
b65c16d4da83 LENA project first public release
CTTC
parents:
diff changeset
   115
};
b65c16d4da83 LENA project first public release
CTTC
parents:
diff changeset
   116
b65c16d4da83 LENA project first public release
CTTC
parents:
diff changeset
   117
b65c16d4da83 LENA project first public release
CTTC
parents:
diff changeset
   118
b65c16d4da83 LENA project first public release
CTTC
parents:
diff changeset
   119
} // namespace ns3
b65c16d4da83 LENA project first public release
CTTC
parents:
diff changeset
   120
9763
038d5627c5a9 Trim excess copies from PacketTagList::Remove, add PacketTagList::Replace, documentation.
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9743
diff changeset
   121
#endif /* LTE_RADIO_BEARER_TAG_H */