All Frameworks Class Hierarchy This Framework Previous Next Indexes
KnowledgeInterfaces Interface CATICkeSetOfEquations
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATICkeSetOfEquations
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATICkeSetOfEquations
Interface dedicated to the management of Set of Equations.
Method Index
- o
ControlCallBackInitializing(int,int)
- Control the initializing/finalizing CATIASubdefiniteCallBack.
- o
DisplayStopDialog(int)
- Get/set the flag which is indicated if the "Stop Dialog" should be created.
- o
FindNextSolutions(unsigned)
- Find several next solutions.
- o
GetBlackBoxParameters(BlackboxParameters&)
- Get blackbox parameters.
- o
GetCalculationTime()
- Get current time (milliseconds).
- o
GetConstraintDescription(long,CATUnicodeString&,unsigned&,boolean&)
- Get description of the constraint.
- o
GetErrorDescription(CATUnicodeString&)
- Get error description.
- o
GetExpectedTime()
- Get expected time (milliseconds).
- o
GetMaxCalculationTime()
- Get a maximal calculation time.
- o
GetNumberOfSolutions()
- Get number of the found solutions.
- o
GetNumberOfSolutionsToFind()
- Get a maximal number of solutions those should be found during calculations.
- o
GetPrecision()
- Get a calculation precision.
- o
GetSolutionsDistance()
- Get the minimal distance between solutions.
- o
GetStatus(int&)
- Get the status of the set of equation.
- o
GetTimerId()
- The function returns a timer id for the time of solving Set of Equations.
- o
GetUpdateNotification()
- Get own notification.
- o
NumberOfShownSolutions(int)
- Set a number of shown solutions.
- o
RestoreResults(CATISpecObject_var&,int&)
- Restore DesingTable (results of CS) and state.
- o
RunHasToStop(int)
- Get/set a terminate flag.
- o
SelectSolution(unsigned)
- Set the solution as a current one.
- o
SetBlackBoxParameters(BlackboxParameters&)
- Set blackbox parameters.
- o
SetCalculationTime(unsigned long)
- Set current time.
- o
SetExpectedTime(unsigned long)
- Set expected time.
- o
SetMaxCalculationTime(unsigned long)
- Set a maximal duration of the current model calculations.
- o
SetNumberOfSolutionsToFind(unsigned long)
- Set a maximal number of solutions those should be found during calculations.
- o
SetParameterAsInput(CATICkeParm*)
- Specifies that the parameter must be considered as input parameter.
- o
SetParameterAsOutput(CATICkeParm*)
- Specifies that the parameter must be considered as output parameter.
- o
SetParametersAsInput(CATCkeListOfParm)
- Specifies that the parameter must be considered as input parameter.
- o
SetParametersAsOutput(CATCkeListOfParm)
- Specifies that the parameter must be considered as output parameter.
- o
SetPrecision(double)
- Set a calculation precision.
- o
SetSolutionsDistance(double)
- Set the minimal distance between solutions.
- o
SetStatus(int)
- Set the status of the set of equation.
- o
SetTimerId(CATTimerId)
- The function sets a timer id for the time of solving Set of Equations.
- o
StoreResults(CATISpecObject_var&,int)
- Store DesingTable (results of CS) and state.
- o
UseErrorDescription(int)
- Get/set status of using the Smart Error localization.
- o
UseGaussElimination(int)
- Get/set status of using the Gauss method for linear equations.
- o
UseWarningLevel(int)
- Get/set status of using additional warnings.
Methods
o ControlCallBackInitializing
public virtual int ControlCallBackInitializing( | int | iStep, |
| int | iState)= 0 |
-
Control the initializing/finalizing CATIASubdefiniteCallBack.
- Parameters:
-
- iStep
- =0 - initializing; =1 - finalizing.
- iState
- =0 - doesn`t performs; =1 - performs;
=2 - performs, but only 1 time;
=3 - show current state.
- Returns:
- a current status
o DisplayStopDialog
public virtual int DisplayStopDialog( | int | iUsed | =2)= 0 |
-
Get/set the flag which is indicated if the "Stop Dialog" should be created.
- Parameters:
-
- iSymbolic
- =0 - don`t show "Stop Dialog"; =1 - show "Stop Dialog";
=2 - get current status.
- Returns:
- a current status
o FindNextSolutions
public virtual HRESULT FindNextSolutions( | unsigned | iNsols)= 0 |
-
Find several next solutions.
- Parameters:
-
- iNsols
- a number of calculated solutions.
o GetBlackBoxParameters
public virtual HRESULT GetBlackBoxParameters( | BlackboxParameters& | oPars)= 0 |
-
Get blackbox parameters.
o GetCalculationTime
public virtual unsigned long GetCalculationTime( | )= 0 |
-
Get current time (milliseconds).
o GetConstraintDescription
public virtual HRESULT GetConstraintDescription( | long | iCnt, |
| CATUnicodeString& | oDescrition, |
| unsigned& | oCount, |
| boolean& | oErr)= 0 |
-
Get description of the constraint. Work with Smart Error localization only.
- Parameters:
-
- iCnt
- a number of the constraint.
- oDescrition
- a view of the constraint.
- oCount
- a number of calls of the constraint.
- oErr
- 1 if the contradiction occured in the constraint.
o GetErrorDescription
-
Get error description.
o GetExpectedTime
public virtual unsigned long GetExpectedTime( | )= 0 |
-
Get expected time (milliseconds).
o GetMaxCalculationTime
public virtual unsigned long GetMaxCalculationTime( | )= 0 |
-
Get a maximal calculation time.
o GetNumberOfSolutions
public virtual int GetNumberOfSolutions( | )= 0 |
-
Get number of the found solutions.
o GetNumberOfSolutionsToFind
public virtual unsigned long GetNumberOfSolutionsToFind( | )= 0 |
-
Get a maximal number of solutions those should be found during calculations.
o GetPrecision
public virtual double GetPrecision( | )= 0 |
-
Get a calculation precision.
o GetSolutionsDistance
public virtual double GetSolutionsDistance( | )= 0 |
-
Get the minimal distance between solutions.
o GetStatus
public virtual HRESULT GetStatus( | int& | oStatus)= 0 |
-
Get the status of the set of equation.
0 = unknown.
1 = solved.
2 = no solution found.
3 = Evaluation error.
4 = Interruption.
5 = all solutions found.
o GetTimerId
-
The function returns a timer id for the time of solving Set of Equations.
- Returns:
- a timer id
o GetUpdateNotification
-
Get own notification.
o NumberOfShownSolutions
public virtual unsigned long NumberOfShownSolutions( | int | iNSol)= 0 |
-
Set a number of shown solutions.
The method is used to get a count of shown solutions to "Stop Dialog"
- Parameters:
-
- iNSol
- a number of solutions. If iNSol==-1 then the count doesn`t modified.
- Returns:
- a current number of shown solutions.
o RestoreResults
public virtual HRESULT RestoreResults( | CATISpecObject_var& | oTable, |
| int& | oState)= 0 |
-
Restore DesingTable (results of CS) and state.
- Parameters:
-
- oTable
- a table of solutions
- oState
- a state of CS
o RunHasToStop
public virtual int RunHasToStop( | int | iAction | =2)= 0 |
-
Get/set a terminate flag.
- Parameters:
-
- iAction
- =0 - reset the flag; =1 - set the flag;
=2 - get the flag.
o SelectSolution
public virtual HRESULT SelectSolution( | unsigned | iIdxSol)= 0 |
-
Set the solution as a current one.
- Parameters:
-
- iIdxSol
- a number of the solution.
o SetBlackBoxParameters
public virtual HRESULT SetBlackBoxParameters( | BlackboxParameters& | iPars)= 0 |
-
Set blackbox parameters.
o SetCalculationTime
public virtual HRESULT SetCalculationTime( | unsigned long | iTime)= 0 |
-
Set current time.
- Parameters:
-
- iTime
- a current time (milliseconds)
o SetExpectedTime
public virtual HRESULT SetExpectedTime( | unsigned long | iTime)= 0 |
-
Set expected time.
- Parameters:
-
- iTime
- a expected time (milliseconds)
o SetMaxCalculationTime
public virtual HRESULT SetMaxCalculationTime( | unsigned long | iMaxTime)= 0 |
-
Set a maximal duration of the current model calculations.
- Parameters:
-
- iMaxTime
- a maximal time (seconds)
o SetNumberOfSolutionsToFind
public virtual HRESULT SetNumberOfSolutionsToFind( | unsigned long | inSol)= 0 |
-
Set a maximal number of solutions those should be found during calculations.
- Parameters:
-
- inSol
- a number of solutions
o SetParameterAsInput
-
Specifies that the parameter must be considered as input parameter.
- Parameters:
-
- The
- parameter to set up as input of the SetOfEquationObject
o SetParameterAsOutput
-
Specifies that the parameter must be considered as output parameter.
- Parameters:
-
- The
- parameter to set up as input of the SetOfEquationObject
o SetParametersAsInput
-
Specifies that the parameter must be considered as input parameter.
- Parameters:
-
- The
- parameter to set up as input of the SetOfEquationObject
o SetParametersAsOutput
-
Specifies that the parameter must be considered as output parameter.
- Parameters:
-
- The
- parameter to set up as input of the SetOfEquationObject
o SetPrecision
public virtual HRESULT SetPrecision( | double | iEps)= 0 |
-
Set a calculation precision.
o SetSolutionsDistance
public virtual HRESULT SetSolutionsDistance( | double | iEps)= 0 |
-
Set the minimal distance between solutions.
o SetStatus
public virtual HRESULT SetStatus( | int | iStatus)= 0 |
-
Set the status of the set of equation.
0 = unknown.
1 = solved.
2 = no solution found.
3 = Evaluation error.
4 = Interruption.
5 = all solutions found.
o SetTimerId
public virtual void SetTimerId( | CATTimerId | iTimerId)= 0 |
-
The function sets a timer id for the time of solving Set of Equations.
- Parameters:
-
- iTimerId
- a time id
o StoreResults
public virtual HRESULT StoreResults( | CATISpecObject_var& | iTable, |
| int | iState)= 0 |
-
Store DesingTable (results of CS) and state.
- Parameters:
-
- iTable
- a table of solutions
- iState
- a current state of CS
o UseErrorDescription
public virtual int UseErrorDescription( | int | iError | =2)= 0 |
-
Get/set status of using the Smart Error localization.
- Parameters:
-
- iSymbolic
- =0 - don`t use Smart Error localization; =1 - use Smart Error localization;
=2 - get current status.
- Returns:
- a current status
o UseGaussElimination
public virtual int UseGaussElimination( | int | iSymbolic | =2)= 0 |
-
Get/set status of using the Gauss method for linear equations.
- Parameters:
-
- iSymbolic
- =0 - don`t use Gauss method; =1 - use Gauss method;
=2 - get current status.
- Returns:
- a current status
o UseWarningLevel
public virtual int UseWarningLevel( | int | iError | =2)= 0 |
-
Get/set status of using additional warnings.
- Parameters:
-
- iSymbolic
- =0 - don`t show additional warnings; =1 - show additional warnings;
=2 - get current status.
- Returns:
- a current status
This object is included in the file: CATICkeSetOfEquations.h
If needed, your Imakefile.mk should include the module: KnowledgeItf