ns3::UanMac Class Reference

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
virtual void	AttachPhy (Ptr< UanPhy > phy)=0
virtual void	Clear (void)=0
virtual bool	Enqueue (Ptr< Packet > pkt, const Address &dest, uint16_t protocolNumber)=0
virtual Address	GetAddress (void)=0
virtual Address	GetBroadcast (void) const =0
virtual void	SetAddress (UanAddress addr)=0
virtual void	SetForwardUpCb (Callback< void, Ptr< Packet >, const UanAddress & > cb)=0
Public Member Functions inherited from ns3::Object
	Object ()
virtual	~Object ()
void	AggregateObject (Ptr< Object > other)
void	Dispose (void)
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	Start (void)
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	SimpleRefCount (const SimpleRefCount &o)
uint32_t	GetReferenceCount (void) const
SimpleRefCount &	operator= (const SimpleRefCount &o)
void	Ref (void) const
void	Unref (void) const
Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
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)
	This method returns the TypeId associated to ns3::UanMac.

Additional Inherited Members
Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
virtual void	DoDispose (void)
virtual void	DoStart (void)
virtual void	NotifyNewAggregate (void)

Detailed Description

Virtual base class for all UAN MAC protocols.

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

stream

first 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.

Referenced by ns3::UanHelper::AssignStreams().

Here is the caller graph for this function:

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

phy	Phy layer to attach to this MAC

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

Referenced by ns3::UanNetDevice::SetMac(), and ns3::UanNetDevice::SetPhy().

Here is the caller graph for this function:

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

pure virtual

Clears all pointer references

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

Referenced by ns3::UanNetDevice::Clear(), and ns3::UanPhyGen::Clear().

Here is the caller graph for this function:

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

pure virtual

Enqueue packet to be transmitted

Parameters

pkt	Packet to be transmitted
dest	Destination address
protocolNumber	Protocol #. Usage varies by MAC

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

Referenced by ns3::UanNetDevice::Send().

Here is the caller graph for this function:

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

pure virtual

Returns

MAC Address

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

Referenced by ns3::UanNetDevice::GetAddress(), ns3::UanPhyGen::SendPacket(), and ns3::UanPhyGen::StartRxPacket().

Here is the caller graph for this function:

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

pure virtual

Returns

Broadcast address

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

Referenced by ns3::UanNetDevice::GetBroadcast(), and ns3::UanNetDevice::GetMulticast().

Here is the caller graph for this function:

TypeId ns3::UanMac::GetTypeId ( void  )

static

This method returns the TypeId associated to ns3::UanMac.

This object is accessible through the following paths with Config::Set and Config::Connect:

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

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

Reimplemented from ns3::Object.

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

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

Parameters

addr	UanAddress for this MAC

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

Referenced by ns3::UanNetDevice::SetAddress().

Here is the caller graph for this function:

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

pure virtual

Parameters

cb	Callback to be called when a packet is forwarded up to higher layer

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

Referenced by ns3::UanNetDevice::SetMac().

Here is the caller graph for this function:

---

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

• src/uan/model/uan-mac.h
• doc/introspected-doxygen.h
• src/uan/model/uan-mac.cc