-
Notifications
You must be signed in to change notification settings - Fork 46
Developer's API
Elsa Gonsiorowski edited this page Jul 8, 2014
·
4 revisions
These guide lines are for ROSS developers. Model developers should not need to know these specifics, but may find this to be a useful reference.
- Global variables begin with a
g
- underscores are used between words (in preference to camel case)
- API functions begin with
tw_
(short for Time Warp) - Preprocessor definitions start with
ROSS_
followed by all capitol letters for the option type then lower case for the option selected. For example:ROSS_QUEUE_calendar
- Functions that are not intended to be API functions should be declared static (meaning they can only be called by functions located within the same file).
- All type-defs should be made in
ross-types.h
(because Chris likes it like that).