GSOC2023NetAnimFinalReport - Revision history

Raghuram: /* Challenges Faced */

2023-10-17T22:02:38Z

Challenges Faced

← Older revision		Revision as of 22:02, 17 October 2023
Line 39:		Line 39:

	== Challenges Faced ==		== Challenges Faced ==
	* Initially, the plan was to move all net-device-related code to the corresponding net-device and keep the remaining code in the animation interface. The issue is when we move the net-device-related code to the corresponding module we can access the animation-interface object which helps us to write into the XML file. To solve this we decided to convert the animation interface class into a singleton and also maintain a proxy for all the public API.		* Initially, the plan was to move all net-device-related code to the corresponding net-device and keep the remaining code in the animation interface. The issue is when we move the net-device-related code to the corresponding module we can't access the animation-interface object which helps us to write into the XML file. To solve this we decided to convert the animation interface class into a singleton and also maintain a proxy for all the public API.
	*The issues with the above approach are:		*The issues with the above approach are:
	**The Singleton + proxy approach could only have one AnimationInterface file for each script.		**The Singleton + proxy approach could only have one AnimationInterface file for each script.

Raghuram: /* Project Overview */

2023-10-09T16:57:31Z

Project Overview

← Older revision		Revision as of 16:57, 9 October 2023
Line 47:		Line 47:

	Despite the challenges we faced we were able to finalize the design and prove the approach works and is effective for the CSMA and point-to-point modules which were tested on the second.cc and first.cc script respectively.		Despite the challenges we faced we were able to finalize the design and prove the approach works and is effective for the CSMA and point-to-point modules which were tested on the second.cc and first.cc script respectively.


	== Future Work ==		== Future Work ==

Raghuram: /* Project Overview */

2023-10-09T16:57:16Z

Project Overview

← Older revision		Revision as of 16:57, 9 October 2023
Line 47:		Line 47:

	Despite the challenges we faced we were able to finalize the design and prove the approach works and is effective for the CSMA and point-to-point modules which were tested on the second.cc and first.cc script respectively.		Despite the challenges we faced we were able to finalize the design and prove the approach works and is effective for the CSMA and point-to-point modules which were tested on the second.cc and first.cc script respectively.


			== Future Work ==

			*Get the proxy class merged to the ns-3 mainline.
			*Merge the Csma, Point-to-point, LTE and Wi-Fi modules.
			*Refactor the remaining modules as per the initial proposal (WiMax,Lr-Wpan and UAN).
			*Netanim improvements using packet tags.
			*Do a performance analysis to see the benefits of the refactor.

Raghuram: /* Challenges Faced */

2023-10-09T16:56:24Z

Challenges Faced

← Older revision		Revision as of 16:56, 9 October 2023
Line 45:		Line 45:
	*So after discussions with the NS-3 community and my mentors. We decided to go with the proxy-core approach. However, there were some design aspects that needed to be finalized for the proxy to be added to the core as something that is being added to the core must be documented in detail.		*So after discussions with the NS-3 community and my mentors. We decided to go with the proxy-core approach. However, there were some design aspects that needed to be finalized for the proxy to be added to the core as something that is being added to the core must be documented in detail.
	*Some net devices like LTE require some unforeseen changes due to the fact that DoInitalize() was being called much earlier than expected.		*Some net devices like LTE require some unforeseen changes due to the fact that DoInitalize() was being called much earlier than expected.

			Despite the challenges we faced we were able to finalize the design and prove the approach works and is effective for the CSMA and point-to-point modules which were tested on the second.cc and first.cc script respectively.

Raghuram: /* Project Overview */

2023-10-09T16:56:06Z

Project Overview

← Older revision		Revision as of 16:56, 9 October 2023
Line 37:		Line 37:
	* Refactored the CSMA module and tested with the second.cc script to make sure it produced the same XML as before.		* Refactored the CSMA module and tested with the second.cc script to make sure it produced the same XML as before.
	* Refactored the Point-to-Point module and tested with the first.cc script to make sure it produced the same XML as before.		* Refactored the Point-to-Point module and tested with the first.cc script to make sure it produced the same XML as before.

			== Challenges Faced ==
			* Initially, the plan was to move all net-device-related code to the corresponding net-device and keep the remaining code in the animation interface. The issue is when we move the net-device-related code to the corresponding module we can access the animation-interface object which helps us to write into the XML file. To solve this we decided to convert the animation interface class into a singleton and also maintain a proxy for all the public API.
			*The issues with the above approach are:
			**The Singleton + proxy approach could only have one AnimationInterface file for each script.
			**A lot of redundant code due to the proxy.
			*So after discussions with the NS-3 community and my mentors. We decided to go with the proxy-core approach. However, there were some design aspects that needed to be finalized for the proxy to be added to the core as something that is being added to the core must be documented in detail.
			*Some net devices like LTE require some unforeseen changes due to the fact that DoInitalize() was being called much earlier than expected.

