All Frameworks  Class Hierarchy  This Framework  Indexes   

FittingInterfaces Interface CATISiFiManipSettingAtt

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


interface CATISiFiManipSettingAtt

Interface to handle parameters of DMU Manip Tools Options Tab page Role: This interface is implemented by a component which represents the controller of DMU Manip Tools Options parameter settings.


Method Index


o GetAngleStepInfo(CATSettingInfo*)
Retrieves the state of the AngleStepInfo parameter.
o GetAngleStep(float&)
Returns the Angle Step parameter
Role: Returns the Angle Step parameter
o GetClashModeInfo(CATSettingInfo*)
Retrieves the state of the ClashModeInfo parameter.
o GetClashMode(CATManipClashMode&)
Returns the ClashMode (manipulation mode) for simulation and tracks
Role: Returns the ClashMode (manipulation mode) for simulation and tracks
o GetClashSoundInfo(CATSettingInfo*)
Retrieves the state of the ClashSoundInfo parameter.
o GetClashSound(CATBoolean&)
Returns the Clash Sound parameter
Role: Returns the Clash Sound parameter
o GetDistanceStepInfo(CATSettingInfo*)
Retrieves the state of the DistanceStepInfo parameter.
o GetDistanceStep(float&)
Returns the Distance Step parameter
Role: Returns the Distance Step parameter
o GetManipAutoInsertInfo(CATSettingInfo*)
Retrieves the state of the ManipAutoInsertInfo parameter.
o GetManipAutoInsert(CATBoolean&)
Returns the ManipAutoInsert parameter
Role: Returns the ManipAutoInsert (Automatic insert for manipulation mode) parameter.
o GetRecordModeInfo(CATSettingInfo*)
Retrieves the state of the RecordModeInfo parameter.
o GetRecordMode(CATManipAutoInsertMode&)
Returns the RecordMode for Auto Insert configuration
Role: Returns the RecordMode for Auto Insert configuration
o GetSnapAngleDistanceInfo(CATSettingInfo*)
Retrieves the state of the SnapAngleDistanceInfo parameter.
o GetSnapAngleDistance(float&)
Returns the Snap Angle Distance parameter
Role: Returns the Angle Distance parameter of the Snap Sensitivity
o GetSnapPositionInfo(CATSettingInfo*)
Retrieves the state of the SnapPositionInfo parameter.
o GetSnapPosition(float&)
Returns the Snap Position parameter
Role: Returns the Position parameter of the Snap Sensitivity
o SetAngleStepLock(unsigned char)
Locks or unlocks the AngleStep parameter.
o SetAngleStep(float)
Sets the Angle Step parameter
Role: Sets the Angle Step parameter
o SetClashModeLock(unsigned char)
Locks or unlocks the ClashMode parameter.
o SetClashMode(CATManipClashMode)
Sets the ClashMode (manipulation mode) for simulation and tracks
Role: Sets the ClashMode (manipulation mode) for simulation and tracks
o SetClashSoundLock(unsigned char)
Locks or unlocks the ClashSound parameter.
o SetClashSound(CATBoolean)
Sets the Clash Sound parameter
Role: Sets the Clash Sound parameter
o SetDistanceStepLock(unsigned char)
Locks or unlocks the DistanceStep parameter.
o SetDistanceStep(float)
Sets the Distance Step parameter
Role: Returns the Distance Step parameter
o SetManipAutoInsertLock(unsigned char)
Locks or unlocks the ManipAutoInsert parameter.
o SetManipAutoInsert(CATBoolean)
Sets the ManipAutoInsert parameter
Role: Sets the ManipAutoInsert (Automatic insert for manipulation mode) parameter.
o SetRecordModeLock(unsigned char)
Locks or unlocks the RecordMode parameter.
o SetRecordMode(CATManipAutoInsertMode)
Sets the RecordMode for Auto Insert configuration
Role: Sets the RecordMode if angle limitation is being used
o SetSnapAngleDistanceLock(unsigned char)
Locks or unlocks the SnapAngleDistance parameter.
o SetSnapAngleDistance(float)
Sets the Snap Angle Distance parameter
Role: Sets the Angle Distance parameter of the Snap Sensitivity
o SetSnapPositionLock(unsigned char)
Locks or unlocks the SnapPosition parameter.
o SetSnapPosition(float)
Sets the Snap Position parameter
Role: Sets the Position parameter of the Snap Sensitivity

Methods


o GetAngleStepInfo
public virtual GetAngleStepInfo( oInfo)
Retrieves the state of the AngleStepInfo parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetAngleStep
public virtual GetAngleStep( oAngleStep)
Returns the Angle Step parameter
Role: Returns the Angle Step parameter
Parameters:
oDefaultSpeed

