A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ns3::UanMac Class Referenceabstract

Virtual base class for all UAN MAC protocols. More...

#include <uan-mac.h>

+ Inheritance diagram for ns3::UanMac:
+ Collaboration diagram for ns3::UanMac:

Public Member Functions

virtual int64_t AssignStreams (int64_t stream)=0
 Assign a fixed random variable stream number to the random variables used by this model. More...
 
virtual void AttachPhy (Ptr< UanPhy > phy)=0
 Attach PHY layer to this MAC. More...
 
virtual void Clear (void)=0
 Clears all pointer references. More...
 
virtual bool Enqueue (Ptr< Packet > pkt, const Address &dest, uint16_t protocolNumber)=0
 Enqueue packet to be transmitted. More...
 
virtual Address GetAddress (void)=0
 Get the MAC Address. More...
 
virtual Address GetBroadcast (void) const =0
 Get the broadcast address. More...
 
virtual void SetAddress (UanAddress addr)=0
 Set the address. More...
 
virtual void SetForwardUpCb (Callback< void, Ptr< Packet >, const UanAddress & > cb)=0
 Set the callback to forward packets up to higher layers. More...
 
- Public Member Functions inherited from ns3::Object
 Object ()
 
virtual ~Object ()
 
void AggregateObject (Ptr< Object > other)
 
void Dispose (void)
 Run the DoDispose methods of this object and all the objects aggregated to it. More...
 
AggregateIterator GetAggregateIterator (void) const
 
virtual TypeId GetInstanceTypeId (void) const
 
template<typename T >
Ptr< T > GetObject (void) const
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 
void Initialize (void)
 This method calls the virtual DoInitialize method on all the objects aggregated to this object. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment. More...
 
void Ref (void) const
 Increment the reference count. More...
 
void Unref (void) const
 Decrement the reference count. More...
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor. More...
 
void GetAttribute (std::string name, AttributeValue &value) const
 
bool GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
 
void SetAttribute (std::string name, const AttributeValue &value)
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 

Static Public Member Functions

static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void Cleanup (void)
 Noop. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 
virtual void DoDispose (void)
 This method is called by Object::Dispose or by the object's destructor, whichever comes first. More...
 
virtual void DoInitialize (void)
 This method is called only once by Object::Initialize. More...
 
virtual void NotifyNewAggregate (void)
 This method is invoked whenever two sets of objects are aggregated together. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 This method is invoked once all member attributes have been initialized. More...
 

Detailed Description

Virtual base class for all UAN MAC protocols.

Config Paths

ns3::UanMac is accessible through the following paths with Config::Set and Config::Connect:

  • /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Mac

No Attributes are defined for this type.
No TraceSources are defined for this type.

Definition at line 47 of file uan-mac.h.

Member Function Documentation

virtual int64_t ns3::UanMac::AssignStreams ( int64_t  stream)
pure virtual

Assign a fixed random variable stream number to the random variables used by this model.

Return the number of streams (possibly zero) that have been assigned.

Parameters
streamFirst stream index to use.
Returns
The number of stream indices assigned by this model.

Implemented in ns3::UanMacRc, ns3::UanMacCw, ns3::UanMacRcGw, and ns3::UanMacAloha.

virtual void ns3::UanMac::AttachPhy ( Ptr< UanPhy phy)
pure virtual

Attach PHY layer to this MAC.

Some MACs may be designed to work with multiple PHY layers. Others may only work with one.

Parameters
phyPhy layer to attach to this MAC.

Implemented in ns3::UanMacRc, ns3::UanMacCw, ns3::UanMacRcGw, and ns3::UanMacAloha.

virtual void ns3::UanMac::Clear ( void  )
pure virtual

Clears all pointer references.

Implemented in ns3::UanMacRc, ns3::UanMacCw, ns3::UanMacRcGw, and ns3::UanMacAloha.

virtual bool ns3::UanMac::Enqueue ( Ptr< Packet pkt,
const Address dest,
uint16_t  protocolNumber 
)
pure virtual

Enqueue packet to be transmitted.

Parameters
pktPacket to be transmitted.
destDestination address.
protocolNumberProtocol number. Usage varies by MAC.
Returns
True if packet was successfully enqueued.

Implemented in ns3::UanMacRc, ns3::UanMacCw, ns3::UanMacRcGw, and ns3::UanMacAloha.

virtual Address ns3::UanMac::GetAddress ( void  )
pure virtual

Get the MAC Address.

Returns
MAC Address.

Implemented in ns3::UanMacRc, ns3::UanMacCw, ns3::UanMacRcGw, and ns3::UanMacAloha.

virtual Address ns3::UanMac::GetBroadcast ( void  ) const
pure virtual

Get the broadcast address.

Returns
The broadcast address.

Implemented in ns3::UanMacRc, ns3::UanMacCw, ns3::UanMacRcGw, and ns3::UanMacAloha.

TypeId ns3::UanMac::GetTypeId ( void  )
static

Register this type.

Returns
The TypeId.

Definition at line 27 of file uan-mac.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

virtual void ns3::UanMac::SetAddress ( UanAddress  addr)
pure virtual

Set the address.

Parameters
addrUanAddress for this MAC.

Implemented in ns3::UanMacRc, ns3::UanMacCw, ns3::UanMacRcGw, and ns3::UanMacAloha.

virtual void ns3::UanMac::SetForwardUpCb ( Callback< void, Ptr< Packet >, const UanAddress & >  cb)
pure virtual

Set the callback to forward packets up to higher layers.

Parameters
cbThe callback. packet The packet. address The source address.

Implemented in ns3::UanMacRc, ns3::UanMacCw, ns3::UanMacRcGw, and ns3::UanMacAloha.


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