IMsModelPeriod

Assembly: Ms;

Namespace: Prognoz.Platform.Interop.Ms;

Description

The IMsModelPeriod interface contains properties used to determine sample and forecast periods.

Inheritance Hierarchy

IMsModelPeriod

Comments

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 forecast period start date.
ForecastEnd. Forecast 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.

Properties

	Property name	Brief description
	AllowForecastBeforeIdent	The AllowForecastBeforeIdent property determines whether forecast period is available before sample period.
	AutoPeriod	The AutoPeriod property determines the conditions used to calculate start and end dates of sample and forecast periods.
	ForecastAutoEndDate	The ForecastAutoEndDate property returns forecast period end date if conditions are used for calculating of model calculation period limits.
	ForecastAutoStartDate	The ForecastAutoStartDate property returns forecast period start date if conditions are used for calculating of model calculation period limits.
	ForecastEndDate	The ForecastEndDate property determines forecast period end date.
	ForecastEndDateParamID	The ForecastEndDateParamID property determines identifier of the parameter that sets forecast period end date.
	ForecastEndOffset	The ForecastEndOffset property determines the number of periods by which the forecast period end date is offset.
	ForecastStartDate	The ForecastStartDate property determines forecast period start date.
	ForecastStartDateParamID	The ForecastStartDateParamID property determines identifier of the parameter that sets forecast period start date.
	ForecastStartOffset	The ForecastStartOffset property determines the number of periods by which the forecast period start date is offset.
	IdentificationAutoEndDate	The IdentificationAutoEndDate property returns sample period end date if conditions are used for calculating of model calculation period limits.
	IdentificationAutoStartDate	The IdentificationAutoStartDate property returns sample period start date if conditions are used for calculating of model calculation period limits.
	IdentificationEndDate	The IdentificationEndDate property determines the sample period end date.
	IdentificationEndDateParamID	The IdentificationEndDateParamID property determines identifier of the parameter that sets sample period end date.
	IdentificationEndOffset	The IdentificationEndOffset property determines the number of periods by which the sample period end date is offset.
	IdentificationStartDate	The IdentificationStartDate property determines the sample period start date.
	IdentificationStartDateParamID	The IdentificationStartDateParamID property determines identifier of the parameter that sets sample period start date.
	IdentificationStartOffset	The IdentificationStartOffset property determines the number of periods by which the sample period start date is offset.
	UseForecastStart	The UseForecastStart property determines whether forecast start date should be used.

Methods

	Method name	Brief description
	Assign	The Assign method copies parameters of the specified period to the current period.
	AutoPeriodDates	The AutoPeriodDates method returns limits of model calculation period if conditions are used for calculating start and end dates of sample and forecast periods.
	GetLevelDate	The ObtainLevelDate method returns start date and time for selected period.
	GetPeriodSize	The ObtainPeriodSize method returns the number of periods in selected time span.