Virtual base class for all UAN MAC protocols. More...
#include "uan-mac.h"
Public Types | |
typedef void(* | PacketModeTracedCallback) (Ptr< const Packet > packet, UanTxMode mode) |
TracedCallback signature for packet reception/enqueue/dequeue events. More... | |
Public Member Functions | |
UanMac () | |
Default constructor. More... | |
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 ()=0 |
Clears all pointer references. More... | |
virtual bool | Enqueue (Ptr< Packet > pkt, uint16_t protocolNumber, const Address &dest)=0 |
Enqueue packet to be transmitted. More... | |
virtual Address | GetAddress () |
Get the MAC Address. More... | |
virtual Address | GetBroadcast () const |
Get the broadcast address. More... | |
uint32_t | GetTxModeIndex () const |
Get the Tx mode index (Modulation type). More... | |
virtual void | SetAddress (Mac8Address addr) |
Set the address. More... | |
virtual void | SetForwardUpCb (Callback< void, Ptr< Packet >, uint16_t, const Mac8Address & > cb)=0 |
Set the callback to forward packets up to higher layers. More... | |
void | SetTxModeIndex (uint32_t txModeIndex) |
Set the Tx mode index (Modulation type). More... | |
Public Member Functions inherited from ns3::Object | |
Object () | |
Constructor. More... | |
~Object () override | |
Destructor. More... | |
void | AggregateObject (Ptr< Object > other) |
Aggregate two Objects together. More... | |
void | Dispose () |
Dispose of this Object. More... | |
AggregateIterator | GetAggregateIterator () const |
Get an iterator to the Objects aggregated to this one. More... | |
TypeId | GetInstanceTypeId () const override |
Get the most derived TypeId for this Object. More... | |
template<typename T > | |
Ptr< T > | GetObject () const |
Get a pointer to the requested aggregated Object. More... | |
template<> | |
Ptr< Object > | GetObject () const |
Specialization of () for objects of type ns3::Object. More... | |
template<typename T > | |
Ptr< T > | GetObject (TypeId tid) const |
Get a pointer to the requested aggregated Object by TypeId. More... | |
template<> | |
Ptr< Object > | GetObject (TypeId tid) const |
Specialization of (TypeId tid) for objects of type ns3::Object. More... | |
void | Initialize () |
Invoke DoInitialize on all Objects aggregated to this one. More... | |
bool | IsInitialized () const |
Check if the object has been initialized. More... | |
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter > | |
SimpleRefCount () | |
Default constructor. More... | |
SimpleRefCount (const SimpleRefCount &o[[maybe_unused]]) | |
Copy constructor. More... | |
uint32_t | GetReferenceCount () const |
Get the reference count of the object. More... | |
SimpleRefCount & | operator= (const SimpleRefCount &o[[maybe_unused]]) |
Assignment operator. More... | |
void | Ref () const |
Increment the reference count. More... | |
void | Unref () 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 errors. 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 () |
Register this type. More... | |
Static Public Member Functions inherited from ns3::Object | |
static TypeId | GetTypeId () |
Register this type. More... | |
Static Public Member Functions inherited from ns3::ObjectBase | |
static TypeId | GetTypeId () |
Get the type ID. More... | |
Private Attributes | |
Mac8Address | m_address |
The MAC address. More... | |
uint32_t | m_txModeIndex |
Modulation type. More... | |
Additional Inherited Members | |
Protected Member Functions inherited from ns3::Object | |
Object (const Object &o) | |
Copy an Object. More... | |
virtual void | DoDispose () |
Destructor implementation. More... | |
virtual void | DoInitialize () |
Initialize() implementation. More... | |
virtual void | NotifyNewAggregate () |
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 () |
Notifier called once the ObjectBase is fully constructed. More... | |
Related Functions inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More... | |
TracedCallback signature for packet reception/enqueue/dequeue events.
ns3::UanMac::UanMac | ( | ) |
Default constructor.
Definition at line 27 of file uan-mac.cc.
|
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.
stream | First stream index to use. |
Implemented in ns3::UanMacRc, ns3::UanMacRcGw, ns3::UanMacCw, and ns3::UanMacAloha.
Attach PHY layer to this MAC.
Some MACs may be designed to work with multiple PHY layers. Others may only work with one.
phy | Phy layer to attach to this MAC. |
Implemented in ns3::UanMacRc, ns3::UanMacRcGw, ns3::UanMacCw, and ns3::UanMacAloha.
|
pure virtual |
Clears all pointer references.
Implemented in ns3::UanMacRc, ns3::UanMacRcGw, ns3::UanMacCw, and ns3::UanMacAloha.
|
pure virtual |
Enqueue packet to be transmitted.
pkt | Packet to be transmitted. |
dest | Destination address. |
protocolNumber | The type of the packet. |
Implemented in ns3::UanMacRc, ns3::UanMacRcGw, ns3::UanMacCw, and ns3::UanMacAloha.
|
virtual |
Get the MAC Address.
Definition at line 52 of file uan-mac.cc.
References m_address.
Referenced by ns3::UanMacRc::Associate(), ns3::UanMacRc::AssociateTimeout(), ns3::UanMacRcGw::EndCycle(), ns3::UanMacCw::EndTx(), ns3::UanMacAloha::Enqueue(), ns3::UanMacCw::Enqueue(), ns3::UanMacRc::IsPhy1Ok(), ns3::UanMacCw::NotifyCcaEnd(), ns3::UanMacCw::NotifyCcaStart(), ns3::UanMacCw::NotifyRxEndError(), ns3::UanMacCw::NotifyRxEndOk(), ns3::UanMacCw::NotifyRxStart(), ns3::UanMacCw::PhyRxPacketGood(), ns3::UanMacRc::ProcessAck(), ns3::UanMacRc::ReceiveOkFromPhy(), ns3::UanMacRcGw::ReceivePacket(), ns3::UanMacRc::RtsTimeout(), ns3::UanMacAloha::RxPacketError(), ns3::UanMacAloha::RxPacketGood(), ns3::UanMacCw::SaveTimer(), ns3::UanMacRc::ScheduleData(), ns3::UanMacCw::SendPacket(), ns3::UanMacRc::SendPacket(), ns3::UanMacRc::SendRts(), ns3::UanMacRcGw::StartCycle(), and ns3::UanMacCw::StartTimer().
|
virtual |
uint32_t ns3::UanMac::GetTxModeIndex | ( | ) | const |
Get the Tx mode index (Modulation type).
Definition at line 46 of file uan-mac.cc.
References m_txModeIndex.
Referenced by ns3::UanMacAloha::Enqueue(), and ns3::UanMacCw::Enqueue().
|
static |
Register this type.
Definition at line 33 of file uan-mac.cc.
References ns3::TypeId::SetParent().
|
virtual |
Set the address.
addr | Mac8Address for this MAC. |
Definition at line 58 of file uan-mac.cc.
References m_address.
|
pure virtual |
Set the callback to forward packets up to higher layers.
cb | The callback. packet The packet. address The source address. |
Implemented in ns3::UanMacRc, ns3::UanMacRcGw, ns3::UanMacCw, and ns3::UanMacAloha.
void ns3::UanMac::SetTxModeIndex | ( | uint32_t | txModeIndex | ) |
Set the Tx mode index (Modulation type).
txModeIndex | the Tx mode index |
Definition at line 40 of file uan-mac.cc.
References m_txModeIndex.
|
private |
The MAC address.
Definition at line 142 of file uan-mac.h.
Referenced by GetAddress(), and SetAddress().
|
private |
Modulation type.
Definition at line 140 of file uan-mac.h.
Referenced by GetTxModeIndex(), and SetTxModeIndex().