Rietveld Code Review Tool
Help | Bug tracker | Discussion group | Source code | Sign in
(752)

Unified Diff: src/lte/model/epc-x2.h

Issue 315450043: LTE module corrections for doxygen warnings (Closed)
Patch Set: Created 7 years, 2 months ago
Use n/p to move between diff chunks; N/P to move between comments. Please Sign in to add in-line comments.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « src/lte/model/epc-ue-nas.h ('k') | src/lte/model/epc-x2-header.h » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: src/lte/model/epc-x2.h
===================================================================
--- a/src/lte/model/epc-x2.h
+++ b/src/lte/model/epc-x2.h
@@ -33,32 +33,61 @@
namespace ns3 {
+/**
+ * X2IfaceInfo
+ */
class X2IfaceInfo : public SimpleRefCount<X2IfaceInfo>
{
public:
+ /**
+ * Constructor
+ *
+ * \param remoteIpAddr remote IP address
+ * \param localCtrlPlaneSocket control plane socket
+ * \param localUserPlaneSocket user plane socket
+ */
X2IfaceInfo (Ipv4Address remoteIpAddr, Ptr<Socket> localCtrlPlaneSocket, Ptr<Socket> localUserPlaneSocket);
virtual ~X2IfaceInfo (void);
+ /**
+ * Assignment operator
+ *
+ * \returns X2IfaceInfo&
+ */
X2IfaceInfo& operator= (const X2IfaceInfo &);
public:
- Ipv4Address m_remoteIpAddr;
- Ptr<Socket> m_localCtrlPlaneSocket;
- Ptr<Socket> m_localUserPlaneSocket;
+ Ipv4Address m_remoteIpAddr; ///< remote IP address
+ Ptr<Socket> m_localCtrlPlaneSocket; ///< local control plane socket
+ Ptr<Socket> m_localUserPlaneSocket; ///< local user plane socket
};
+/**
+ * X2CellInfo
+ */
class X2CellInfo : public SimpleRefCount<X2CellInfo>
{
public:
+ /**
+ * Constructor
+ *
+ * \param localCellId local cell ID
+ * \param remoteCellId remote cell ID
+ */
X2CellInfo (uint16_t localCellId, uint16_t remoteCellId);
virtual ~X2CellInfo (void);
+ /**
+ * Assignment operator
+ *
+ * \returns X2CellInfo&
+ */
X2CellInfo& operator= (const X2CellInfo &);
public:
- uint16_t m_localCellId;
- uint16_t m_remoteCellId;
+ uint16_t m_localCellId; ///< local cell ID
+ uint16_t m_remoteCellId; ///< remote cell ID
};
@@ -82,6 +111,10 @@
*/
virtual ~EpcX2 (void);
+ /**
+ * \brief Get the type ID.
+ * \return the object TypeId
+ */
static TypeId GetTypeId (void);
virtual void DoDispose (void);
@@ -127,17 +160,29 @@
protected:
// Interface provided by EpcX2SapProvider
+ /// Send handover request function
virtual void DoSendHandoverRequest (EpcX2SapProvider::HandoverRequestParams params);
+ /// Send handover request ack function
virtual void DoSendHandoverRequestAck (EpcX2SapProvider::HandoverRequestAckParams params);
+ /// send handover preparation failure function
virtual void DoSendHandoverPreparationFailure (EpcX2SapProvider::HandoverPreparationFailureParams params);
+ /// send SN ststus trasnfer function
virtual void DoSendSnStatusTransfer (EpcX2SapProvider::SnStatusTransferParams params);
+ /// send UE context release function
virtual void DoSendUeContextRelease (EpcX2SapProvider::UeContextReleaseParams params);
+ /// Send load information function
virtual void DoSendLoadInformation (EpcX2SapProvider::LoadInformationParams params);
+ /// send resurce status update function
virtual void DoSendResourceStatusUpdate (EpcX2SapProvider::ResourceStatusUpdateParams params);
+ /**
+ * Send UE data function
+ *
+ * \param params EpcX2SapProvider::UeDataParams
+ */
virtual void DoSendUeData (EpcX2SapProvider::UeDataParams params);
- EpcX2SapUser* m_x2SapUser;
- EpcX2SapProvider* m_x2SapProvider;
+ EpcX2SapUser* m_x2SapUser; ///< X2 SAP user
+ EpcX2SapProvider* m_x2SapProvider; ///< X2 SAP provider
private:
@@ -155,9 +200,12 @@
std::map < Ptr<Socket>, Ptr<X2CellInfo> > m_x2InterfaceCellIds;
/**
- * UDP ports to be used for the X2 interfaces: X2-C and X2-U
+ * UDP ports to be used for the X2-C interface
*/
uint16_t m_x2cUdpPort;
+ /**
+ * UDP ports to be used for the X2-U interface
+ */
uint16_t m_x2uUdpPort;
};
« no previous file with comments | « src/lte/model/epc-ue-nas.h ('k') | src/lte/model/epc-x2-header.h » ('j') | no next file with comments »

Powered by Google App Engine
RSS Feeds Recent Issues | This issue
This is Rietveld f62528b