A Discrete-Event Network Simulator
API
ns3::UanModesList Class Reference

Container for UanTxModes. More...

#include "uan-tx-mode.h"

+ Collaboration diagram for ns3::UanModesList:

Public Member Functions

 UanModesList ()
 Constructor. More...
 
virtual ~UanModesList ()
 Destructor. More...
 
void AppendMode (UanTxMode mode)
 Add mode to this list. More...
 
void DeleteMode (uint32_t num)
 Delete the mode at given index. More...
 
uint32_t GetNModes (void) const
 Get the number of modes in this list. More...
 
UanTxMode operator[] (uint32_t index) const
 Retrieve a mode by index. More...
 

Private Attributes

std::vector< UanTxModem_modes
 The vector of modes in this list. More...
 

Friends

std::ostream & operator<< (std::ostream &os, const UanModesList &ml)
 Write UanModesList to stream os. More...
 
std::istream & operator>> (std::istream &is, UanModesList &ml)
 Read UanModesList from stream is. More...
 

Detailed Description

Container for UanTxModes.

See also
UanModesList Attribute

Definition at line 257 of file uan-tx-mode.h.

Constructor & Destructor Documentation

◆ UanModesList()

ns3::UanModesList::UanModesList ( void  )

Constructor.

Definition at line 222 of file uan-tx-mode.cc.

◆ ~UanModesList()

ns3::UanModesList::~UanModesList ( void  )
virtual

Destructor.

Definition at line 226 of file uan-tx-mode.cc.

References m_modes.

Member Function Documentation

◆ AppendMode()

void ns3::UanModesList::AppendMode ( UanTxMode  mode)

Add mode to this list.

Parameters
modeThe mode to add.

Definition at line 232 of file uan-tx-mode.cc.

References m_modes.

Referenced by Experiment::CreateDualModes(), UanTest::DoPhyTests(), and ns3::UanPhyGen::GetDefaultModes().

+ Here is the caller graph for this function:

◆ DeleteMode()

void ns3::UanModesList::DeleteMode ( uint32_t  num)

Delete the mode at given index.

Parameters
numIndex of mode to delete.

Definition at line 238 of file uan-tx-mode.cc.

References m_modes, and NS_ASSERT.

◆ GetNModes()

uint32_t ns3::UanModesList::GetNModes ( void  ) const

Get the number of modes in this list.

Returns
Number of modes.

Definition at line 259 of file uan-tx-mode.cc.

References m_modes.

Referenced by ns3::UanPhyGen::GetMode(), and ns3::UanPhyGen::GetNModes().

+ Here is the caller graph for this function:

◆ operator[]()

UanTxMode ns3::UanModesList::operator[] ( uint32_t  index) const

Retrieve a mode by index.

Parameters
indexMode index.
Returns
Mode at given index.

Definition at line 252 of file uan-tx-mode.cc.

References m_modes, and NS_ASSERT.

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<< ( std::ostream &  os,
const UanModesList ml 
)
friend

Write UanModesList to stream os.

Parameters
osThe output stream.
mlThe mode list.
Returns
The stream.

Definition at line 264 of file uan-tx-mode.cc.

◆ operator>>

std::istream& operator>> ( std::istream &  is,
UanModesList ml 
)
friend

Read UanModesList from stream is.

Parameters
isThe input stream.
mlThe mode list to fill.
Returns
The stream.

Definition at line 277 of file uan-tx-mode.cc.

Member Data Documentation

◆ m_modes

std::vector<UanTxMode> ns3::UanModesList::m_modes
private

The vector of modes in this list.

Definition at line 290 of file uan-tx-mode.h.

Referenced by ~UanModesList(), AppendMode(), DeleteMode(), GetNModes(), and operator[]().


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