Implements a sender application generating packets following a periodic point process. More...

#include "periodic-sender.h"

Inheritance diagram for ns3::lorawan::PeriodicSender:

Collaboration diagram for ns3::lorawan::PeriodicSender:

Public Member Functions
	PeriodicSender ()
	Default constructor.

	~PeriodicSender () override
	Destructor.

Time	GetInterval () const
	Get the sending interval.

void	SendPacket ()
	Send a packet using the LoraNetDevice's Send method.

void	SetInitialDelay (Time delay)
	Set the initial delay of this application.

void	SetInterval (Time interval)
	Set the sending interval.

void	SetPacketSize (uint8_t size)
	Set packet size.

void	SetPacketSizeRandomVariable (Ptr< RandomVariableStream > rv)
	Set to add randomness to the base packet size.

void	StartApplication () override
	Start the application by scheduling the first SendPacket event.

void	StopApplication () override
	Stop the application.

Public Member Functions inherited from ns3::Application
	Application ()

	~Application () override

virtual int64_t	AssignStreams (int64_t stream)
	Assign a fixed random variable stream number to the random variables used by this Application object.

Ptr< Node >	GetNode () const

void	SetNode (Ptr< Node > node)

void	SetStartTime (Time start)
	Specify application start time.

void	SetStopTime (Time stop)
	Specify application stop time.

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

virtual TypeId	GetInstanceTypeId () const =0
	Get the most derived TypeId for this Object.

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::Application
static TypeId	GetTypeId ()
	Get the type ID.

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
uint8_t	m_basePktSize
	The packet size.

Time	m_initialDelay
	The initial delay of this application.

Time	m_interval
	The interval between to consecutive send events.

Ptr< LorawanMac >	m_mac
	The MAC layer of this node.

Ptr< RandomVariableStream >	m_pktSizeRV
	The random variable that adds bytes to the packet size.

EventId	m_sendEvent
	The sending event scheduled as next.

Additional Inherited Members
Public Types inherited from ns3::Application
typedef void(*	DelayAddressCallback) (const Time &delay, const Address &from)
	Common callback signature for packet delay and address.

typedef void(*	StateTransitionCallback) (const std::string &oldState, const std::string &newState)
	Common signature used by callbacks to application's state transition trace source.

Protected Member Functions inherited from ns3::Application
void	DoDispose () override
	Destructor implementation.

void	DoInitialize () override
	Initialize() implementation.

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::Application
Ptr< Node >	m_node
	The node that this application is installed on.

EventId	m_startEvent
	The event that will fire at m_startTime to start the application.

Time	m_startTime
	The simulation time that the application will start.

EventId	m_stopEvent
	The event that will fire at m_stopTime to end the application.

Time	m_stopTime
	The simulation time that the application will end.

Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

Detailed Description

Implements a sender application generating packets following a periodic point process.

Definition at line 39 of file periodic-sender.h.

Constructor & Destructor Documentation

◆ PeriodicSender()

ns3::lorawan::PeriodicSender::PeriodicSender ( )

Default constructor.

Definition at line 59 of file periodic-sender.cc.

References NS_LOG_FUNCTION_NOARGS.

◆ ~PeriodicSender()

ns3::lorawan::PeriodicSender::~PeriodicSender ( )

override

Destructor.

Definition at line 69 of file periodic-sender.cc.

References NS_LOG_FUNCTION_NOARGS.

Member Function Documentation

◆ GetInterval()

Time ns3::lorawan::PeriodicSender::GetInterval ( ) const

Get the sending interval.

Returns: The interval between two packet sends.

Definition at line 82 of file periodic-sender.cc.

References m_interval, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::lorawan::PeriodicSender::GetTypeId ( )

static

Register this type.

Returns: The object TypeId.

Definition at line 39 of file periodic-sender.cc.

References GetInterval(), ns3::MakeTimeAccessor(), ns3::MakeTimeChecker(), ns3::Seconds(), SetInterval(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ SendPacket()

void ns3::lorawan::PeriodicSender::SendPacket ( )

Send a packet using the LoraNetDevice's Send method.

Definition at line 108 of file periodic-sender.cc.

References ns3::RandomVariableStream::GetInteger(), m_basePktSize, m_interval, m_mac, m_pktSizeRV, m_sendEvent, NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::Simulator::Schedule(), and SendPacket().

Referenced by SendPacket(), and StartApplication().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetInitialDelay()

void ns3::lorawan::PeriodicSender::SetInitialDelay ( Time delay )

Set the initial delay of this application.

Parameters

delay The initial delay value.

Definition at line 89 of file periodic-sender.cc.

References m_initialDelay, and NS_LOG_FUNCTION.

◆ SetInterval()

void ns3::lorawan::PeriodicSender::SetInterval ( Time interval )

Set the sending interval.

Parameters

interval The interval between two packet send instances.

Definition at line 75 of file periodic-sender.cc.

References m_interval, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ SetPacketSize()

void ns3::lorawan::PeriodicSender::SetPacketSize ( uint8_t size )

Set packet size.

Parameters

size	The base packet size value in bytes.

Definition at line 102 of file periodic-sender.cc.

References m_basePktSize.

◆ SetPacketSizeRandomVariable()

void ns3::lorawan::PeriodicSender::SetPacketSizeRandomVariable ( Ptr< RandomVariableStream > rv )

Set to add randomness to the base packet size.

On each call to SendPacket(), an integer number is picked from a random variable. That integer number is then added to the base packet size to create the new packet.

Parameters

rv	The random variable used to extract the additional number of packet bytes. Extracted values can be negative, but if they are lower than the base packet size they produce a runtime error. This check is left to the caller during definition of the random variable.

Definition at line 96 of file periodic-sender.cc.

References m_pktSizeRV.

◆ StartApplication()

void ns3::lorawan::PeriodicSender::StartApplication ( )

overridevirtual

Start the application by scheduling the first SendPacket event.

Reimplemented from ns3::Application.

Definition at line 132 of file periodic-sender.cc.

References ns3::Simulator::Cancel(), ns3::Node::GetDevice(), ns3::Time::GetSeconds(), ns3::EventId::GetUid(), m_initialDelay, m_mac, ns3::Application::m_node, m_sendEvent, NS_ASSERT, NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::Simulator::Schedule(), and SendPacket().

Here is the call graph for this function:

◆ StopApplication()

void ns3::lorawan::PeriodicSender::StopApplication ( )

overridevirtual

Stop the application.

Reimplemented from ns3::Application.

Definition at line 155 of file periodic-sender.cc.

References ns3::Simulator::Cancel(), m_sendEvent, and NS_LOG_FUNCTION_NOARGS.

Here is the call graph for this function:

Member Data Documentation

◆ m_basePktSize

uint8_t ns3::lorawan::PeriodicSender::m_basePktSize

private

The packet size.

Definition at line 112 of file periodic-sender.h.

Referenced by SendPacket(), and SetPacketSize().

◆ m_initialDelay

Time ns3::lorawan::PeriodicSender::m_initialDelay

private

The initial delay of this application.

Definition at line 109 of file periodic-sender.h.

Referenced by SetInitialDelay(), and StartApplication().

◆ m_interval

Time ns3::lorawan::PeriodicSender::m_interval

private

The interval between to consecutive send events.

Definition at line 108 of file periodic-sender.h.

Referenced by GetInterval(), SendPacket(), and SetInterval().

◆ m_mac

Ptr<LorawanMac> ns3::lorawan::PeriodicSender::m_mac

private

The MAC layer of this node.

Definition at line 111 of file periodic-sender.h.

Referenced by SendPacket(), and StartApplication().

◆ m_pktSizeRV

Ptr<RandomVariableStream> ns3::lorawan::PeriodicSender::m_pktSizeRV

private

The random variable that adds bytes to the packet size.

Definition at line 114 of file periodic-sender.h.

Referenced by SendPacket(), and SetPacketSizeRandomVariable().

◆ m_sendEvent

EventId ns3::lorawan::PeriodicSender::m_sendEvent

private

The sending event scheduled as next.

Definition at line 110 of file periodic-sender.h.

Referenced by SendPacket(), StartApplication(), and StopApplication().

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

src/lorawan/model/periodic-sender.h
src/lorawan/model/periodic-sender.cc

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PeriodicSender()

◆ ~PeriodicSender()

Member Function Documentation

◆ GetInterval()

◆ GetTypeId()

◆ SendPacket()

◆ SetInitialDelay()

◆ SetInterval()

◆ SetPacketSize()

◆ SetPacketSizeRandomVariable()

◆ StartApplication()

◆ StopApplication()

Member Data Documentation

◆ m_basePktSize

◆ m_initialDelay

◆ m_interval

◆ m_mac

◆ m_pktSizeRV

◆ m_sendEvent