A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
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 Types

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

Public Member Functions

 UanMac ()
 Default constructor.
 
virtual int64_t AssignStreams (int64_t stream)=0
 Assign a fixed random variable stream number to the random variables used by this model.
 
virtual void AttachPhy (Ptr< UanPhy > phy)=0
 Attach PHY layer to this MAC.
 
virtual void Clear ()=0
 Clears all pointer references.
 
virtual bool Enqueue (Ptr< Packet > pkt, uint16_t protocolNumber, const Address &dest)=0
 Enqueue packet to be transmitted.
 
virtual Address GetAddress ()
 Get the MAC Address.
 
virtual Address GetBroadcast () const
 Get the broadcast address.
 
uint32_t GetTxModeIndex () const
 Get the Tx mode index (Modulation type).
 
virtual void SetAddress (Mac8Address addr)
 Set the address.
 
virtual void SetForwardUpCb (Callback< void, Ptr< Packet >, uint16_t, const Mac8Address & > cb)=0
 Set the callback to forward packets up to higher layers.
 
void SetTxModeIndex (uint32_t txModeIndex)
 Set the Tx mode index (Modulation type).
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor.
 
 ~Object () override
 Destructor.
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together.
 
void Dispose ()
 Dispose of this Object.
 
AggregateIterator GetAggregateIterator () const
 Get an iterator to the Objects aggregated to this one.
 
TypeId GetInstanceTypeId () const override
 Get the most derived TypeId for this Object.
 
template<typename T >
Ptr< T > GetObject () const
 Get a pointer to the requested aggregated Object.
 
template<>
Ptr< ObjectGetObject () const
 Specialization of () for objects of type ns3::Object.
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId.
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object.
 
void Initialize ()
 Invoke DoInitialize on all Objects aggregated to this one.
 
bool IsInitialized () const
 Check if the object has been initialized.
 
void UnidirectionalAggregateObject (Ptr< Object > other)
 Aggregate an Object to another Object.
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor.
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor.
 
uint32_t GetReferenceCount () const
 Get the reference count of the object.
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator.
 
void Ref () const
 Increment the reference count.
 
void Unref () const
 Decrement the reference count.
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor.
 
void GetAttribute (std::string name, AttributeValue &value, bool permissive=false) const
 Get the value of an attribute, raising fatal errors if unsuccessful.
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising errors.
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful.
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors.
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context.
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context.
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context.
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context.
 

Static Public Member Functions

static TypeId GetTypeId ()
 Register this type.
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId ()
 Register this type.
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId ()
 Get the type ID.
 

Private Attributes

Mac8Address m_address
 The MAC address.
 
uint32_t m_txModeIndex
 Modulation type.
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object.
 
virtual void DoDispose ()
 Destructor implementation.
 
virtual void DoInitialize ()
 Initialize() implementation.
 
virtual void NotifyNewAggregate ()
 Notify all Objects aggregated to this one of a new Object being aggregated.
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes.
 
virtual void NotifyConstructionCompleted ()
 Notifier called once the ObjectBase is fully constructed.
 

Detailed Description

Virtual base class for all UAN MAC protocols.

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

Member Typedef Documentation

◆ PacketModeTracedCallback

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

TracedCallback signature for packet reception/enqueue/dequeue events.

Parameters
[in]packetThe Packet.
[in]modeThe UanTxMode.

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

Constructor & Destructor Documentation

◆ UanMac()

ns3::UanMac::UanMac ( )

Default constructor.

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

Member Function Documentation

◆ AssignStreams()

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::UanMacAloha, ns3::UanMacCw, ns3::UanMacRc, and ns3::UanMacRcGw.

◆ AttachPhy()

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::UanMacAloha, ns3::UanMacCw, ns3::UanMacRc, and ns3::UanMacRcGw.

◆ Clear()

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

Clears all pointer references.

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

◆ Enqueue()

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

Enqueue packet to be transmitted.

Parameters
pktPacket to be transmitted.
destDestination address.
protocolNumberThe type of the packet.
Returns
True if packet was successfully enqueued.

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

◆ GetAddress()

◆ GetBroadcast()

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

Get the broadcast address.

Returns
The broadcast address.

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

◆ GetTxModeIndex()

uint32_t ns3::UanMac::GetTxModeIndex ( ) const

Get the Tx mode index (Modulation type).

Returns
the Tx mode index

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

References m_txModeIndex.

Referenced by ns3::UanMacAloha::Enqueue(), and ns3::UanMacCw::Enqueue().

+ Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::UanMac::GetTypeId ( )
static

Register this type.

Returns
The TypeId.

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

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ SetAddress()

void ns3::UanMac::SetAddress ( Mac8Address addr)
virtual

Set the address.

Parameters
addrMac8Address for this MAC.

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

References m_address.

◆ SetForwardUpCb()

virtual void ns3::UanMac::SetForwardUpCb ( Callback< void, Ptr< Packet >, uint16_t, const Mac8Address & > 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::UanMacAloha, ns3::UanMacCw, ns3::UanMacRc, and ns3::UanMacRcGw.

◆ SetTxModeIndex()

void ns3::UanMac::SetTxModeIndex ( uint32_t txModeIndex)

Set the Tx mode index (Modulation type).

Parameters
txModeIndexthe Tx mode index

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

References m_txModeIndex.

Member Data Documentation

◆ m_address

Mac8Address ns3::UanMac::m_address
private

The MAC address.

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

Referenced by GetAddress(), and SetAddress().

◆ m_txModeIndex

uint32_t ns3::UanMac::m_txModeIndex
private

Modulation type.

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

Referenced by GetTxModeIndex(), and SetTxModeIndex().


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