Implementation of the DutyCycleReq LoRaWAN MAC command. More...
#include "mac-command.h"
Public Member Functions | |
DutyCycleReq () | |
DutyCycleReq (uint8_t dutyCycle) | |
Constructor providing initialization of all parameters. | |
uint8_t | Deserialize (Buffer::Iterator &start) override |
Deserialize the buffer into a MAC command. | |
double | GetMaximumAllowedDutyCycle () const |
Get the maximum duty cycle prescribed by this Mac command, in fraction form. | |
void | Print (std::ostream &os) const override |
Print the contents of this MAC command in human-readable format. | |
void | Serialize (Buffer::Iterator &start) const override |
Serialize the contents of this MAC command into a buffer, according to the LoRaWAN standard. | |
Public Member Functions inherited from ns3::lorawan::MacCommand | |
MacCommand () | |
Default constructor. | |
~MacCommand () override | |
Destructor. | |
virtual enum MacCommandType | GetCommandType () const |
Get the commandType of this MAC command. | |
virtual uint8_t | GetSerializedSize () const |
Get serialized length of this MAC command. | |
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< Object > | GetObject () 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< Object > | GetObject (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. | |
SimpleRefCount & | operator= (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. | |
Private Attributes | |
uint8_t | m_maxDCycle |
The MaxDutyCycle field. | |
Additional Inherited Members | |
Static Public Member Functions inherited from ns3::lorawan::MacCommand | |
static uint8_t | GetCIDFromMacCommand (enum MacCommandType commandType) |
Get the CID that corresponds to a type of MAC command. | |
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. | |
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. | |
Protected Attributes inherited from ns3::lorawan::MacCommand | |
enum MacCommandType | m_commandType |
The type of this command. | |
uint8_t | m_serializedSize |
This MAC command's serialized size. | |
Related Symbols inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. | |
Implementation of the DutyCycleReq LoRaWAN MAC command.
With this command, the network server can limit the maximum aggregated transmit duty cycle of an end device. The aggregate duty cycle is computed as the duty cycle among all sub bands.
Definition at line 319 of file mac-command.h.
ns3::lorawan::DutyCycleReq::DutyCycleReq | ( | ) |
Definition at line 432 of file mac-command.cc.
References ns3::lorawan::DUTY_CYCLE_REQ, ns3::lorawan::MacCommand::m_commandType, ns3::lorawan::MacCommand::m_serializedSize, and NS_LOG_FUNCTION.
ns3::lorawan::DutyCycleReq::DutyCycleReq | ( | uint8_t | dutyCycle | ) |
Constructor providing initialization of all parameters.
dutyCycle | The duty cycle as a 8-bit unsigned integer. |
Definition at line 440 of file mac-command.cc.
References ns3::lorawan::DUTY_CYCLE_REQ, ns3::lorawan::MacCommand::m_commandType, ns3::lorawan::MacCommand::m_serializedSize, and NS_LOG_FUNCTION.
|
overridevirtual |
Deserialize the buffer into a MAC command.
start | A pointer to the buffer that contains the serialized command. |
Implements ns3::lorawan::MacCommand.
Definition at line 460 of file mac-command.cc.
References m_maxDCycle, ns3::lorawan::MacCommand::m_serializedSize, and NS_LOG_FUNCTION_NOARGS.
double ns3::lorawan::DutyCycleReq::GetMaximumAllowedDutyCycle | ( | ) | const |
Get the maximum duty cycle prescribed by this Mac command, in fraction form.
Definition at line 482 of file mac-command.cc.
References m_maxDCycle, and NS_LOG_FUNCTION.
Referenced by Print().
|
overridevirtual |
Print the contents of this MAC command in human-readable format.
os | The std::ostream instance on which to print the MAC command. |
Implements ns3::lorawan::MacCommand.
Definition at line 472 of file mac-command.cc.
References GetMaximumAllowedDutyCycle(), m_maxDCycle, and NS_LOG_FUNCTION_NOARGS.
|
overridevirtual |
Serialize the contents of this MAC command into a buffer, according to the LoRaWAN standard.
start | A pointer to the buffer into which to serialize the command. |
Implements ns3::lorawan::MacCommand.
Definition at line 450 of file mac-command.cc.
References ns3::lorawan::MacCommand::GetCIDFromMacCommand(), ns3::lorawan::MacCommand::m_commandType, m_maxDCycle, and NS_LOG_FUNCTION_NOARGS.
|
private |
The MaxDutyCycle field.
Definition at line 342 of file mac-command.h.
Referenced by Deserialize(), GetMaximumAllowedDutyCycle(), Print(), and Serialize().