A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
lte-asn1-header.h
Go to the documentation of this file.
1 /* -*- Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2012 Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)
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: Lluis Parcerisa <lparcerisa@cttc.cat>
19  */
20 
21 #ifndef ASN1_HEADER_H
22 #define ASN1_HEADER_H
23 
24 #include "ns3/header.h"
25 
26 #include <bitset>
27 #include <string>
28 
29 #include "ns3/lte-rrc-sap.h"
30 
31 namespace ns3 {
32 
38 class Asn1Header : public Header
39 {
40 public:
41  Asn1Header ();
42  virtual ~Asn1Header ();
43 
44  // Inherited from ns3::Header base class
45  static TypeId GetTypeId (void);
46  virtual TypeId GetInstanceTypeId (void) const;
47  uint32_t GetSerializedSize (void) const;
48  void Serialize (Buffer::Iterator bIterator) const;
49 
50  // Inherited from ns3::Header base class
51  // Pure virtual methods, to be implemented in child classes
52  virtual uint32_t Deserialize (Buffer::Iterator bIterator) = 0;
53  virtual void Print (std::ostream &os) const = 0;
54 
63  virtual void PreSerialize (void) const = 0;
64 
65 protected:
66  mutable uint8_t m_serializationPendingBits;
67  mutable uint8_t m_numSerializationPendingBits;
68  mutable bool m_isDataSerialized;
69  mutable Buffer m_serializationResult;
70 
71  // Function to write in m_serializationResult, after resizing its size
72  void WriteOctet (uint8_t octet) const;
73 
74  // Serialization functions
75  void SerializeBoolean (bool value) const;
76  void SerializeInteger (int n, int nmin, int nmax) const;
77  void SerializeOctetstring (std::string s) const;
78  void SerializeSequenceOf (int numElems, int nMax, int nMin) const;
79  void SerializeChoice (int numOptions, int selectedOption, bool isExtensionMarkerPresent) const;
80  void SerializeEnum (int numElems, int selectedElem) const;
81  void SerializeNull () const;
82  void FinalizeSerialization () const;
83 
84  template <int N>
85  void SerializeBitset (std::bitset<N> data) const;
86 
87  template <int N>
88  void SerializeSequence (std::bitset<N> optionalOrDefaultMask, bool isExtensionMarkerPresent) const;
89  void SerializeSequence (std::bitset<0> optionalOrDefaultMask, bool isExtensionMarkerPresent) const;
90  void SerializeSequence (std::bitset<1> optionalOrDefaultMask, bool isExtensionMarkerPresent) const;
91  void SerializeSequence (std::bitset<2> optionalOrDefaultMask, bool isExtensionMarkerPresent) const;
92  void SerializeSequence (std::bitset<3> optionalOrDefaultMask, bool isExtensionMarkerPresent) const;
93  void SerializeSequence (std::bitset<4> optionalOrDefaultMask, bool isExtensionMarkerPresent) const;
94  void SerializeSequence (std::bitset<5> optionalOrDefaultMask, bool isExtensionMarkerPresent) const;
95  void SerializeSequence (std::bitset<6> optionalOrDefaultMask, bool isExtensionMarkerPresent) const;
96  void SerializeSequence (std::bitset<9> optionalOrDefaultMask, bool isExtensionMarkerPresent) const;
97  void SerializeSequence (std::bitset<10> optionalOrDefaultMask, bool isExtensionMarkerPresent) const;
98  void SerializeSequence (std::bitset<11> optionalOrDefaultMask, bool isExtensionMarkerPresent) const;
99 
100  template <int N>
101  void SerializeBitstring (std::bitset<N> bitstring) const;
102  void SerializeBitstring (std::bitset<1> bitstring) const;
103  void SerializeBitstring (std::bitset<2> bitstring) const;
104  void SerializeBitstring (std::bitset<8> bitstring) const;
105  void SerializeBitstring (std::bitset<10> bitstring) const;
106  void SerializeBitstring (std::bitset<16> bitstring) const;
107  void SerializeBitstring (std::bitset<27> bitstring) const;
108  void SerializeBitstring (std::bitset<28> bitstring) const;
109  void SerializeBitstring (std::bitset<32> bitstring) const;
110 
111  // Deserialization functions
112  template <int N>
113  Buffer::Iterator DeserializeBitset (std::bitset<N> *data, Buffer::Iterator bIterator);
114  Buffer::Iterator DeserializeBitset (std::bitset<8> *data, Buffer::Iterator bIterator);
115 
116  Buffer::Iterator DeserializeBoolean (bool *value, Buffer::Iterator bIterator);
117  Buffer::Iterator DeserializeInteger (int *n, int nmin, int nmax, Buffer::Iterator bIterator);
118  Buffer::Iterator DeserializeChoice (int numOptions, bool isExtensionMarkerPresent, int *selectedOption, Buffer::Iterator bIterator);
119  Buffer::Iterator DeserializeEnum (int numElems, int *selectedElem, Buffer::Iterator bIterator);
120 
121  template <int N>
122  Buffer::Iterator DeserializeSequence (std::bitset<N> *optionalOrDefaultMask, bool isExtensionMarkerPresent, Buffer::Iterator bIterator);
123  Buffer::Iterator DeserializeSequence (std::bitset<0> *optionalOrDefaultMask, bool isExtensionMarkerPresent, Buffer::Iterator bIterator);
124  Buffer::Iterator DeserializeSequence (std::bitset<1> *optionalOrDefaultMask, bool isExtensionMarkerPresent, Buffer::Iterator bIterator);
125  Buffer::Iterator DeserializeSequence (std::bitset<2> *optionalOrDefaultMask, bool isExtensionMarkerPresent, Buffer::Iterator bIterator);
126  Buffer::Iterator DeserializeSequence (std::bitset<3> *optionalOrDefaultMask, bool isExtensionMarkerPresent, Buffer::Iterator bIterator);
127  Buffer::Iterator DeserializeSequence (std::bitset<4> *optionalOrDefaultMask, bool isExtensionMarkerPresent, Buffer::Iterator bIterator);
128  Buffer::Iterator DeserializeSequence (std::bitset<5> *optionalOrDefaultMask, bool isExtensionMarkerPresent, Buffer::Iterator bIterator);
129  Buffer::Iterator DeserializeSequence (std::bitset<6> *optionalOrDefaultMask, bool isExtensionMarkerPresent, Buffer::Iterator bIterator);
130  Buffer::Iterator DeserializeSequence (std::bitset<9> *optionalOrDefaultMask, bool isExtensionMarkerPresent, Buffer::Iterator bIterator);
131  Buffer::Iterator DeserializeSequence (std::bitset<10> *optionalOrDefaultMask, bool isExtensionMarkerPresent, Buffer::Iterator bIterator);
132  Buffer::Iterator DeserializeSequence (std::bitset<11> *optionalOrDefaultMask, bool isExtensionMarkerPresent, Buffer::Iterator bIterator);
133 
134  template <int N>
135  Buffer::Iterator DeserializeBitstring (std::bitset<N> *bitstring, Buffer::Iterator bIterator);
136  Buffer::Iterator DeserializeBitstring (std::bitset<1> *bitstring, Buffer::Iterator bIterator);
137  Buffer::Iterator DeserializeBitstring (std::bitset<2> *bitstring, Buffer::Iterator bIterator);
138  Buffer::Iterator DeserializeBitstring (std::bitset<8> *bitstring, Buffer::Iterator bIterator);
139  Buffer::Iterator DeserializeBitstring (std::bitset<10> *bitstring, Buffer::Iterator bIterator);
140  Buffer::Iterator DeserializeBitstring (std::bitset<16> *bitstring, Buffer::Iterator bIterator);
141  Buffer::Iterator DeserializeBitstring (std::bitset<27> *bitstring, Buffer::Iterator bIterator);
142  Buffer::Iterator DeserializeBitstring (std::bitset<28> *bitstring, Buffer::Iterator bIterator);
143  Buffer::Iterator DeserializeBitstring (std::bitset<32> *bitstring, Buffer::Iterator bIterator);
144 
145  Buffer::Iterator DeserializeNull (Buffer::Iterator bIterator);
146  Buffer::Iterator DeserializeSequenceOf (int *numElems, int nMax, int nMin, Buffer::Iterator bIterator);
147 };
148 
149 } // namespace ns3
150 
151 #endif // ASN1_HEADER_H
152