Helper class used to craft the transmission options bitmap used by the APSDE-DATA.request. More...

#include "zigbee-aps.h"

Collaboration diagram for ns3::zigbee::ZigbeeApsTxOptions:

Public Member Functions
	ZigbeeApsTxOptions (uint8_t value=0)
	The constructor of the Tx options class.

uint8_t	GetTxOptions () const
	Get the complete bitmap containing the Tx options.

bool	IsAckRequired () const
	Show if the ACK bit of the Tx options is present.

bool	IsFragmentationPermitted () const
	Show if the fragmentation permitted bit of the Tx options is present.

bool	IsIncludeExtendedNonce () const
	Show if the include extended nonce bit of the Tx options is present.

bool	IsSecurityEnabled () const
	Show if the security enable bit of the Tx options is present.

bool	IsUseNwkKey () const
	Show if the use network key bit of the Tx options is present.

void	SetAckRequired (bool enable)
	Set the Acknowledgement required bit of the Tx options.

void	SetFragmentationPermitted (bool enable)
	Set the fragmentation bit of the Tx options.

void	SetIncludeExtendedNonce (bool enable)
	Set the include extended nonce bit of the Tx options.

void	SetSecurityEnabled (bool enable)
	Set the security enable bit of the TX options.

void	SetUseNwkKey (bool enable)
	Set the use network key bit of the TX options.

Private Member Functions
bool	GetBit (int pos) const
	Get the value of the bit at the position indicated.

void	SetBit (int pos, bool value)
	Set a bit value into a position in the uint8_t representint the Tx options.

Private Attributes
uint8_t	m_txOptions
	the bitmap representing the Tx options

Detailed Description

Helper class used to craft the transmission options bitmap used by the APSDE-DATA.request.

Definition at line 441 of file zigbee-aps.h.

Constructor & Destructor Documentation

◆ ZigbeeApsTxOptions()

ns3::zigbee::ZigbeeApsTxOptions::ZigbeeApsTxOptions ( uint8_t value = 0 )

The constructor of the Tx options class.

Parameters

value The value to set in the Tx options.

Definition at line 476 of file zigbee-aps.cc.

Member Function Documentation

◆ GetBit()

bool ns3::zigbee::ZigbeeApsTxOptions::GetBit ( int pos ) const

private

Get the value of the bit at the position indicated.

Parameters

pos	The position in the uint8_t Tx options

Returns: True if the bit value was obtained

Definition at line 561 of file zigbee-aps.cc.

References m_txOptions.

Referenced by IsAckRequired(), IsFragmentationPermitted(), IsIncludeExtendedNonce(), IsSecurityEnabled(), and IsUseNwkKey().

Here is the caller graph for this function:

◆ GetTxOptions()

uint8_t ns3::zigbee::ZigbeeApsTxOptions::GetTxOptions ( ) const

Get the complete bitmap containing the Tx options.

Returns: The Tx options bitmap.

Definition at line 542 of file zigbee-aps.cc.

References m_txOptions.

Referenced by SendData(), and ZigbeeApsDataTestCase::SendDataUcstDst().

Here is the caller graph for this function:

◆ IsAckRequired()

bool ns3::zigbee::ZigbeeApsTxOptions::IsAckRequired ( ) const

Show if the ACK bit of the Tx options is present.

Returns: True if the bit is active

Definition at line 524 of file zigbee-aps.cc.

References GetBit().

Referenced by ns3::zigbee::ZigbeeAps::ApsdeDataRequest(), and ns3::zigbee::ZigbeeAps::SendDataUcstBcst().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsFragmentationPermitted()

bool ns3::zigbee::ZigbeeApsTxOptions::IsFragmentationPermitted ( ) const

Show if the fragmentation permitted bit of the Tx options is present.

Returns: True if the bit is active

Definition at line 530 of file zigbee-aps.cc.

References GetBit().

Here is the call graph for this function:

◆ IsIncludeExtendedNonce()

bool ns3::zigbee::ZigbeeApsTxOptions::IsIncludeExtendedNonce ( ) const

Show if the include extended nonce bit of the Tx options is present.

Returns: True if the bit is active

