Public View Protected View Private View

All Frameworks Class Hierarchy This Framework Indexes Previous Next

DELPPRSystemItf Interface DELIPPRProductionDemand

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.

interface DELIPPRProductionDemand

Method Index

o AddProcesses(CATListValCATBaseUnknown_var,CATListValCATBaseUnknown_var): Adds Processes to the production demand.
o GetAllValidityPeriods(CATTime*&,int&): Gets all Validity Periods of the current production demand.
o GetDemandLevel(DELProductionDemandLevel&,CATTime*): Gets production demand Level.
o GetHighInfos(CATListValCATBaseUnknown_var&,CATListValCATBaseUnknown_var&,DELProductionDemandTimeUnit&,DELGetInfosProdDemDiag&,CATTime*): Gets the High level informations for the current production demand.
o GetLowInfos(CATListValCATBaseUnknown_var&,DELProductionDemandTimeUnit&,CATListOfInt&,CATTime*): Gets the Low level informations for the current production demand.
o GetMediumInfos(CATListValCATBaseUnknown_var&,CATListValCATBaseUnknown_var&,DELProductionDemandTimeUnit&,CATListOfInt&,DELGetInfosProdDemDiag&,CATTime*): Gets the Medium level informations for the current production demand.
o GetNameOfProductionDemand(CATUnicodeString&,CATTime*): Get the name of the production demand
o GetProcesses(CATListValCATBaseUnknown_var&,CATListValCATBaseUnknown_var&,CATTime*): Gets Processes in the production demand valid for a given period.
o GetTimeUnit(DELProductionDemandTimeUnit&,CATTime*): Gets Time Unit It gets Time Unit
o RemoveValidityPeriod(CATTime): Removes an existing Period.
o SetHighInfos(CATListValCATBaseUnknown_var,CATListValCATBaseUnknown_var,DELProductionDemandTimeUnit,CATTime*): Sets the High level informations of the current production demand.
o SetLowInfos(CATListValCATBaseUnknown_var,DELProductionDemandTimeUnit,CATListOfInt,CATTime*): Sets the Low level informations for the current production demand.
o SetMediumInfos(CATListValCATBaseUnknown_var,CATListValCATBaseUnknown_var,DELProductionDemandTimeUnit,CATListOfInt,CATTime*): Sets the Medium level informations of the current production demand.
o SetNameOfProductionDemand(CATUnicodeString,CATTime*): Set the name of the production demand
o SetTimeUnit(DELProductionDemandTimeUnit,CATTime*): Sets Time Unit It sets Time Unit

o DELGetInfosProdDemDiag: Definition of the info error diagnostics.
o DELProductionDemandLevel: Definition of the production demand levels.
o DELProductionDemandTimeUnit: Definition of the time units used in production demand.

Methods

o AddProcesses

public virtual AddProcesses(		`iListProcesses`,
		`iListConfigFilters`)

Adds Processes to the production demand. It adds Processes to the production demand. It enables the users to associate a variant of process to the production demand by precizing the configuration filter to apply to the process.

Parameters:

iListProcesses: The list of processes to associated to the current production demand.
iListConfigFilters: The list of configuration filters to apply to each process if you want to define variants. The configuration filters can be NULL_var. If they are all NULL_var you can give an empty list. This list must have same size as iListProcesses or be empty.

Returns:

Legal values:

S_OK : The method successfully ended.
E_INVALIDARG : Wrong size of iListProcesses and iListConfigFilters or contains wrong data.
E_FAIL : An error occurred.

o GetAllValidityPeriods

public virtual GetAllValidityPeriods(		`opBeginDates`,
		`oNbBeginDate`)

Gets all Validity Periods of the current production demand. It gets all Validity Periods of the current production demand.

Parameters:

opBeginDates: Returns the tab of begin dates. Pointer must be deleted by using CATSysDeleteTab().
oNbBeginDate: Number of begin dates returned.

Returns:

Legal values:

S_OK : The method successfully ended.
E_FAIL : An error occurred.

o GetDemandLevel

public virtual GetDemandLevel(		`oDemandLevel`,
		`ipDate`	`= NULL`)

Gets production demand Level. It gets the level of data information stored in the current production demand

Parameters:

oDemandLevel: Returns the level of data information stored in the current production demand
iDate: Date for which you search the demand level.

Returns:

Legal values:

S_OK : The method successfully ended.
E_FAIL : An error occurred.
There is more than one production demand and no date has been specified

o GetHighInfos

public virtual GetHighInfos(	`oListProcesses`,
	`oListConfigFilters`,
	`oTimeUnit`,
	`oDiag`,
	`ipDate`	`= NULL`)

