ns3::Ipv4Mask Class Reference
[Address]

a class to represent an Ipv4 address mask More...

#include <ipv4-address.h>

List of all members.

Public Member Functions

bool IsMatch (Ipv4Address a, Ipv4Address b) const
bool IsEqual (Ipv4Mask other) const
uint32_t Get (void) const
void Set (uint32_t mask)
uint32_t GetInverse (void) const
 Return the inverse mask in host order.
void Print (std::ostream &os) const
 Print this mask to the given output stream.

Static Public Member Functions

static Ipv4Mask GetLoopback (void)
static Ipv4Mask GetZero (void)
static Ipv4Mask GetOnes (void)


Detailed Description

a class to represent an Ipv4 address mask

Member Function Documentation

uint32_t ns3::Ipv4Mask::Get ( void   )  const

Get the host-order 32-bit IP mask

Returns:
the host-order 32-bit IP mask

static Ipv4Mask ns3::Ipv4Mask::GetLoopback ( void   )  [static]

Returns:
the 255.0.0.0 mask corresponding to a typical loopback address

static Ipv4Mask ns3::Ipv4Mask::GetOnes ( void   )  [static]

Returns:
the 255.255.255.255 mask

static Ipv4Mask ns3::Ipv4Mask::GetZero ( void   )  [static]

Returns:
the 0.0.0.0 mask

bool ns3::Ipv4Mask::IsEqual ( Ipv4Mask  other  )  const

Parameters:
other a mask to compare
Returns:
true if the mask equals the mask passed as input parameter

bool ns3::Ipv4Mask::IsMatch ( Ipv4Address  a,
Ipv4Address  b 
) const

Parameters:
a first address to compare
b second address to compare
Returns:
true if both addresses are equal in their masked bits, corresponding to this mask

void ns3::Ipv4Mask::Print ( std::ostream &  os  )  const

Print this mask to the given output stream.

The print format is in the typical "255.255.255.0"

Parameters:
os The output stream to which this Ipv4Address is printed

void ns3::Ipv4Mask::Set ( uint32_t  mask  ) 

input mask is in host order.

Parameters:
mask The host order 32-bit mask


The documentation for this class was generated from the following file:

Generated on Fri Apr 9 15:01:10 2010 for NS-3 by  doxygen 1.5.8