KnowledgeInterfaces Interface CATIParmManipulator

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

interface CATIParmManipulator

Interface dedicated to parameters manipulator management.
Role: A manipulator is an object to be associated to one or several parameters. with CATICkeParm::Setmanipulator (m) method

It gathers informations about how the literal can be modified - range (min,max) And it collects informations accessible in literals Spinner editors - step - old steps - old values Double used in this interface are in Model unit if any (millimeter and degree)

It makes sense only on literal and volatile values.

See also:

Method Index


o AccurateRange(double&,int&,double&,int&)
Gets range values (min and max).
o GetEnumerateValues(void*)
Get the list of enumerate values.
o GetParameter(CATBaseUnknown_var&)
Retrieves the parameter manipulated by the manipulator.
o HasMultipleValues()
Indicates if the parameter is multiple valuated.
o NbSteps()
Returns the number of steps remembered by the system.
o NbValues()
Returns the number of old values to remember by the system.
o SetAccurateRange(double,int,double,int)
Sets range values (min and max).
o SetEnumerateValues(void*)
Initialization of the list of enumerate values.
o SetNbSteps(int)
Sets the number of steps remembered by the system (contextual menu).
o SetNbValues(int)
Sets the number of old values to remember by the system (contextual menu).
o SetStep(double)
Adds a step to the steps remembered.
o SetValue(double)
Adds a value to the old values remembered.
o Step()
Returns the last step used.
o Steps()
Returns the list of last steps used.
o SuppressEnumerateValues()
Destroys the list of enumerate values on the parameter.
o TestValue(double,CATICkeMagnitude_var&)
Tests if a given value is authorized considering bounds, authorized values, etc.
o Values()
Returns the ist of last old values.

Enumerated Type Index


o TestRC

Methods


o AccurateRange
public virtual AccurateRange( oRmin,
oBmin,
oRmax,
oBmax)
Gets range values (min and max).
Parameters:
oRmin
minimum value in model unit
oBmin
0 if no minimum defined, 1 if defined and can be reached, 2 if defined and can not be reached, 3 if defined, can be reached and is not modifiable by the final user, 4 if defined, can not be reached and is not modifiable by the final user
oRmax
maximum value in model unit
oBmax
0 if no maximum defined, 1 if defined and can be reached, 2 if defined and can not be reached, 3 if defined, can be reached and is not modifiable by the final user, 4 if defined, can not be reached and is not modifiable by the final user
o GetEnumerateValues
public virtual GetEnumerateValues( iList)
Get the list of enumerate values. (last entered element is at the end of the list) For string parameters, iList is a pointer to a CATListOfCATUnicodeString provided as input of the method. The list if filled by the method
For other parameters, iList is a pointer to a CATListOfDouble provided as input of the method.The list if filled by the method
Parameters:
iList
list of available values (not to be deallocated)
o GetParameter
public virtual GetParameter( oParameter)
Retrieves the parameter manipulated by the manipulator.
Parameters:
oParameter
the parameter manipulated
Returns:
S_OK
if a parameter has been found
E_FAIL
if no parameter has been found
o HasMultipleValues
public virtual HasMultipleValues()
Indicates if the parameter is multiple valuated.
Returns:
0 if one value, 1 if list of values
o NbSteps
public virtual NbSteps()
Returns the number of steps remembered by the system.
o NbValues
public virtual NbValues()
Returns the number of old values to remember by the system.
o SetAccurateRange
public virtual SetAccurateRange( const iRmin,
const iBmin,
const iRmax,
const iBmax)
Sets range values (min and max).
Parameters:
iRmin
minimum value in model unit
iBmin
0 if no minimum defined, 1 if defined and can be reached, 2 if defined and can not be reached, 3 if defined, can be reached and is not modifiable by the final user, 4 if defined, can not be reached and is not modifiable by the final user
iRmax
maximum value in model unit
iBmax
0 if no maximum defined, 1 if defined and can be reached, 2 if defined and can not be reached, 3 if defined, can be reached and is not modifiable by the final user, 4 if defined, can not be reached and is not modifiable by the final user
o SetEnumerateValues
public virtual SetEnumerateValues( iList)
Initialization of the list of enumerate values. (last entered element is at the end of the list) For string parameters, iList is a pointer to a CATListOfCATUnicodeString provided as input of the method.
For other parameters, iList is a pointer to a CATListOfDouble provided as input of the method.
Parameters:
iList
list of available values
o SetNbSteps
public virtual SetNbSteps( const iNb)
Sets the number of steps remembered by the system (contextual menu).
Parameters:
iNb
number of steps to remember
o SetNbValues
public virtual SetNbValues( const iNb)
Sets the number of old values to remember by the system (contextual menu).
Parameters:
iNb
number of old values to remember
o SetStep
public virtual SetStep( const iValue)
Adds a step to the steps remembered. become last step).
Parameters:
iValue
step added in model unit
o SetValue
public virtual SetValue( const iValue)
Adds a value to the old values remembered. (become last value)
Parameters:
iValue
value added in model unit
o Step
public virtual Step()
Returns the last step used.
Returns:
last step in model unit
o Steps
public virtual Steps()
Returns the list of last steps used.
Returns:
list of last steps used in model unit (not to be deallocated)
o SuppressEnumerateValues
public virtual SuppressEnumerateValues()
Destroys the list of enumerate values on the parameter.
o TestValue
public virtual TestValue( const iValue,
const iMag= NULL_var)
Tests if a given value is authorized considering bounds, authorized values, etc...
Parameters:
iValue
value to be tested
iMag
magnitude
Returns:
indicates if value is authorized
o Values
public virtual Values()
Returns the ist of last old values. (last entered element is at the end of the list)
Returns:
list of last values used in model unit (not to be deallocated)

Enumerated Types


o TestRC 
enum TestRC {
  Ok,
  MinReached,
  MaxReached,
  NotInEnum,
  NotAuthorized
}
This object is included in the file: CATIParmManipulator.h
If needed, your Imakefile.mk should include the module: KnowledgeItf

Copyright © 1999-2015, Dassault Systèmes. All rights reserved.