Ticket #5455 (closed: fixed)

Opened 8 years ago

Last modified 5 years ago

Correct member documentation in TofEvent

Reported by: Russell Taylor Owned by: Russell Taylor
Priority: minor Milestone: Release 2.2
Component: Mantid Keywords:
Cc: Blocked By:
Blocking: Tester: Jose Borreguero

Description

It states that TofEvent::m_tof in Events.h is in nanoseconds. This is not correct (it will be microseconds) and can confuse the uninitiated. The comments should also make clear that this is not necessarily a time-of-flight if the units have been changed.

I don't intend to go down the rabbit hole of changing the actual member name....

Change History

comment:1 Changed 8 years ago by Russell Taylor

  • Status changed from new to accepted

comment:2 Changed 8 years ago by Russell Taylor

Re #5455. Change Events.h comments wrongly referring to nanoseconds.

Also act on a TODO about changing the TofEvent member variable visibility back to protected from public. This accounts for most of the changes as people had just used the members directly instead of accessor methods. A few places were using it to modify the members directly. I was able to change the logic to get around this in all cases except for LoadEventNexus.

Changeset: 87430b6c9032a6a5ddf46cfa59183b2de0728d66

comment:3 Changed 8 years ago by Russell Taylor

Re #5455. Fix errors made in refactor yesterday.

Changeset: ea564818779e85e72957582328b35eedea27873c

comment:4 Changed 8 years ago by Russell Taylor

  • Status changed from accepted to verify
  • Resolution set to fixed

comment:5 Changed 8 years ago by Russell Taylor

Re #5455. Change Events.h comments wrongly referring to nanoseconds.

Also act on a TODO about changing the TofEvent member variable visibility back to protected from public. This accounts for most of the changes as people had just used the members directly instead of accessor methods. A few places were using it to modify the members directly. I was able to change the logic to get around this in all cases except for LoadEventNexus.

Changeset: 87430b6c9032a6a5ddf46cfa59183b2de0728d66

comment:6 Changed 8 years ago by Russell Taylor

Re #5455. Fix errors made in refactor yesterday.

Changeset: ea564818779e85e72957582328b35eedea27873c

comment:7 Changed 8 years ago by Russell Taylor

Re #5455. Change Events.h comments wrongly referring to nanoseconds.

Also act on a TODO about changing the TofEvent member variable visibility back to protected from public. This accounts for most of the changes as people had just used the members directly instead of accessor methods. A few places were using it to modify the members directly. I was able to change the logic to get around this in all cases except for LoadEventNexus.

Changeset: 87430b6c9032a6a5ddf46cfa59183b2de0728d66

comment:8 Changed 8 years ago by Russell Taylor

Re #5455. Fix errors made in refactor yesterday.

Changeset: ea564818779e85e72957582328b35eedea27873c

comment:9 Changed 8 years ago by Jose Borreguero

  • Status changed from verify to verifying
  • Tester set to Jose Borreguero

comment:10 Changed 8 years ago by Jose Borreguero

  • Status changed from verifying to closed

comment:11 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue 6301

Note: See TracTickets for help on using tickets.