F5/unison
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updated documentation for LteHelper::Attach function family

Browse Source
This commit is contained in:
Budiarto Herman
2013-07-31 14:28:06 +03:00
parent 6d4c290170
commit 45cba68616
1 changed files with 29 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

45
src/lte/helper/lte-helper.h
View File

@@ -183,40 +183,53 @@ public:
NetDeviceContainer InstallUeDevice (NodeContainer c);
/**
* \brief Instruct a set of UE devices to attach to a suitable cell.
* \brief Enables automatic attachment of a set of UE devices to a suitable
* cell using Idle mode initial cell selection procedure.
* \param ueDevices the set of UE devices to be attached
*
* By calling this, the UE will start the cell search and initial cell
* selection procedure at the beginning of simulation. Note that this function
* can only be used in EPC-enabled simulation.
* By calling this, the UE will start the initial cell selection procedure at
* the beginning of simulation. Note that this function can only be used in
* EPC-enabled simulation.
*/
void Attach (NetDeviceContainer ueDevices);
/**
* \brief Instruct a UE device to attach to a suitable cell.
* \param ueDevice
* \brief Enables automatic attachment of a UE device to a suitable cell
* using Idle mode initial cell selection procedure.
* \param ueDevice the UE device to be attached
*
* By calling this, the UE will start the cell search and initial cell
* selection procedure at the beginning of simulation. Note that this function
* can only be used in EPC-enabled simulation.
* By calling this, the UE will start the initial cell selection procedure at
* the beginning of simulation. Note that this function can only be used in
* EPC-enabled simulation.
*/
void Attach (Ptr<NetDevice> ueDevice);
/**
* Attach a set of UE devices to a single eNB device
* \brief Manual attachment of a set of UE devices to the network via a given
* eNodeB.
* \param ueDevices the set of UE devices to be attached
* \param enbDevice the destination eNodeB device
*
* \param ueDevices
* \param enbDevice
* In addition, the function also instructs each UE to immediately enter
* CONNECTED mode and activates the default EPS bearer.
*
* The function can be used in both LTE-only and EPC-enabled simulations.
* Note that this function will disable Idle mode initial cell selection
* procedure.
*/
void Attach (NetDeviceContainer ueDevices, Ptr<NetDevice> enbDevice);
/**
* Attach a UE to the network
* \brief Manual attachment of a UE device to the network via a given eNodeB.
* \param ueDevice the UE device to be attached
* \param enbDevice the destination eNodeB device
*
* Attach a UE device to the network via a given eNB, and activate the default EPS bearer.
* In addition, the function also instructs the UE to immediately enter
* CONNECTED mode and activates the default EPS bearer.
*
* \param ueDevice
* \param enbDevice
* The function can be used in both LTE-only and EPC-enabled simulations.
* Note that this function will disable Idle mode initial cell selection
* procedure.
*/
void Attach (Ptr<NetDevice> ueDevice, Ptr<NetDevice> enbDevice);