Will be set to the current value of the Angle Step
Returns:
S_OK : if the Angle Step value was correctly obtained E_FAIL : if the Angle Step value was not correctly obtained
o GetClashModeInfo
public virtual GetClashModeInfo( oInfo)
Retrieves the state of the ClashModeInfo parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetClashMode
public virtual GetClashMode( oMode)
Returns the ClashMode (manipulation mode) for simulation and tracks
Role: Returns the ClashMode (manipulation mode) for simulation and tracks
Parameters:
oMode
The ClashMode (manipulation mode) for simulation and tracks Legal values:
CATManipClashModeNo Clash Detection is set to OFF
CATManipClashModeOn Clash Detection is set to ON
CATManipClashModeStop Clash Detection is set to STOP
Returns:
S_OK : if the ClashMode value was correctly obtained E_FAIL : if the ClashMode value was not correctly obtained
o GetClashSoundInfo
public virtual GetClashSoundInfo( oInfo)
Retrieves the state of the ClashSoundInfo parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetClashSound
public virtual GetClashSound( oClashSound)
Returns the Clash Sound parameter
Role: Returns the Clash Sound parameter
Parameters:
oClashSound
If Clash Beep feedback is to be used. Legal values:
TRUE Clash Beep feedback is enabled
FALSE Clash Beep feedback is disabled
Returns:
S_OK : if the Clash Sound value was correctly obtained E_FAIL : if the Clash Sound value was not correctly obtained
o GetDistanceStepInfo
public virtual GetDistanceStepInfo( oInfo)
Retrieves the state of the DistanceStepInfo parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDistanceStep
public virtual GetDistanceStep( oDistanceStep)
Returns the Distance Step parameter
Role: Returns the Distance Step parameter
Parameters:
oDefaultSpeed

Will be set to the current value of the Distance Step
Returns:
S_OK : if the Distance Step value was correctly obtained E_FAIL : if the Distance Step value was not correctly obtained
o GetManipAutoInsertInfo
public virtual GetManipAutoInsertInfo( oInfo)
Retrieves the state of the ManipAutoInsertInfo parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetManipAutoInsert
public virtual GetManipAutoInsert( oManipAutoInsert)
Returns the ManipAutoInsert parameter
Role: Returns the ManipAutoInsert (Automatic insert for manipulation mode) parameter.
Parameters:
oManipAutoInsert
If Automatic insert for manipulation mode is to be used. Legal values:
TRUE Automatic insert for manipulation mode is enabled
FALSE Automatic insert for manipulation mode is disabled
Returns:
S_OK : if the ManipAutoInsert value was correctly obtained E_FAIL : if the ManipAutoInsert value was not correctly obtained
o GetRecordModeInfo
public virtual GetRecordModeInfo( oInfo)
Retrieves the state of the RecordModeInfo parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetRecordMode
public virtual GetRecordMode( oMode)
Returns the RecordMode for Auto Insert configuration
Role: Returns the RecordMode for Auto Insert configuration
Parameters:
oMode
The Record Mode that will be used for auto insert Legal values:
CATOnMouseRelease On each mouse release
CATWhileMouseMoving On specific parameters
Returns:
S_OK : if the RecordMode value was correctly obtained E_FAIL : if the RecordMode value was not correctly obtained
o GetSnapAngleDistanceInfo
public virtual GetSnapAngleDistanceInfo( oInfo)
Retrieves the state of the SnapAngleDistanceInfo parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetSnapAngleDistance
public virtual GetSnapAngleDistance( oSnapAngleDistance)
Returns the Snap Angle Distance parameter
Role: Returns the Angle Distance parameter of the Snap Sensitivity
Parameters:
oSnapPosition

Will be set to the current value of the Angle Distance parameter of the Snap Sensitivity
Returns:
S_OK : if the Snap Angle Distance value was correctly obtained E_FAIL : if the Snap Angle Distance value was not correctly obtained
o GetSnapPositionInfo
public virtual GetSnapPositionInfo( oInfo)
Retrieves the state of the SnapPositionInfo parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetSnapPosition
public virtual GetSnapPosition( oSnapPosition)
Returns the Snap Position parameter
Role: Returns the Position parameter of the Snap Sensitivity
Parameters:
oSnapPosition

Will be set to the current value of the Position parameter of the Snap Sensitivity
Returns:
S_OK : if the Snap Position value was correctly obtained E_FAIL : if the Snap Position value was not correctly obtained
o SetAngleStepLock
public virtual SetAngleStepLock( iLocked)
Locks or unlocks the AngleStep parameter.
Role:Locks or unlocks the AngleStep parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetAngleStep
public virtual SetAngleStep( const iAngleStep)
Sets the Angle Step parameter
Role: Sets the Angle Step parameter
Parameters:
iDefaultSpeed

