A Discrete-Event Network Simulator
API
cid.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2007,2008,2009 INRIA, UDcast
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  * Authors: Jahanzeb Farooq <jahanzeb.farooq@sophia.inria.fr>
19  * Mohamed Amine Ismail <amine.ismail@sophia.inria.fr>
20  * <amine.ismail@UDcast.com>
21  */
22 
23 
24 #ifndef CID_H
25 #define CID_H
26 
27 #include <stdint.h>
28 #include <ostream>
29 
30 namespace ns3 {
31 
37 class Cid
38 {
39 public:
41  enum Type
42  {
43  BROADCAST = 1,
50  };
51 
53  Cid (void);
59  Cid (uint16_t cid);
60  ~Cid (void);
64  uint16_t GetIdentifier (void) const;
68  bool IsMulticast (void) const;
72  bool IsBroadcast (void) const;
76  bool IsPadding (void) const;
80  bool IsInitialRanging (void) const;
84  static Cid Broadcast (void);
88  static Cid Padding (void);
92  static Cid InitialRanging (void);
93 
94 private:
96  friend class CidFactory;
98  friend bool operator == (const Cid &lhs, const Cid &rhs);
99  uint16_t m_identifier;
100 };
101 
102 bool operator == (const Cid &lhs, const Cid &rhs);
103 bool operator != (const Cid &lhs, const Cid &rhs);
104 
105 std::ostream & operator << (std::ostream &os, const Cid &cid);
106 
107 } // namespace ns3
108 
109 #endif /* CID_H */
Cid(void)
Create a cid of unknown type.
Definition: cid.cc:30
bool IsInitialRanging(void) const
Definition: cid.cc:66
Type
Type enumeration.
Definition: cid.h:41
~Cid(void)
Definition: cid.cc:40
uint16_t m_identifier
identiifier
Definition: cid.h:99
bool IsPadding(void) const
Definition: cid.cc:61
static Cid Broadcast(void)
Definition: cid.cc:72
static Cid InitialRanging(void)
Definition: cid.cc:82
std::ostream & operator<<(std::ostream &os, const Angles &a)
print a struct Angles to output
Definition: angles.cc:42
bool operator!=(Callback< R, T1, T2, T3, T4, T5, T6, T7, T8, T9 > a, Callback< R, T1, T2, T3, T4, T5, T6, T7, T8, T9 > b)
Inequality test.
Definition: callback.h:1471
Every class exported by the ns3 library is enclosed in the ns3 namespace.
static Cid Padding(void)
Definition: cid.cc:77
Cid class.
Definition: cid.h:37
bool operator==(const EventId &a, const EventId &b)
Definition: event-id.h:135
bool IsMulticast(void) const
Definition: cid.cc:51
uint16_t GetIdentifier(void) const
Definition: cid.cc:45
friend bool operator==(const Cid &lhs, const Cid &rhs)
equality operator
Definition: cid.cc:93
This class is used exclusively by the BS to allocate CIDs to new connections.
Definition: cid-factory.h:45
bool IsBroadcast(void) const
Definition: cid.cc:56