Gets the High level informations for the current production demand. In case a validity period is provided, the information is retrevied for the specified validity period It gets the High level informations the current production demand.

Parameters:

oListProcesses: List of Processes to produce for this period. They are ordered in the list in the order you want to produce them. The first one in the list is the first one you want to produce.
oListConfigFilters: List of configuration filters to apply to processes to define variants. Configuration filters can be NULL_var.
oTimeUnit: Time Unit in which you must produce the processes.
oDiag: Error Diagnostic.
ipDate: The applicable Validity period will be retrieved from iDate.

Returns:

Legal values:

S_OK : The method successfully ended.
E_FAIL : If data stored are from Low level. Then oDIAg equals to "LOW_DATA_STORED".
or if data stored are from Medium level. Then oDiag equals to "MEDIUM_DATA_STORED". .
The production demand has more than one validity period and no date has been specified
or An error occurred.

o GetLowInfos

public virtual GetLowInfos(	`oListProcesses`,
	`oTimeUnit`,
	`oListQuantities`,
	`ipDate`	`= NULL`)

Gets the Low level informations for the current production demand. In case a validity period is provided, the information is retrevied for the specified validity period It gets the Low level informations for the current production demand.

Parameters:

oListProcesses: List of Processes to produce for this period.
oTimeUnit: Time Unit in which you must produce the processes.
oListQuantities: Quantities of processes you must produce.
ipDate: The applicable Validity period will be retrieved from iDate.

Returns:

Legal values:

S_OK : The method successfully ended.
E_FAIL : An error occurred.
The production demand has more than one validity period and no date has been specified

o GetMediumInfos

public virtual GetMediumInfos(	`oListProcesses`,
	`oListConfigFilters`,
	`oTimeUnit`,
	`oListQuantities`,
	`oDiag`,
	`ipDate`	`= NULL`)

Gets the Medium level informations for the current production demand. In case a validity period is provided, the information is retrevied for the specified validity period It gets the Medium level informations for the current production demand.

Parameters:

oListProcesses: List of Processes to produce for this period.
oListConfigFilters: List of configuration filters to apply to processes to define variants. Some of them can be NULL_var.
oTimeUnit: Time Unit in which you must produce the processes.
oListQuantities: Quantities of processes you must produce.
oDiag: Error Diagnostic.
ipDate: The applicable Validity period will be retrieved from iDate.

Returns:

Legal values:

S_OK : The method successfully ended.
E_FAIL : If data stored are from Low level. Then oDIAg equals to "LOW_DATA_STORED". .
The production demand has more than one validity period and no date has been specified
or An error occurred.

o GetNameOfProductionDemand

public virtual GetNameOfProductionDemand(		`oProductionDemandName`,
		`ipDate`	`= NULL`)

Get the name of the production demand

Parameters:

oProductionDemandName: The name of the production demand
ipDate: The validity period of the production demand

Returns:

Legal values:

S_OK : The method successfully ended.
E_FAIL : An error occurred.

o GetProcesses

public virtual GetProcesses(	`oListProcesses`,
	`oListConfigFilters`,
	`ipDate`	`= NULL`)

Gets Processes in the production demand valid for a given period. It gets Processes in the production demand valid for a given period. If the validity period is NULL_var it gets all the processes of the production demand.

Parameters:

oListProcesses: Returns the list of processes associated to the current production demand.
oListConfigFilters: Returns the list of configuration filters to apply to each process when variants are defined. The configuration filters can be NULL_var.
ipDate: The Date for which you want to retrieve Processes. The applicable Validity period will be retrieved from this date. It can be NULL. In this case, all the processes of the production demand are retreived.

Returns:

Legal values:

S_OK : The method successfully ended.
E_INVALIDARG : iValidityPeriod not a validity period feature.
E_FAIL : An error occurred.

o GetTimeUnit

public virtual GetTimeUnit(		`oTimeUnit`,
		`iDate`	`= NULL`)

Gets Time Unit It gets Time Unit

Parameters:

oTimeUnit: Returns the associated Time Unit.
iDate: The date for which you wants to get the Time Unit. The applicable Validity period will be retrieved from this date.

Returns:

Legal values:

S_OK : The method successfully ended.
E_FAIL : An error occurred.

o RemoveValidityPeriod

public virtual RemoveValidityPeriod( iBeginDate)

Removes an existing Period. It removes an existing Validity Period.

Parameters:

iBeginDate: The begin date of the Vailidity Period to remove. The applicable Validity period will be retrieved from this date.

Returns:

Legal values:

S_OK : The method successfully ended.
E_FAIL : An error occurred.

o SetHighInfos

public virtual SetHighInfos(	`iListProcesses`,
	`iListConfigFilters`,
	`iTimeUnit`,
	`ipDate`	`= NULL`)

Sets the High level informations of the current production demand. It sets the High level informations of the current production demand.

Parameters:

iListProcesses: List of Processes to produce for this period. Same process can be set sevral times. They must be ordered in the list in the order you want to produce them. The first one in the list is the first one you want to produce.
iListConfigFilters: List of configuration filters to apply to processes to define variants. Configuration filters can be NULL_var.
iTimeUnit: Time Unit in which you must produce the processes.
ipDate: The applicable Validity period will be retrieved from iDate.

Returns:

Legal values:

S_OK : The method successfully ended.
E_INVALIDARG : iListProcesses and iListConfigFilters have not same size.
or same process is set twice in iListProcesses.
or iListProcesses component is not a Process reference.
E_FAIL : An error occurred.

o SetLowInfos

public virtual SetLowInfos(	`iListProcesses`,
	`iTimeUnit`,
	`iListQuantities`,
	`ipDate`	`= NULL`)

Sets the Low level informations for the current production demand. It sets the Low level informations for the current production demand.

Parameters:

iListProcesses: List of Processes references to produce. Same Process can not be set twice.
iTimeUnit: Time Unit in which you must produce the processes.
iListQuantities: Quantities of processes you must produce.
ipDate: The applicable Validity period will be retrieved from iDate.

Returns:

Legal values:

S_OK : The method successfully ended.
E_INVALIDARG : iListProcesses and iListQuantities have not same size.
or same process is set twice in iListProcesses.
or iListProcesses component is not a Process reference.
E_FAIL : An error occurred.

o SetMediumInfos

public virtual SetMediumInfos(	`iListProcesses`,
	`iListConfigFilters`,
	`iTimeUnit`,
	`iListQuantities`,
	`ipDate`	`= NULL`)

Sets the Medium level informations of the current production demand. It sets the Medium level informations of the current production demand.

Parameters:

iListProcesses: List of Processes to produce for this period. Same process can be set sevral times.
iListConfigFilters: List of configuration filters to apply to processes to define variants. Some of them can be NULL_var but not all because else it is Low level information.
iTimeUnit: Time Unit in which you must produce the processes.
iListQuantities: Quantities of processes you must produce.
ipDate: The applicable Validity period will be retrieved from iDate.

Returns:

Legal values:

S_OK : The method successfully ended.
E_INVALIDARG : iListProcesses, iListConfigFilters and iListQuantities have not same size.
or iListConfigFilters is full of NULL_var values.
or iListConfigFilters component is not a Filter.
or iListProcesses component is not a Process reference.
E_FAIL : An error occurred.

o SetNameOfProductionDemand

public virtual SetNameOfProductionDemand(		`iProductionDemandName`,
		`ipDate`	`= NULL`)

Set the name of the production demand

Parameters:

iProductionDemandName: The name of the production demand
ipDate: The validity period of the production demand

Returns:

Legal values:

S_OK : The method successfully ended.
E_FAIL : An error occurred.

o SetTimeUnit

public virtual SetTimeUnit(		`iTimeUnit`,
		`iDate`	`= NULL`)

Sets Time Unit It sets Time Unit

Parameters:

iTimeUnit: Time Unit to set.
iDate: The date for which you wants to set the Time Unit. The applicable Validity period will be retrieved from this date.

Returns:

Legal values:

S_OK : The method successfully ended.
E_FAIL : An error occurred.

Enumerated Types

o DELGetInfosProdDemDiag

enum DELGetInfosProdDemDiag {
  LOW_DATA_STORED,
  MEDIUM_DATA_STORED
}

Definition of the info error diagnostics.

Parameters:

LOW_DATA_STORED: Low Data Stored in Medium or High Production Demand
MEDIUM_DATA_STORED: Meidum Data Stored in High Production Demand

o DELProductionDemandLevel

enum DELProductionDemandLevel {
  Low,
  Medium,
  High
}

Definition of the production demand levels.

Parameters:

Low: Low Production Demand level
Medium: Medium Production Demand level
High: High Production Demand Level

o DELProductionDemandTimeUnit

enum DELProductionDemandTimeUnit {
  Hour,
  Day,
  Week,
  Month,
  Quarter,
  Half_Year,
  Year
}

Definition of the time units used in production demand.

Parameters:

Hour: Hour
Day: Day
Week: Week
Month: Month
Quarter: Quarter
Half_Year: Half_Year
Year: Year

This object is included in the file: DELIPPRProductionDemand.h
If needed, your Imakefile.mk should include the module: DELPPRSystemItf

DELPPRSystemItf Interface DELIPPRProductionDemand

Method Index

Enumerated Type Index

Methods

Enumerated Types