ns3::SatTypedefs Class Reference

SatTypedefs class is for general typedefs used in satellite module. More...

#include "satellite-typedefs.h"

Public Types
typedef Callback< double, SatEnums::ChannelType_t, uint32_t, SatEnums::CarrierBandwidthType_t >	CarrierBandwidthConverter_t
	Callback for carrier bandwidths. More...
typedef void(*	CreationCallback) (std::string trace)
	Common callback signature for scenario creation trace sources by helpers. More...
typedef void(*	DataSenderAddressCallback) (uint32_t data, const Address &sourceAddress)
typedef void(*	PacketDelayAddressCallback) (const Time &delay, const Address &sourceAddress)
	Common callback signature for packet delay and address. More...
typedef void(*	PacketDestinationAddressCallback) (Ptr< const Packet > packet, const Address &destinationAddress)
	Common callback signature of a packet and a destination address. More...
typedef void(*	PacketSenderAddressCallback) (Ptr< const Packet > packet, const Address &sourceAddress)
	Common callback signature of a packet and a source address. More...
typedef void(*	PacketTraceCallback) (Time now, SatEnums::SatPacketEvent_t eventType, SatEnums::SatNodeType_t nodeType, uint32_t nodeId, Mac48Address nodeMacAddress, SatEnums::SatLogLevel_t logLevel, SatEnums::SatLinkDir_t linkDirection, std::string packetInfo)
	Common callback signature for PacketTrace trace sources. More...
typedef void(*	ServiceTimeCallback) (Time serviceTime)

Private Member Functions
virtual	~SatTypedefs ()=0
	Destructor. More...

Detailed Description

SatTypedefs class is for general typedefs used in satellite module.

Definition at line 45 of file satellite-typedefs.h.

Member Typedef Documentation

CarrierBandwidthConverter_t

typedef Callback<double, SatEnums::ChannelType_t, uint32_t, SatEnums::CarrierBandwidthType_t> ns3::SatTypedefs::CarrierBandwidthConverter_t

Callback for carrier bandwidths.

Parameters

channelType	The type of the channel
carrierId	The id of the carrier
bandwidthType	The type of the bandwidth

Returns

The bandwidth of the carrier.

Definition at line 57 of file satellite-typedefs.h.

CreationCallback

typedef void(* ns3::SatTypedefs::CreationCallback) (std::string trace)

Common callback signature for scenario creation trace sources by helpers.

Parameters

trace

textual description of the creation being done

Definition at line 112 of file satellite-typedefs.h.

DataSenderAddressCallback

typedef void(* ns3::SatTypedefs::DataSenderAddressCallback) (uint32_t data, const Address &sourceAddress)

Definition at line 116 of file satellite-typedefs.h.

PacketDelayAddressCallback

typedef void(* ns3::SatTypedefs::PacketDelayAddressCallback) (const Time &delay, const Address &sourceAddress)

Common callback signature for packet delay and address.

Parameters

delay	the packet delay
sourceAddress	the source address

Definition at line 80 of file satellite-typedefs.h.

PacketDestinationAddressCallback

typedef void(* ns3::SatTypedefs::PacketDestinationAddressCallback) (Ptr< const Packet > packet, const Address &destinationAddress)

Common callback signature of a packet and a destination address.

Parameters

packet	the packet
destinationAddress	the destination address

Definition at line 64 of file satellite-typedefs.h.

PacketSenderAddressCallback

typedef void(* ns3::SatTypedefs::PacketSenderAddressCallback) (Ptr< const Packet > packet, const Address &sourceAddress)

Common callback signature of a packet and a source address.

Parameters

packet	the packet
sourceAddress	the source address

Definition at line 72 of file satellite-typedefs.h.

PacketTraceCallback

typedef void(* ns3::SatTypedefs::PacketTraceCallback) (Time now, SatEnums::SatPacketEvent_t eventType, SatEnums::SatNodeType_t nodeType, uint32_t nodeId, Mac48Address nodeMacAddress, SatEnums::SatLogLevel_t logLevel, SatEnums::SatLinkDir_t linkDirection, std::string packetInfo)

Common callback signature for PacketTrace trace sources.

Parameters

now	the current simulation time
eventType	the type of this trace e.g., PACKET_SENT, PACKET_RECV, PACKET_ENQUE, or PACKET_DROP
nodeType	the type of the node where the event occured, e.g., NT_UT, NT_SAT, NT_GW, NT_NCC, or NT_TER
nodeId	the identifier of the node where the event occured
nodeMacAddress	the MAC address of the node where the event occured
logLevel	the log level used
linkDirection	link direction, e.g., LD_FORWARD or LD_RETURN
packetInfo	packet information in std::string for printing purpose, typically contains the packet's Uid, source address, and destination address

Todo:

Use const-reference for Time argument.

Definition at line 98 of file satellite-typedefs.h.

ServiceTimeCallback

typedef void(* ns3::SatTypedefs::ServiceTimeCallback) (Time serviceTime)

Definition at line 114 of file satellite-typedefs.h.

Constructor & Destructor Documentation

~SatTypedefs()

virtual ns3::SatTypedefs::~SatTypedefs ( )

privatepure virtual

Destructor.

Made Pure Virtual because the class is not planned be instantiated or inherited

---

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

• /builds/sns3/satellite/satellite/model/satellite-typedefs.h