This control message is used to give time, power and frequency correction to UTs. More...

#include "satellite-control-message.h"

Inheritance diagram for ns3::SatCmtMessage:

Collaboration diagram for ns3::SatCmtMessage:

Public Member Functions
	SatCmtMessage ()
	Constructor for SatCmtMessage. More...

	~SatCmtMessage ()
	Destructor for SatCmtMessage. More...

int16_t	GetBurstTimeCorrection () const
	Get the burst time correction. More...

int16_t	GetFrequencyCorrection () const
	Get the frequency correction. More...

uint8_t	GetGroupId () const
	Get the group ID. More...

virtual TypeId	GetInstanceTypeId (void) const
	Get the type ID of instance. More...

uint8_t	GetLogonId () const
	Get the logon ID. More...

SatControlMsgTag::SatControlMsgType_t	GetMsgType () const
	Get type of the message. More...

uint8_t	GetPowerCorrection () const
	Get the powercorrection. More...

virtual uint32_t	GetSizeInBytes () const
	Get real size of the message. More...

void	SetBurstTimeCorrection (int32_t burstTimeCorrection)
	Set the burst time correction. More...

void	SetFrequencyCorrection (int16_t frequencyCorrection)
	Set the frequency correction. More...

void	SetGroupId (uint8_t groupId)
	Set the group ID. More...

void	SetLogonId (uint8_t logonId)
	Set the logon ID. More...

void	SetPowerCorrection (uint8_t powerCorrection)
	Set the power correction. More...

Public Member Functions inherited from ns3::SatControlMessage
	SatControlMessage ()
	Default constructor for SatControlMessage. More...

	~SatControlMessage ()
	Destructor. More...

Static Public Member Functions
static TypeId	GetTypeId (void)
	methods derived from base classes More...

Static Public Member Functions inherited from ns3::SatControlMessage
static TypeId	GetTypeId (void)
	methods derived from base classes More...

Private Attributes
int8_t	m_burstTimeCorrection

uint8_t	m_burstTimeScaling

int16_t	m_frequencyCorrection

uint8_t	m_groupId

uint8_t	m_logonId

uint8_t	m_powerCorrection

Detailed Description

This control message is used to give time, power and frequency correction to UTs.

Flags are not used here, if no information is needed for a field, leave it to zero.

Definition at line 1215 of file satellite-control-message.h.

Constructor & Destructor Documentation

◆ SatCmtMessage()

ns3::SatCmtMessage::SatCmtMessage ( )

Constructor for SatCmtMessage.

Definition at line 1056 of file satellite-control-message.cc.

◆ ~SatCmtMessage()

ns3::SatCmtMessage::~SatCmtMessage ( )

Destructor for SatCmtMessage.

Definition at line 1067 of file satellite-control-message.cc.

Member Function Documentation

◆ GetBurstTimeCorrection()

int16_t ns3::SatCmtMessage::GetBurstTimeCorrection ( ) const

Get the burst time correction.

Returns: The burst time correction

Definition at line 1097 of file satellite-control-message.cc.

References m_burstTimeCorrection, and m_burstTimeScaling.

◆ GetFrequencyCorrection()

int16_t ns3::SatCmtMessage::GetFrequencyCorrection ( ) const

Get the frequency correction.

Returns: The frequency correction

Definition at line 1155 of file satellite-control-message.cc.

References m_frequencyCorrection.

◆ GetGroupId()

uint8_t ns3::SatCmtMessage::GetGroupId ( ) const

Get the group ID.

Returns: The group ID

Definition at line 1073 of file satellite-control-message.cc.

References m_groupId.

◆ GetInstanceTypeId()

TypeId ns3::SatCmtMessage::GetInstanceTypeId ( void ) const

virtual

Get the type ID of instance.

Returns: the object TypeId

Definition at line 1049 of file satellite-control-message.cc.

References GetTypeId().

Here is the call graph for this function:

◆ GetLogonId()

uint8_t ns3::SatCmtMessage::GetLogonId ( ) const

Get the logon ID.

Returns: The logon ID

Definition at line 1085 of file satellite-control-message.cc.

References m_logonId.

◆ GetMsgType()

SatControlMsgTag::SatControlMsgType_t ns3::SatCmtMessage::GetMsgType ( void ) const

inlinevirtual

Get type of the message.

Returns: SatControlMsgTag::SAT_CMT_CTRL_MSG

Implements ns3::SatControlMessage.

Definition at line 1244 of file satellite-control-message.h.

References ns3::SatControlMsgTag::SAT_CMT_CTRL_MSG.

◆ GetPowerCorrection()

uint8_t ns3::SatCmtMessage::GetPowerCorrection ( ) const

Get the powercorrection.

Information of power control flag is the MSB of the result. The 7 remaining bits are the power correction (if flag is 1) or EsN0 (otherwise).

Returns: The power correction

Definition at line 1143 of file satellite-control-message.cc.

References m_powerCorrection.

◆ GetSizeInBytes()

uint32_t ns3::SatCmtMessage::GetSizeInBytes ( ) const

virtual

Get real size of the message.

Returns: Real size of the message.

Implements ns3::SatControlMessage.

Definition at line 1167 of file satellite-control-message.cc.

◆ GetTypeId()

TypeId ns3::SatCmtMessage::GetTypeId ( void )

static

methods derived from base classes

Definition at line 1041 of file satellite-control-message.cc.

Referenced by GetInstanceTypeId().

Here is the caller graph for this function:

◆ SetBurstTimeCorrection()

void ns3::SatCmtMessage::SetBurstTimeCorrection ( int32_t burstTimeCorrection )

Set the burst time correction.

Parameters

burstTimeCorrection The burst time correction

Definition at line 1103 of file satellite-control-message.cc.

References m_burstTimeCorrection, and m_burstTimeScaling.

◆ SetFrequencyCorrection()

void ns3::SatCmtMessage::SetFrequencyCorrection ( int16_t frequencyCorrection )

Set the frequency correction.

Parameters

frequencyCorrection The frequency correction

Definition at line 1161 of file satellite-control-message.cc.

References m_frequencyCorrection.

◆ SetGroupId()

void ns3::SatCmtMessage::SetGroupId ( uint8_t groupId )

Set the group ID.

Parameters

groupId The group ID

Definition at line 1079 of file satellite-control-message.cc.

References m_groupId.

◆ SetLogonId()

void ns3::SatCmtMessage::SetLogonId ( uint8_t logonId )

Set the logon ID.

Parameters

logonId The logon ID

Definition at line 1091 of file satellite-control-message.cc.

References m_logonId.

◆ SetPowerCorrection()

void ns3::SatCmtMessage::SetPowerCorrection ( uint8_t powerCorrection )

Set the power correction.

Parameters

powerCorrection The power correction. Information of power control flag is the MSB of the parameter. The 7 remaining bits are the power correction (if flag is 1) or EsN0 (otherwise).

Definition at line 1149 of file satellite-control-message.cc.

References m_powerCorrection.