KnowledgeInterfaces Interface 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 relations.
This interface requires the Knowledge Advisor license.
This interface is mono implemented
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
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
GetUpdateNotification()
- Get own notification.
- o
NumberOfShownSolutions(int)
- Set a number of shown solutions.
- o
RestoreResults(CATBaseUnknown_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
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
StoreResults(CATBaseUnknown_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 ControlCallBackInitializing( | | iStep, |
| | iState) |
-
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 DisplayStopDialog( | | iUsed | =2) |
-
Get/set the flag which is indicated if the "Stop Dialog" should be created.
- Parameters:
-
- iUsed
- =0 - don`t show "Stop Dialog"; =1 - show "Stop Dialog";
=2 - get current status.
- Returns:
- a current status
o FindNextSolutions
| public virtual FindNextSolutions( | | iNsols) |
-
Find several next solutions.
- Parameters:
-
- iNsols
- a number of calculated solutions.
- Returns:
- classic HRESULT
o GetCalculationTime
| public virtual GetCalculationTime( | ) |
-
Get current time (milliseconds).
- Returns:
- current time
o GetConstraintDescription
| public virtual GetConstraintDescription( | | iCnt, |
| | oDescrition, |
| | oCount, |
| | oErr) |
-
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.
- Returns:
- classic HRESULT
o GetErrorDescription
| public virtual GetErrorDescription( | | oDescrition) |
-
Get error description.
- Parameters:
-
- oDescrition
- error description
- Returns:
- classic HRESULT
o GetExpectedTime
| public virtual GetExpectedTime( | ) |
-
Get expected time (milliseconds).
- Returns:
- expected time
o GetMaxCalculationTime
| public virtual GetMaxCalculationTime( | ) |
-
Get a maximal calculation time.
- Returns:
- maximal calculation time
o GetNumberOfSolutions
| public virtual GetNumberOfSolutions( | ) |
-
Get number of the found solutions.
- Returns:
- number of solutions found
o GetNumberOfSolutionsToFind
| public virtual GetNumberOfSolutionsToFind( | ) |
-
Get a maximal number of solutions those should be found during calculations.
- Returns:
- maximal number of solutions those should be found during calculations.
o GetPrecision
| public virtual GetPrecision( | ) |
-
Get a calculation precision.
- Returns:
- the precision
o GetSolutionsDistance
| public virtual GetSolutionsDistance( | ) |
-
Get the minimal distance between solutions.
- Returns:
- the minimal distance between solutions
o GetStatus
| public virtual GetStatus( | | oStatus) |
-
Get the status of the set of equation.
- Parameters:
-
- oStatus
- 0 = unknown.
1 = solved.
2 = no solution found.
3 = Evaluation error.
4 = Interruption.
5 = all solutions found.
- Returns:
- classic HRESULT
o GetUpdateNotification
| public virtual GetUpdateNotification( | ) |
-
Get own notification.
- Returns:
- notification
o NumberOfShownSolutions
| public virtual NumberOfShownSolutions( | | iNSol) |
-
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 RestoreResults( | | oTable, |
| | oState) |
-
Restore DesingTable (results of CS) and state.
- Parameters:
-
- oTable
- a table of solutions
- oState
- a state of CS
- Returns:
- classic HRESULT
o RunHasToStop
| public virtual RunHasToStop( | | iAction | =2) |
-
Get/set a terminate flag.
- Parameters:
-
- iAction
- =0 - reset the flag; =1 - set the flag;
=2 - get the flag.
- Returns:
- the flag
o SelectSolution
| public virtual SelectSolution( | | iIdxSol) |
-
Set the solution as a current one.
- Parameters:
-
- iIdxSol
- a number of the solution.
- Returns:
- classic HRESULT
o SetCalculationTime
| public virtual SetCalculationTime( | | iTime) |
-
Set current time.
- Parameters:
-
- iTime
- a current time (milliseconds)
- Returns:
- classic HRESULT
o SetExpectedTime
| public virtual SetExpectedTime( | | iTime) |
-
Set expected time.
- Parameters:
-
- iTime
- a expected time (milliseconds)
- Returns:
- classic HRESULT
o SetMaxCalculationTime
| public virtual SetMaxCalculationTime( | | iMaxTime) |
-
Set a maximal duration of the current model calculations.
- Parameters:
-
- iMaxTime
- a maximal time (seconds)
- Returns:
- classic HRESULT
o SetNumberOfSolutionsToFind
| public virtual SetNumberOfSolutionsToFind( | | inSol) |
-
Set a maximal number of solutions those should be found during calculations.
- Parameters:
-
- inSol
- a number of solutions
- Returns:
- classic HRESULT
o SetParameterAsInput
| public virtual SetParameterAsInput( | | iParameter) |
-
Specifies that the parameter must be considered as input parameter.
- Parameters:
-
- iParameter
- The parameter to set up as input of the SetOfEquationObject
- Returns:
- classic HRESULT
o SetParameterAsOutput
| public virtual SetParameterAsOutput( | | iParameter) |
-
Specifies that the parameter must be considered as output parameter.
- Parameters:
-
- iParameter
- The parameter to set up as input of the SetOfEquationObject
- Returns:
- classic HRESULT
o SetParametersAsInput
| public virtual SetParametersAsInput( | | iParameter) |
-
Specifies that the parameter must be considered as input parameter.
- Parameters:
-
- iParameter
- The parameter to set up as input of the SetOfEquationObject
- Returns:
- classic HRESULT
o SetParametersAsOutput
| public virtual SetParametersAsOutput( | | iParameter) |
-
Specifies that the parameter must be considered as output parameter.
- Parameters:
-
- iParameter
- The parameter to set up as input of the SetOfEquationObject
- Returns:
- classic HRESULT
o SetPrecision
| public virtual SetPrecision( | | iEps) |
-
Set a calculation precision.
- Parameters:
-
- iEps
- calculation precision
- Returns:
- classic HRESULT
o SetSolutionsDistance
| public virtual SetSolutionsDistance( | | iEps) |
-
Set the minimal distance between solutions.
- Parameters:
-
- iEps
- minimal distance between solutions.
- Returns:
- classic HRESULT
o SetStatus
| public virtual SetStatus( | | iStatus) |
-
Set the status of the set of equation.
- Parameters:
-
- iStatus
- status 0 = unknown.
1 = solved.
2 = no solution found.
3 = Evaluation error.
4 = Interruption.
5 = all solutions found.
- Returns:
- classic HRESULT
o StoreResults
| public virtual StoreResults( | | iTable, |
| | iState) |
-
Store DesingTable (results of CS) and state.
- Parameters:
-
- iTable
- a table of solutions
- iState
- a current state of CS
- Returns:
- classic HRESULT
o UseErrorDescription
| public virtual UseErrorDescription( | | iError | =2) |
-
Get/set status of using the Smart Error localization.
- Parameters:
-
- iError
- =0 - don`t use Smart Error localization; =1 - use Smart Error localization;
=2 - get current status.
- Returns:
- a current status
o UseGaussElimination
| public virtual UseGaussElimination( | | iSymbolic | =2) |
-
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 UseWarningLevel( | | iError | =2) |
-
Get/set status of using additional warnings.
- Parameters:
-
- iError
- =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
Copyright © 1999-2015, Dassault Systèmes. All rights reserved.