Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename sinceSimStart? #30

Closed
turion opened this issue Apr 22, 2018 · 5 comments
Closed

Rename sinceSimStart? #30

turion opened this issue Apr 22, 2018 · 5 comments

Comments

@turion
Copy link
Owner

turion commented Apr 22, 2018

sinceSimStart is an unsuggestive name. Possibly, sinceInit would be better.

@turion turion added this to the HS2018-submission milestone Apr 26, 2018
@turion
Copy link
Owner Author

turion commented May 21, 2018

@ivanperez-keera opinion? sinceSimStart measures/integrates the time since it was started. So if you switch to it, it starts at 0. (But sinceSwitch is not a good name, only Yampa users would understand it.) sinceStart is already taken. I don't like sinceInit so much because initialisation sounds a lot like the initialisation of a clock. Maybe sinceLocalInit or sinceLocalStart?

@ivanperez-keera
Copy link
Collaborator

ivanperez-keera commented May 22, 2018

Since it's a variable, calling it just time would do.

sinceStart is the best imo. For something that is exposed, I might be tempted to call it localTime. However, 1) that reverses the order of names in the term, 2) there is one like this in Yampa, and it has these semantics, although it's an SF () Time, not a signal, and 3) what we might want to call global time in Rhine does not correspond to time in Yampa (because in Yampa, all times are local).

A few other terms come to mind: sinceZero, absolute time, total time, total simulation time, current time, simTime, timeSinceStart.

EDIT: Corrects minor typos.

@turion turion mentioned this issue May 22, 2018
22 tasks
@turion
Copy link
Owner Author

turion commented May 25, 2018

  • time is nice, but too general. There are too many other things that could called that. And it's the new convention for the time domain type variable of a clock or a behaviour.
  • localTime would be perfect if it hadn't another meaning with time zones.
  • In Rhine, init and start are synonymous and both mean the initialisation of a clock. I wonder whether it's worth breaking this up and calling clock initialisation things with init, freeing the word start for this context. This would mean the following renames:
    • startClock -> initClock
    • startSchedule -> initSchedule
    • sinceStart -> sinceInit
    • sinceSimStart -> sinceStart/sinceStartS

@ivanperez-keera
Copy link
Collaborator

  • localTime would be perfect if it hadn't another meaning with time zones.

I'm not sure I agree. That domain is very far, and unlikely to cause a conflict. You can never be sure you won't hit a keyword in a different domain. So long as you define what you mean, and it's intuitive, then it's ok.

So long as it's consistent, intuitive, and explained well, I think any of these solutions is acceptable for now, and we should not oversweat this particular point at this time. If you like one policy, just go for it.

Ironically, time, and experience, may prove us wrong, and that's ok.

@turion
Copy link
Owner Author

turion commented May 25, 2018

Maybe. But we both like sinceStart, thus be it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants