Packet sender application to send a single packet. More...

#include "one-shot-sender.h"

Inheritance diagram for ns3::lorawan::OneShotSender:

Collaboration diagram for ns3::lorawan::OneShotSender:

Public Member Functions
	OneShotSender ()
	Default constructor.

	OneShotSender (Time sendTime)
	Construct a new OneShotSender object with provided send time.

	~OneShotSender () override
	Destructor.

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

void	SetSendTime (Time sendTime)
	Set the time at which this app will send a packet.

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
Ptr< LorawanMac >	m_mac
	The MAC layer of this node.

EventId	m_sendEvent
	The sending event.

Time	m_sendTime
	The time at which to send the packet.

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

Packet sender application to send a single packet.

Definition at line 39 of file one-shot-sender.h.

Constructor & Destructor Documentation

◆ OneShotSender() [1/2]

ns3::lorawan::OneShotSender::OneShotSender ( )

Default constructor.

Definition at line 49 of file one-shot-sender.cc.

References NS_LOG_FUNCTION_NOARGS.

◆ ~OneShotSender()

ns3::lorawan::OneShotSender::~OneShotSender ( )

override

Destructor.

Definition at line 60 of file one-shot-sender.cc.

References NS_LOG_FUNCTION_NOARGS.

◆ OneShotSender() [2/2]

ns3::lorawan::OneShotSender::OneShotSender ( Time sendTime )

Construct a new OneShotSender object with provided send time.

Parameters

sendTime The Time of sending.

Definition at line 54 of file one-shot-sender.cc.

References NS_LOG_FUNCTION_NOARGS.

Member Function Documentation

◆ GetTypeId()

TypeId ns3::lorawan::OneShotSender::GetTypeId ( )

static

Register this type.

Returns: The object TypeId.

Definition at line 40 of file one-shot-sender.cc.

References ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ SendPacket()

void ns3::lorawan::OneShotSender::SendPacket ( )

Send a packet using the LoraNetDevice's Send method.

Definition at line 74 of file one-shot-sender.cc.

References m_mac, and NS_LOG_FUNCTION.

Referenced by StartApplication().

Here is the caller graph for this function:

◆ SetSendTime()

void ns3::lorawan::OneShotSender::SetSendTime ( Time sendTime )

Set the time at which this app will send a packet.

Parameters

sendTime The Time of sending.

Definition at line 66 of file one-shot-sender.cc.

References m_sendTime, and NS_LOG_FUNCTION.

◆ StartApplication()

void ns3::lorawan::OneShotSender::StartApplication ( )

overridevirtual

Start the application by scheduling the first SendPacket event.

Reimplemented from ns3::Application.

Definition at line 84 of file one-shot-sender.cc.

References ns3::Simulator::Cancel(), ns3::Node::GetDevice(), m_mac, ns3::Application::m_node, m_sendEvent, m_sendTime, NS_ASSERT, NS_LOG_FUNCTION, ns3::Simulator::Schedule(), and SendPacket().

Here is the call graph for this function:

◆ StopApplication()

void ns3::lorawan::OneShotSender::StopApplication ( )

overridevirtual

Stop the application.

Reimplemented from ns3::Application.

Definition at line 104 of file one-shot-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_mac

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

private

The MAC layer of this node.

Definition at line 83 of file one-shot-sender.h.

Referenced by SendPacket(), and StartApplication().

◆ m_sendEvent

EventId ns3::lorawan::OneShotSender::m_sendEvent

private

The sending event.

Definition at line 82 of file one-shot-sender.h.

Referenced by StartApplication(), and StopApplication().

◆ m_sendTime

Time ns3::lorawan::OneShotSender::m_sendTime

private

The time at which to send the packet.

Definition at line 81 of file one-shot-sender.h.

Referenced by SetSendTime(), and StartApplication().

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

src/lorawan/model/one-shot-sender.h
src/lorawan/model/one-shot-sender.cc

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OneShotSender() [1/2]

◆ ~OneShotSender()

◆ OneShotSender() [2/2]

Member Function Documentation

◆ GetTypeId()

◆ SendPacket()

◆ SetSendTime()

◆ StartApplication()

◆ StopApplication()

Member Data Documentation

◆ m_mac

◆ m_sendEvent

◆ m_sendTime