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

#include <uan-mac.h>

Inheritance diagram for ns3::UanMac:

Collaboration diagram for ns3::UanMac:

Public Types
typedef void(*	PacketModeTracedCallback) (const Ptr< const Packet > packet, const UanTxMode &mode)
	TracedCallback signature for packet reception/enqueue/dequeue events. More...

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 ()
	Constructor. More...

virtual	~Object ()
	Destructor. More...

void	AggregateObject (Ptr< Object > other)
	Aggregate two Objects together. More...

void	Dispose (void)
	Dispose of this Object. More...

AggregateIterator	GetAggregateIterator (void) const
	Get an iterator to the Objects aggregated to this one. More...

virtual TypeId	GetInstanceTypeId (void) const
	Implement the GetInstanceTypeId method defined in ObjectBase. More...

template<typename T >
Ptr< T >	GetObject (void) const
	Get a pointer to the requested aggregated Object. More...

template<typename T >
Ptr< T >	GetObject (TypeId tid) const
	Get a pointer to the requested aggregated Object. More...

void	Initialize (void)
	Invoke DoInitialize on all Objects aggregated to this one. 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...

SimpleRefCount &	operator= (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
	Get the value of an attribute, raising fatal errors if unsuccessful. More...

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising erros. More...

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful. More...

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors. More...

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context. More...

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context. More...

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context. More...

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context. More...

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)
	Copy an Object. More...

virtual void	DoDispose (void)
	Destructor implementation. More...

virtual void	DoInitialize (void)
	Initialize() implementation. More...

virtual void	NotifyNewAggregate (void)
	Notify all Objects aggregated to this one of a new Object being aggregated. More...

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes. More...

virtual void	NotifyConstructionCompleted (void)
	Notifier called once the ObjectBase is fully constructed. More...

Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid (void)
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. 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.
Size of this type is 32 bytes (on a 64-bit architecture).

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

Member Typedef Documentation

typedef void(* ns3::UanMac::PacketModeTracedCallback) (const Ptr< const Packet > packet, const UanTxMode &mode)

TracedCallback signature for packet reception/enqueue/dequeue events.

Parameters

[in]	packet	The Packet.
[in]	mode	The UanTxMode.

Definition at line 126 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.

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.

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

pkt	Packet to be transmitted.
dest	Destination address.
protocolNumber	Protocol 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

addr	UanAddress 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

cb	The 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:

src/uan/model/uan-mac.h
src/uan/model/uan-mac.cc

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Config Paths

Member Typedef Documentation

Member Function Documentation