Assembly: Ms;
The IMsModelPeriod interface contains properties that are used to determine sample and forecasting periods.
IMsModelPeriod
If the period limits are specified incorrectly, they are changed automatically in the following way:
If IdentStart > IdentEnd, then IdentEnd = IdentStart.
If IdentStart > ForecastStart, then ForecastStart = IdentStart.
If IdentEnd > ForecastStart, then ForecastStart = IdentEnd.
If IdentEnd > ForecastEnd, then IdentEnd = ForecastEnd.
If ForecastStart > ForecastEnd, then ForecastStart = ForecastEnd.
Where:
IdentStart. Sample period start date
IdentEnd. Sample period end date
ForecastStart. The forecasting period start date.
ForecastEnd. Forecasting period start date
NOTE. In the above-listed cases, the warning about incorrectly set calculation limits is displayed, and the model is calculated by the changed period limits.
If ForecastEnd < IdentStart, borders of periods are not changed, the message about incorrect calculation borders appears, the calculation of the model is not interrupted, but the output series is not changed.
Property name | Brief description | |
The AllowForecastBeforeIdent property determines whether forecasting period is available before sample period. | ||
The AutoPeriod property determines the conditions that are used to calculate start and end dates of sample and forecasting periods. | ||
The ForecastAutoEndDate property returns forecasting period end date if conditions are used for calculating of model calculation period limits. | ||
The ForecastAutoStartDate property returns forecasting period start date if conditions are used for calculating of model calculation period limits. | ||
The ForecastEndDate property determines forecasting period end date. | ||
The ForecastEndDateCoord property determines settings of the coordinate that sets forecasting period end date. | ||
The ForecastEndDateParam property determines binding settings for the parameter that sets forecasting period end date. | ||
The ForecastEndOffset property determines the number of periods, by which the forecasting period end date is offset. | ||
The ForecastStartDate property determines forecasting period start date. | ||
The ForecastStartDateCoord property determines settings of the coordinate that sets forecasting period start date. | ||
The ForecastStartDateParam property determines binding settings for the parameter that sets forecasting period start date. | ||
The ForecastStartOffset property determines the number of periods, by which the forecasting period start date is offset. | ||
The IdentificationAutoEndDate property returns sample period end date if conditions are used for calculating of model calculation period limits. | ||
The IdentificationAutoStartDate property returns sample period start date if conditions are used for calculating of model calculation period limits. | ||
The IdentificationEndDate property determines the sample period end date. | ||
The IdentificationEndDateCoord property determines settings of the coordinate that sets sample period end date. | ||
The IdentificationEndDateParam property determines binding settings for the parameter that sets sample period end date. | ||
The IdentificationEndOffset property determines the number of periods by which the sample period end date is offset. | ||
The IdentificationStartDate property determines the sample period start date. | ||
The IdentificationStartDateCoord property determines settings of the coordinate that sets sample period start date. | ||
The IdentificationStartDateParam property determines binding settings for the parameter that sets sample period start date. | ||
The IdentificationStartOffset property determines the number of periods by which the sample period start date is offset. | ||
The UseForecastStart property determines whether forecast start date should be used. |
Method name | Brief description | |
The Assign method copies parameters of the specified period to the current period | ||
The AutoPeriodDates method returns limits of model calculation period if conditions are used for calculating start and end dates of sample and forecasting periods. | ||
The ObtainLevelDate method returns start date and time for selected period. | ||
The ObtainPeriodSize method returns the number of periods in selected time span. |
See also: