VarSimT
Use to determine time-related attributes while running Aurora in step mode. This command is useful for making changes to inputs during an Aurora run subject to this evaluation.
Typically VarSimT variables should be accessed individually. For example, Dim CurDate As Date = AC.VarSimT.CurrentDate. Commonly, a struct variable containing all VarSimT variables can be dimensioned as follows: Dim TStruct As AURORAServer.StructuresModule.strucSimTimeVar = AC.VarSimT.
The following commands can be used with VarSimT:
BaseSerialDate
Returns the first day of the economic base year.
CreatedDataSet
Not used
CurrentCalendarYear
Returns the calendar year of the current time in the model run.
CurrentCumEscDemand
Returns the current cumulative escalation of demand from the demand base year for a specified area. This command creates and array so that the area can be specified as a component. The current cumulative escalation of demand is only determined here on an annual basis.
CurrentCumEscDemandZone
Returns the current cumulative escalation of demand from the demand base year for a specified zone. See CurrentCumEscDemand for more information.
CurrentCumInflation
Returns the current cumulative inflation from the economic base year. This is only determined on an annual basis like the CurrentCumEscDemand.
CurrentDate
Returns the current date of the model run as the model steps through time.
CurrentDay
Returns the current day of the model run as the model steps through time.
CurrentDayHour
Returns the current hour of the current day of the model run as the model steps through time.
CurrentDayInStudy
Returns the current day of the month of the model run.
CurrentDispatchHour
Returns the current dispatch hour of the model run as the model steps through time. Note that this enumerates hours in the run and does not return explicit information related to the date/time of the model. For example, if hour sampling parameters are set to run the model bi-hourly, this will still return a sequence of integers 1, 2,…
CurrentDispatchHourInStudy
This is the same command as CurrentDispatchHour except that it refers only to the current study. This is useful when running multiple scenarios.
CurrentHour
Returns the current hour of the current time in the model run as the model steps through time.
CurrentMonth
Returns the current month of the current time in the model run as the model steps through time.
CurrentMonthDispatchHours
Returns the total number of dispatch hours for the current month in the model run. This command provides information related to hour sampling settings in the project file.
CurrentMonthHour
Returns the current hour of month of the current time in the model run.
CurrentSerialDay
Not currently active.
CurrentWeekDay
Returns the current day of week of the current time in the model run.
CurrentWeekHour
Returns the current hour of week of the current time in the model run.
CurrentYear
Returns the year of the current time in the model run.
CurrentYearFromBase
Returns the number of years from the economic base year of the project file being used in the model run.
CurrentYearFromBasePlusOne
Returns the CurrentYearFromBase plus one.
CurrentYearFromBeg
Returns the number of years from the beginning year of the model run.
FirstDayOfTheYear
Returns the weekday of the first day of the current year. The convention for this command is that 1 corresponds to Monday, 2 to Tuesday, and so on.
HourInDispatch
Returns the current hour in the model run as the hour of sampled dispatch hours. The model runs starts with dispatch hour 1. This reflects which hours were sampled for the model run.
HourofYear
Returns the hour of the current year in the model run.
LastDispatchHour
Returns the last hour that was dispatched in the model run. This reflects hour sampling settings. If the user is running every hour, the first dispatch hour is equal to 1. Note that the first dispatch hour (equal to 1) falls on the first calendar day of the first month of the model run.
LastHourOfYear
Not used
LastPercentStudyCompleted
Returns the percent study completed through the hour before the current hour of the model run.
LTIteration
Returns the current iteration when running in long term optimization mode.
NumberofDaysInMonth
Returns the number of days in the current month of the model run.
NumberofDispatch
Returns the current hour in the model run as the hour of the total number of dispatch hours. This will always return a sequence of all successive positive integers with the last integer being equal to the total number of hours dispatched.
NumberofDispatchHoursInMonth
Returns the number of dispatch hours in the current month in the model run. Note that this counts hours being run so that it reflects hour sampling settings.
NumberofHoursInMonth
Returns the number of hours in the current month in the model run.
NumberofHoursInPreviousMonths
Returns the number of hours in all months in the year previous to the current month and for the current year.
NumberofHoursInThisYear
Returns the total number of hours for the current year.
NumberofHoursSinceLastDispatch
Returns the number of hours since the last dispatched hour. For example, if the user is running every day and every third hour, then the number of hours since last dispatch is always equal to 3.
NumberofOffsetHours
Returns the number of offset hours for the current year. The number of offset hour indicates the row number of the demand table that is being used as the first hour for the current year. For example, the number of offset hours for 2004 is 0 since 2001 starts on a Monday.
NumberofStudyYears
Returns the number of years being modeled in the current study.
OffsetHour
Not used
OutputDataSetNumber
Not used
PercentStudyCompleted
Returns the percentage of the study that has been completed as of the current hour.
PreviousMonthHour
Returns the hour of the month previous to the current hour of the model run.
ReadError
Not used
RiskIteration
Returns the current risk iteration.
SampleHourFlag
Not used
StudyBeginMonth
Returns the first month of the model run.
StudyBeginYear
Returns the beginning year of the model run.
StudyEndMonth
Returns the last month of the model run.
StudyEndYear
Returns the ending year of the model run.
ThisDispatchDate
Returns the current date in the dispatch. Note that this will reflect hour sampling settings.
TotalDispatchHoursInStudy
Returns the total number of hours that the model dispatched for the study.
Scripting
VarSimT