Used to set the Angle Step parameter
Returns:
S_OK : if the Angle Step value was correctly obtained E_FAIL : if the Angle Step value was not correctly obtained
o SetClashModeLock
public virtual SetClashModeLock( iLocked)
Locks or unlocks the ClashMode parameter.
Role:Locks or unlocks the ClashMode parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetClashMode
public virtual SetClashMode( const iMode)
Sets the ClashMode (manipulation mode) for simulation and tracks
Role: Sets the ClashMode (manipulation mode) for simulation and tracks
Parameters:
iMode
The ClashMode (manipulation mode) for simulation and tracks Legal values:
CATManipClashModeNo Clash Detection is set to OFF
CATManipClashModeOn Clash Detection is set to ON
CATManipClashModeStop Clash Detection is set to STOP
Returns:
S_OK : if the ClashMode value was set correctly E_FAIL : if the ClashMode value was not set correctly
o SetClashSoundLock
public virtual SetClashSoundLock( iLocked)
Locks or unlocks the ClashSound parameter.
Role:Locks or unlocks the ClashSound parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetClashSound
public virtual SetClashSound( const iClashSound)
Sets the Clash Sound parameter
Role: Sets the Clash Sound parameter
Parameters:
iClashSound
If Clash Beep feedback is to be used. Legal values:
TRUE : to enable Clash Beep feedback
FALSE: to disable Clash Beep feedback
Returns:
S_OK : if the Clash Sound value was set correctly E_FAIL : if the Clash Sound value was not set correctly
o SetDistanceStepLock
public virtual SetDistanceStepLock( iLocked)
Locks or unlocks the DistanceStep parameter.
Role:Locks or unlocks the DistanceStep parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetDistanceStep
public virtual SetDistanceStep( const iDistanceStep)
Sets the Distance Step parameter
Role: Returns the Distance Step parameter
Parameters:
iDefaultSpeed

Used to set the Distance Step parameter
Returns:
S_OK : if the Distance Step value was correctly obtained E_FAIL : if the Distance Step value was not correctly obtained
o SetManipAutoInsertLock
public virtual SetManipAutoInsertLock( iLocked)
Locks or unlocks the ManipAutoInsert parameter.
Role:Locks or unlocks the ManipAutoInsert parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetManipAutoInsert
public virtual SetManipAutoInsert( const iManipAutoInsert)
Sets the ManipAutoInsert parameter
Role: Sets the ManipAutoInsert (Automatic insert for manipulation mode) parameter.
Parameters:
iManipAutoInsert
If Automatic insert for manipulation mode is to be used. Legal values:
TRUE : to enable Automatic insert for manipulation mode
FALSE: to disable Automatic insert for manipulation mode
Returns:
S_OK : if the ManipAutoInsert value was set correctly E_FAIL : if the ManipAutoInsert value was not set correctly
o SetRecordModeLock
public virtual SetRecordModeLock( iLocked)
Locks or unlocks the RecordMode parameter.
Role:Locks or unlocks the RecordMode parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetRecordMode
public virtual SetRecordMode( const iMode)
Sets the RecordMode for Auto Insert configuration
Role: Sets the RecordMode if angle limitation is being used
Parameters:
iMode
The Record Mode that will be used for auto insert Legal values:
CATOnMouseRelease On each mouse release
CATWhileMouseMoving On specific parameters
Returns:
S_OK : if the RecordMode value was set correctly E_FAIL : if the RecordMode value was not set correctly
o SetSnapAngleDistanceLock
public virtual SetSnapAngleDistanceLock( iLocked)
Locks or unlocks the SnapAngleDistance parameter.
Role:Locks or unlocks the SnapAngleDistance parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetSnapAngleDistance
public virtual SetSnapAngleDistance( const iSnapAngleDistance)
Sets the Snap Angle Distance parameter
Role: Sets the Angle Distance parameter of the Snap Sensitivity
Parameters:
iSnapPosition

Used to set the Angle Distance parameter of the Snap Sensitivity
Returns:
S_OK : if the Snap Angle Distance value was correctly obtained E_FAIL : if the Snap Angle Distance value was not correctly obtained
o SetSnapPositionLock
public virtual SetSnapPositionLock( iLocked)
Locks or unlocks the SnapPosition parameter.
Role:Locks or unlocks the SnapPosition parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetSnapPosition
public virtual SetSnapPosition( const iSnapPosition)
Sets the Snap Position parameter
Role: Sets the Position parameter of the Snap Sensitivity
Parameters:
iSnapPosition

Used to set the Snap Position parameter of the Snap Sensitivity
Returns:
S_OK : if the Snap Position value was correctly obtained E_FAIL : if the Snap Position value was not correctly obtained

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

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