A Discrete-Event Network Simulator
API
mac16-address.h
Go to the documentation of this file.
1 /* -*- Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2007 INRIA
4  * Copyright (c) 2011 The Boeing Company
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License version 2 as
8  * published by the Free Software Foundation;
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18  *
19  */
20 #ifndef MAC16_ADDRESS_H
21 #define MAC16_ADDRESS_H
22 
23 #include <stdint.h>
24 #include <ostream>
25 #include "ns3/attribute.h"
26 #include "ns3/attribute-helper.h"
27 #include "ipv4-address.h"
28 #include "ipv6-address.h"
29 
30 namespace ns3 {
31 
32 class Address;
33 
42 {
43 public:
44  Mac16Address ();
49  Mac16Address (const char *str);
50 
56  void CopyFrom (const uint8_t buffer[2]);
62  void CopyTo (uint8_t buffer[2]) const;
68  operator Address () const;
77  static Mac16Address ConvertFrom (const Address &address);
82  static bool IsMatchingType (const Address &address);
87  static Mac16Address Allocate (void);
88 
92  static Mac16Address GetBroadcast (void);
93 
117 
124  bool IsBroadcast (void) const;
125 
132  bool IsMulticast (void) const;
133 
134 private:
140  Address ConvertTo (void) const;
141 
146  static uint8_t GetType (void);
147 
155  friend bool operator == (const Mac16Address &a, const Mac16Address &b);
156 
164  friend bool operator != (const Mac16Address &a, const Mac16Address &b);
165 
173  friend bool operator < (const Mac16Address &a, const Mac16Address &b);
174 
182  friend std::ostream& operator<< (std::ostream& os, const Mac16Address & address);
183 
191  friend std::istream& operator>> (std::istream& is, Mac16Address & address);
192 
193  uint8_t m_address[2];
194 };
195 
197 
198 inline bool operator == (const Mac16Address &a, const Mac16Address &b)
199 {
200  return memcmp (a.m_address, b.m_address, 2) == 0;
201 }
202 inline bool operator != (const Mac16Address &a, const Mac16Address &b)
203 {
204  return memcmp (a.m_address, b.m_address, 2) != 0;
205 }
206 inline bool operator < (const Mac16Address &a, const Mac16Address &b)
207 {
208  return memcmp (a.m_address, b.m_address, 2) < 0;
209 }
210 
211 std::ostream& operator<< (std::ostream& os, const Mac16Address & address);
212 std::istream& operator>> (std::istream& is, Mac16Address & address);
213 
214 } // namespace ns3
215 
216 #endif /* MAC16_ADDRESS_H */
friend std::istream & operator>>(std::istream &is, Mac16Address &address)
Stream extraction operator.
std::istream & operator>>(std::istream &is, Angles &a)
initialize a struct Angles from input
Definition: angles.cc:48
bool IsBroadcast(void) const
Checks if the address is a broadcast address according to 802.15.4 scheme (i.e., 0xFFFF).
uint8_t m_address[2]
address value
static Mac16Address ConvertFrom(const Address &address)
Address ConvertTo(void) const
void CopyFrom(const uint8_t buffer[2])
void CopyTo(uint8_t buffer[2]) const
a polymophic address class
Definition: address.h:90
bool operator<(const EventId &a, const EventId &b)
Definition: event-id.h:153
static uint8_t GetType(void)
Return the Type of address.
friend bool operator<(const Mac16Address &a, const Mac16Address &b)
Less than operator.
std::ostream & operator<<(std::ostream &os, const Angles &a)
print a struct Angles to output
Definition: angles.cc:42
friend bool operator!=(const Mac16Address &a, const Mac16Address &b)
Not equal to operator.
static Mac16Address GetBroadcast(void)
friend std::ostream & operator<<(std::ostream &os, const Mac16Address &address)
Stream insertion operator.
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.
address
Definition: first.py:37
This class can contain 16 bit addresses.
Definition: mac16-address.h:41
friend bool operator==(const Mac16Address &a, const Mac16Address &b)
Equal to operator.
bool IsMulticast(void) const
Checks if the address is a multicast address according to RFC 4944 Section 9 (i.e., if its first 3 bits are 100).
Describes an IPv6 address.
Definition: ipv6-address.h:49
bool operator==(const EventId &a, const EventId &b)
Definition: event-id.h:135
static Mac16Address GetMulticast(Ipv6Address address)
Returns the multicast address associated with an IPv6 address according to RFC 4944 Section 9...
static bool IsMatchingType(const Address &address)
static Mac16Address Allocate(void)
Allocate a new Mac16Address.
#define ATTRIBUTE_HELPER_HEADER(type)
Declare the attribute value, accessor and checkers for class type.