Bug 2527 - Extend PrintRoutingTable to specify user selected time units for the report.
Extend PrintRoutingTable to specify user selected time units for the report.
Status: RESOLVED FIXED
Product: ns-3
Classification: Unclassified
Component: routing
ns-3-dev
PC Linux
: P2 enhancement
Assigned To: ns-bugs
:
Depends on:
Blocks:
  Show dependency treegraph
 
Reported: 2016-10-19 18:55 UTC by Robert Ammon
Modified: 2016-11-04 21:40 UTC (History)
2 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Robert Ammon 2016-10-19 18:55:28 UTC
The time units used on the PrintRoutingTable output are specified in the source code for each routing module.  In order to change the time units from the default value of seconds (Time::S), the ns-3 source code must be edited and ns-3 rebuilt for the desired routing modules.

The enhancement is to extend the PrintRoutingTable function and add the time units as a new optional function parameter.  The new parameter will have a default value of Time::S to maintain backward compatibility.
Comment 1 Tom Henderson 2016-10-19 19:22:44 UTC
Is this a request for a patch (PATCH WANTED) or are you working on a patch?
Comment 2 Robert Ammon 2016-10-19 20:50:18 UTC
I have already implemented this change and will be submitting it shortly.
Comment 3 Robert Ammon 2016-10-22 17:46:58 UTC
Uploaded as https://codereview.appspot.com/314920043
Comment 4 Robert Ammon 2016-10-22 17:56:42 UTC
Some of the changed files also include changes for Bug #2530.
Comment 5 Tom Henderson 2016-10-23 18:42:11 UTC
I'm OK with this patch (not strongly for or against); it seems to be a minor formatting change.
Comment 6 Tommaso Pecorella 2016-10-23 18:53:20 UTC
I'm ok with the change, provided that:
1) it is split from Bug #2530 (of course), and
2) the Doxygen is double checked. Most functions are missing the extra parameter.

Please provide a new patch ready to be applied.
Comment 7 Robert Ammon 2016-10-24 07:08:25 UTC
(In reply to Tommaso Pecorella from comment #6)
> I'm ok with the change, provided that:
> 1) it is split from Bug #2530 (of course), and
> 2) the Doxygen is double checked. Most functions are missing the extra
> parameter.
> 
> Please provide a new patch ready to be applied.

Can you provide some specifics on what is needed for:

(1) Bug #2530 and this Enh both have changes in the same source files.  The source files provided for this Enh also contain the changes for Bug #2530 assuming that bug is processed first.

(2) I am new to this project.  Can you provide more details on what needs updated for this part of your comment.
Comment 8 Robert Ammon 2016-10-24 17:13:49 UTC
New patch set has been uploaded to correct doxygen errors.
Comment 9 Tom Henderson 2016-10-26 00:14:45 UTC
(In reply to Robert Ammon from comment #7)
> (In reply to Tommaso Pecorella from comment #6)
> > I'm ok with the change, provided that:
> > 1) it is split from Bug #2530 (of course), and
> > 2) the Doxygen is double checked. Most functions are missing the extra
> > parameter.
> > 
> > Please provide a new patch ready to be applied.
> 
> Can you provide some specifics on what is needed for:
> 
> (1) Bug #2530 and this Enh both have changes in the same source files.  The
> source files provided for this Enh also contain the changes for Bug #2530
> assuming that bug is processed first.

Tommaso was asking for a patch that was independent of this enhancement, so to strip any changes related to bug 2530 out of this patch.

This change and bug 2530 are basically unrelated to one another, but if there were a true dependency, you could use the 'depends on' field of this tracker issue to note that bug 2530 patch had to be applied first.

> 
> (2) I am new to this project.  Can you provide more details on what needs
> updated for this part of your comment.

I think that you addressed this in your revision.  I think the main ones to fix were the base classes Ipv4RoutingProtocol and Ipv6RoutingProtocol since the subclasses should inherit the doxygen.

To double check that no new errors or warnings are introduced, there is a utility script in 'doc/doxygen.warnings.report.sh' that can be run to generate a warnings report.
Comment 10 Robert Ammon 2016-10-26 07:17:56 UTC
Changes from Bug 2530 remove from this change set.
Comment 11 Tommaso Pecorella 2016-11-04 21:40:21 UTC
Pushed in changeset 12389:d99ffe039f18

Thanks Robert for the contribution.