Raghuram: /* Project Overview */

2023-10-09T16:53:24Z

Project Overview

← Older revision		Revision as of 16:53, 9 October 2023
Line 31:		Line 31:
	\| [6] \|\| [https://gitlab.com/nsnam/ns-3-dev/-/merge_requests/1639 core: Add proxy to core]		\| [6] \|\| [https://gitlab.com/nsnam/ns-3-dev/-/merge_requests/1639 core: Add proxy to core]
	\|}		\|}

			== Milestones ==
			* Finalized the design of adding a proxy class to the core module instead of the initially proposed Singleton + proxy approach.
			* Implemented the Proxy class in the core module along with the proxy-class-test-suite for testing the Proxy class.
			* Refactored the CSMA module and tested with the second.cc script to make sure it produced the same XML as before.
			* Refactored the Point-to-Point module and tested with the first.cc script to make sure it produced the same XML as before.

Raghuram: /* Project Overview */

2023-10-09T16:47:19Z

Project Overview

← Older revision		Revision as of 16:47, 9 October 2023
Line 7:		Line 7:
	* '''Useful links''':		* '''Useful links''':
	** [https://www.nsnam.org/wiki/GSOC2023NetAnim Project wiki page] - used to track the work in progress.		** [https://www.nsnam.org/wiki/GSOC2023NetAnim Project wiki page] - used to track the work in progress.

			== Merge Requests ==

			All the work done during GSoC has been committed to one branch, named [https://gitlab.com/raghuramkannan40/ns-3-dev/-/tree/gsoc-2023-netanim-changes?ref_type=heads ''gsoc-2023-netanim-changes''].

			Listed below are all the Merge Requests made during the GSoC period.

			{\| class="wikitable"
			\|+ Merge Requests
			\|-
			! No. !! Name
			\|-
			\| [1] \|\| [https://gitlab.com/nsnam/ns-3-dev/-/merge_requests/1505 NetAnim: GSoC-23 Dynamic device registration for NetAnim simulation animations]
			\|-
			\| [2] \|\| [https://gitlab.com/nsnam/ns-3-dev/-/merge_requests/1506 build: Add Define for NetAnim in CMake]
			\|-
			\| [3] \|\| [https://gitlab.com/nsnam/ns-3-dev/-/merge_requests/1523 NetAnim: Convert AnimationInterface into a Singleton with Proxy]
			\|-
			\| [4] \|\| [https://gitlab.com/nsnam/ns-3-dev/-/merge_requests/1592 Draft: Refactor the CSMA Module for NetAnim Simulations]
			\|-
			\| [5] \|\| [https://gitlab.com/nsnam/ns-3-dev/-/merge_requests/1633 Draft: Refactored Csma Module for NetAnim (Updated Approach)]
			\|-
			\| [6] \|\| [https://gitlab.com/nsnam/ns-3-dev/-/merge_requests/1639 core: Add proxy to core]
			\|}

Raghuram: Created page with "= Project Overview = * '''Project Name''': [https://summerofcode.withgoogle.com/programs/2023/projects/EpacH0ct Dynamic device registration for NetAnim simulation animations]..."

2023-10-06T19:50:44Z

Created page with "= Project Overview = * '''Project Name''': [https://summerofcode.withgoogle.com/programs/2023/projects/EpacH0ct Dynamic device registration for NetAnim simulation animations]..."

New page

= Project Overview =

* '''Project Name''': [https://summerofcode.withgoogle.com/programs/2023/projects/EpacH0ct Dynamic device registration for NetAnim simulation animations]
* '''Contributor''': Raghuram Kannan
* '''Mentors''': Tommaso Pecorella and Manoj Kumar Rana
* '''Main Goal''': The project aims to refactor the NetAnim module such that each module willing to use NetAnim will have a .cc and .h file responsible for communication with the NetAnim module, enabled only if NetAnim is active. This will break the dependencies and will allow more flexibility for out-of-tree modules and modules migrating to the AppStore.
* '''Useful links''':
** [https://www.nsnam.org/wiki/GSOC2023NetAnim Project wiki page] - used to track the work in progress.