All Frameworks  Class Hierarchy  This Framework  Indexes   

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.


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 GetNumberOfSolutionsToFind()
Get a maximal number of solutions those should be found during calculations.
o GetNumberOfSolutions()
Get number of the found solutions.
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 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:
iSymbolic
=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.
o GetBlackBoxParameters
public virtual GetBlackBoxParameters( oPars)
Get blackbox parameters.
o GetCalculationTime
public virtual GetCalculationTime()
Get current time (milliseconds).
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.
o GetErrorDescription
public virtual GetErrorDescription( oDescrition)
Get error description.
o GetExpectedTime
public virtual GetExpectedTime()
Get expected time (milliseconds).
o GetMaxCalculationTime
public virtual GetMaxCalculationTime()
Get a maximal calculation time.
o GetNumberOfSolutionsToFind
public virtual GetNumberOfSolutionsToFind()
Get a maximal number of solutions those should be found during calculations.
o GetNumberOfSolutions
public virtual GetNumberOfSolutions()
Get number of the found solutions.
o GetPrecision
public virtual GetPrecision()
Get a calculation precision.
o GetSolutionsDistance
public virtual GetSolutionsDistance()
Get the minimal distance between solutions.
o GetStatus
public virtual GetStatus( oStatus)
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
public virtual GetTimerId()
The function returns a timer id for the time of solving Set of Equations.
Returns:
a timer id
o GetUpdateNotification
public virtual GetUpdateNotification()
Get own 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
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.
o SelectSolution
public virtual SelectSolution( iIdxSol)
Set the solution as a current one.
Parameters:
iIdxSol
a number of the solution.
o SetBlackBoxParameters
public virtual SetBlackBoxParameters( iPars)
Set blackbox parameters.
o SetCalculationTime
public virtual SetCalculationTime( iTime)
Set current time.
Parameters:
iTime
a current time (milliseconds)
o SetExpectedTime
public virtual SetExpectedTime( iTime)
Set expected time.
Parameters:
iTime
a expected time (milliseconds)
o SetMaxCalculationTime
public virtual SetMaxCalculationTime( iMaxTime)
Set a maximal duration of the current model calculations.
Parameters:
iMaxTime
a maximal time (seconds)
o SetNumberOfSolutionsToFind
public virtual SetNumberOfSolutionsToFind( inSol)
Set a maximal number of solutions those should be found during calculations.
Parameters:
inSol
a number of solutions
o SetParameterAsInput
public virtual SetParameterAsInput( iParameter)
Specifies that the parameter must be considered as input parameter.
Parameters:
The
parameter to set up as input of the SetOfEquationObject
o SetParameterAsOutput
public virtual SetParameterAsOutput( iParameter)
Specifies that the parameter must be considered as output parameter.
Parameters:
The
parameter to set up as input of the SetOfEquationObject
o SetParametersAsInput
public virtual SetParametersAsInput( iParameter)
Specifies that the parameter must be considered as input parameter.
Parameters:
The
parameter to set up as input of the SetOfEquationObject
o SetParametersAsOutput
public virtual SetParametersAsOutput( iParameter)
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 SetPrecision( iEps)
Set a calculation precision.
o SetSolutionsDistance
public virtual SetSolutionsDistance( iEps)
Set the minimal distance between solutions.
o SetStatus
public virtual SetStatus( iStatus)
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 SetTimerId( iTimerId)
The function sets a timer id for the time of solving Set of Equations.
Parameters:
iTimerId
a time id
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
o UseErrorDescription
public virtual UseErrorDescription( iError=2)
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 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:
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

Copyright © 2003, Dassault Systèmes. All rights reserved.