src/lte/model/lte-pdcp-header.h
author Nicola Baldo <nbaldo@cttc.es>
Sat, 24 Mar 2012 11:21:20 +0100
changeset 8696 3979745b2835
parent 8368 58ca2e408d26
permissions -rw-r--r--
lte module coding style issues pointed out by Mathieu
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
8368
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
     1
/* -*-  Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
     2
/*
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
     3
 * Copyright (c) 2011 Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
     4
 *
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
     5
 * This program is free software; you can redistribute it and/or modify
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
     6
 * it under the terms of the GNU General Public License version 2 as
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
     7
 * published by the Free Software Foundation;
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
     8
 *
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
     9
 * This program is distributed in the hope that it will be useful,
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    10
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    11
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    12
 * GNU General Public License for more details.
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    13
 *
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    14
 * You should have received a copy of the GNU General Public License
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    15
 * along with this program; if not, write to the Free Software
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    16
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    17
 *
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    18
 * Author: Manuel Requena <manuel.requena@cttc.es>
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    19
 */
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    20
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    21
#ifndef LTE_PDCP_HEADER_H
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    22
#define LTE_PDCP_HEADER_H
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    23
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    24
#include "ns3/header.h"
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    25
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    26
#include <list>
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    27
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    28
namespace ns3 {
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    29
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    30
/**
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    31
 * \ingroup lte
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    32
 * \brief The packet header for the Packet Data Convergence Protocol (PDCP) packets
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    33
 *
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    34
 * This class has fields corresponding to those in an PDCP header as well as
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    35
 * methods for serialization to and deserialization from a byte buffer.
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    36
 * It follows 3GPP TS 36.323 Packet Data Convergence Protocol (PDCP) specification.
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    37
 */
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    38
class LtePdcpHeader : public Header
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    39
{
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    40
public:
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    41
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    42
  /**
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    43
   * \brief Constructor
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    44
   *
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    45
   * Creates a null header
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    46
   */
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    47
  LtePdcpHeader ();
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    48
  ~LtePdcpHeader ();
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    49
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    50
  void SetDcBit (uint8_t dcBit);
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    51
  void SetSequenceNumber (uint16_t sequenceNumber);
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    52
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    53
  uint8_t GetDcBit () const;
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    54
  uint16_t GetSequenceNumber () const;
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    55
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    56
  typedef enum {
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    57
    CONTROL_PDU   = 0,
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    58
    DATA_PDU      = 1
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    59
  } DcBit_t;
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    60
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    61
  static TypeId GetTypeId (void);
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    62
  virtual TypeId GetInstanceTypeId (void) const;
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    63
  virtual void Print (std::ostream &os) const;
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    64
  virtual uint32_t GetSerializedSize (void) const;
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    65
  virtual void Serialize (Buffer::Iterator start) const;
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    66
  virtual uint32_t Deserialize (Buffer::Iterator start);
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    67
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    68
private:
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    69
  uint8_t m_dcBit;
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    70
  uint16_t m_sequenceNumber;
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    71
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    72
};
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    73
8696
3979745b2835 lte module coding style issues pointed out by Mathieu
Nicola Baldo <nbaldo@cttc.es>
parents: 8368
diff changeset
    74
} // namespace ns3
8368
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    75
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    76
#endif // LTE_PDCP_HEADER_H