Definition at line 536 of file zigbee-aps.cc.

References GetBit().

Here is the call graph for this function:

◆ IsSecurityEnabled()

bool ns3::zigbee::ZigbeeApsTxOptions::IsSecurityEnabled ( ) const

Show if the security enable bit of the Tx options is present.

Returns: True if the bit is active

Definition at line 512 of file zigbee-aps.cc.

References GetBit().

Referenced by ns3::zigbee::ZigbeeAps::ApsdeDataRequest(), ns3::zigbee::ZigbeeAps::SendDataUcstBcst(), and ns3::zigbee::ZigbeeAps::SendDataWithBindingTable().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsUseNwkKey()

bool ns3::zigbee::ZigbeeApsTxOptions::IsUseNwkKey ( ) const

Show if the use network key bit of the Tx options is present.

Returns: True if the bit is active

Definition at line 518 of file zigbee-aps.cc.

References GetBit().

Here is the call graph for this function:

◆ SetAckRequired()

void ns3::zigbee::ZigbeeApsTxOptions::SetAckRequired ( bool enable )

Set the Acknowledgement required bit of the Tx options.

Parameters

enable True if ACK is required.

Definition at line 494 of file zigbee-aps.cc.

References SetBit().

Here is the call graph for this function:

◆ SetBit()

void ns3::zigbee::ZigbeeApsTxOptions::SetBit	(	int	pos,
		bool	value )

private

Set a bit value into a position in the uint8_t representint the Tx options.

Parameters

pos	Position to shift
value	Value to set

Definition at line 548 of file zigbee-aps.cc.

References m_txOptions.

Referenced by SetAckRequired(), SetFragmentationPermitted(), SetIncludeExtendedNonce(), SetSecurityEnabled(), and SetUseNwkKey().

Here is the caller graph for this function:

◆ SetFragmentationPermitted()

void ns3::zigbee::ZigbeeApsTxOptions::SetFragmentationPermitted ( bool enable )

Set the fragmentation bit of the Tx options.

Parameters

enable True if fragmentation is allowed in the transmission.

Definition at line 500 of file zigbee-aps.cc.

References SetBit().

Here is the call graph for this function:

◆ SetIncludeExtendedNonce()

void ns3::zigbee::ZigbeeApsTxOptions::SetIncludeExtendedNonce ( bool enable )

Set the include extended nonce bit of the Tx options.

Parameters

enable True if the frame should include the extended nonce

Definition at line 506 of file zigbee-aps.cc.

References SetBit().

Here is the call graph for this function:

◆ SetSecurityEnabled()

void ns3::zigbee::ZigbeeApsTxOptions::SetSecurityEnabled ( bool enable )

Set the security enable bit of the TX options.

Parameters

enable True if security is enabled.

Definition at line 482 of file zigbee-aps.cc.

References SetBit().

Here is the call graph for this function:

◆ SetUseNwkKey()

void ns3::zigbee::ZigbeeApsTxOptions::SetUseNwkKey ( bool enable )

Set the use network key bit of the TX options.

Parameters

enable True if Network key should be used.

Definition at line 488 of file zigbee-aps.cc.

References SetBit().

Here is the call graph for this function:

Member Data Documentation

◆ m_txOptions

uint8_t ns3::zigbee::ZigbeeApsTxOptions::m_txOptions

private

the bitmap representing the Tx options

Definition at line 545 of file zigbee-aps.h.

Referenced by GetBit(), GetTxOptions(), and SetBit().

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

src/zigbee/model/zigbee-aps.h
src/zigbee/model/zigbee-aps.cc

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ZigbeeApsTxOptions()

Member Function Documentation

◆ GetBit()

◆ GetTxOptions()

◆ IsAckRequired()

◆ IsFragmentationPermitted()

◆ IsIncludeExtendedNonce()

◆ IsSecurityEnabled()

◆ IsUseNwkKey()

◆ SetAckRequired()

◆ SetBit()

◆ SetFragmentationPermitted()

◆ SetIncludeExtendedNonce()

◆ SetSecurityEnabled()

◆ SetUseNwkKey()

Member Data Documentation

◆ m_txOptions