GoldSim provides a number of special reserved names, referred to as Run Properties, that can be directly referenced in expressions. Some Run Properties are associated with Reporting Periods that you have defined in the Simulation Settings dialog.
These can be found under the “Reporting Periods” folder:
The Reporting Periods Run Properties are described below:
ReportingMonth: This is the current reporting month, relative to the month specified as the “Start of reporting year” in the the Advanced Settings of the Time tab of the Simulation Settings dialog. For example, if the “Start of reporting year” was defined as April, and the current month in the simulation was June, ReportingMonth would be 3; if the current month in the simulation was April, ReportingMonth would be 1. This Run Property is always available (even if no Reporting Periods are defined). It is unitless.
ETime_Major (where Major is the user-defined Major Period Label): This is elapsed time since the start of the current Major Reporting Period. Note that at the start of a new Major Period, this displays the duration of the just-completed period. It has units of time, and is only available if a Major Reporting Period is defined.
RTime_Major (where Major is the user-defined Major Period Label): This is time remaining in the current Major Reporting Period. Note that at the start of a new Major Period, this displays the duration of the period which is starting. It has units of time, and is only available if a Major Reporting Period is defined.
IsNew_Major (where Major is the user-defined Major Period Label): This is a condition which is True if the current time is the start of a Major Reporting Period. Otherwise it is False. It is only available if a Major Reporting Period is defined. Note that when this is True, ETime_Major displays the duration of the just-completed period and RTime_Major displays the duration of the period which is starting.
ETime_Minor (where Minor is the user-defined Minor Period Label): This is elapsed time since the start of the current Minor Reporting Period. Note that at the start of a new Minor Period, this displays the duration of the just-completed period. It has units of time, and is only available if a Minor Reporting Period is defined.
RTime_Minor (where Minor is the user-defined Minor Period Label): This is time remaining in the current Minor Reporting Period. Note that at the start of a new Minor Period, this displays the duration of the period which is starting. It has units of time, and is only available if a Minor Reporting Period is defined.
IsNew_Minor (where Minor is the user-defined Minor Period Label): This is a condition which is True if the current time is the start of a Minor Reporting Period. Otherwise it is False. It is only available if a Minor Reporting Period is defined. Note that when this is True, ETime_Minor displays the duration of the just-completed period and RTime_Minor displays the duration of the period which is starting.
Note: An example file which
illustrates the use of Reporting Period Run Properties (RunProperties.gsm) can
be found in the General Examples/ Running folder in your GoldSim directory
(accessed by selecting File | Open Example... from the main
menu).
Learn more about: