All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

FittingInterfaces Interface CATISiFiFittingSettingAtt

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATISiFiFittingSettingAtt
 

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


interface CATISiFiFittingSettingAtt

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


Method Index


o GetAngleLimit(CATBoolean&)
Returns the Shuttle Angle Limit parameter.
o GetAngleLimitInfo(CATSettingInfo*)
Retrieves the state of the AngleLimitInfo parameter.
o GetClashWhileMoving(CATBoolean&)
Returns the Clash While Moving parameter.
o GetClashWhileMovingInfo(CATSettingInfo*)
Retrieves the state of the ClashWhileMovingInfo parameter.
o GetDefaultSpeed(double&)
Returns the Default Speed parameter.
o GetDefaultSpeedInfo(CATSettingInfo*)
Retrieves the state of the DefaultSpeedInfo parameter.
o GetDefaultTime(double&)
Returns the Default Time parameter
Role: Returns the Default Time parameter for a track
o GetDefaultTimeInfo(CATSettingInfo*)
Retrieves the state of the DefaultTimeInfo parameter.
o GetMaxAngle(float&)
Returns the Maximum Angle if angle limitation is being used.
o GetMaxAngleInfo(CATSettingInfo*)
Retrieves the state of the MaxAngleInfo parameter.
o GetPathFinderSmooth(CATBoolean&)
Returns the Path Finder Automatic Smooth parameter.
o GetPathFinderSmoothInfo(CATSettingInfo*)
Retrieves the state of the PathFinderSmoothInfo parameter.
o GetTrackAutoUpdate(CATBoolean&)
Returns the Automatic Track Update parameter.
o GetTrackAutoUpdateInfo(CATSettingInfo*)
Retrieves the state of the TrackAutoUpdateInfo parameter.
o GetVector(CATFittingShuttleVector&)
Returns the Vector if angle limitation is being used.
o GetVectorInfo(CATSettingInfo*)
Retrieves the state of the VectorInfo parameter.
o SetAngleLimit(CATBoolean)
Sets the Shuttle Angle Limit parameter.
o SetAngleLimitLock(unsigned char)
Locks or unlocks the Shuttle Angle Limit parameter.
o SetClashWhileMoving(CATBoolean)
Sets the Clash While Moving parameter.
o SetClashWhileMovingLock(unsigned char)
Locks or unlocks the ClashWhileMoving parameter.
o SetDefaultSpeed(double)
Sets the Default Speed parameter.
o SetDefaultSpeedLock(unsigned char)
Locks or unlocks the DefaultSpeed parameter.
o SetDefaultTime(double)
Sets the Default Time parameter.
o SetDefaultTimeLock(unsigned char)
Locks or unlocks the DefaultTime parameter.
o SetMaxAngle(float)
Sets the Maximum Angle if angle limitation is being used.
o SetMaxAngleLock(unsigned char)
Locks or unlocks the Shuttle Angle Limit value parameter.
o SetPathFinderSmooth(CATBoolean)
Sets the Path Finder Automatic Smooth parameter.
o SetPathFinderSmoothLock(unsigned char)
Locks or unlocks the PathFinderSmooth parameter.
o SetTrackAutoUpdate(CATBoolean)
Sets the Automatic Track Update parameter.
o SetTrackAutoUpdateLock(unsigned char)
Locks or unlocks the TrackAutoUpdate parameter.
o SetVector(CATFittingShuttleVector)
Sets the Vector if angle limitation is being used.
o SetVectorLock(unsigned char)
Locks or unlocks the Shuttle Vector parameter.

Methods


o GetAngleLimit
public virtual HRESULT GetAngleLimit(CATBoolean& oAngleLimit)= 0
Returns the Shuttle Angle Limit parameter.
Role: Returns the Shuttle Angle Limit parameter
Parameters:
oAngleLimit
If shuttle angle limitation is to be used. Legal values:
TRUE Angle Limitation is enabled
FALSE Angle Limitation is disabled
Returns:
S_OK : if the AngleLimit value was correctly obtained E_FAIL : if the AngleLimit value was not correctly obtained
o GetAngleLimitInfo
public virtual HRESULT GetAngleLimitInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the AngleLimitInfo parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetClashWhileMoving
public virtual HRESULT GetClashWhileMoving(CATBoolean& oClashWhileMoving)= 0
Returns the Clash While Moving parameter.
Role: Returns the Clash Detection While Moving parameter
Parameters:
oClashWhileMoving
If Clash Detection While Moving is to be used. Legal values:
TRUE Clash Detection While Moving is enabled
FALSE Clash Detection While Moving is disabled used
Returns:
S_OK : if the Clash While Moving value was correctly obtained E_FAIL : if the Clash While Moving value was not correctly obtained
o GetClashWhileMovingInfo
public virtual HRESULT GetClashWhileMovingInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the ClashWhileMovingInfo parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDefaultSpeed
public virtual HRESULT GetDefaultSpeed(double& oDefaultSpeed)= 0
Returns the Default Speed parameter.
Role: Returns the Default Speed parameter for a track
Parameters:
oDefaultSpeed

Will be set to the current value of the Default Speed for a track
Returns:
S_OK : if the Default Speed value was correctly obtained E_FAIL : if the Default Speed value was not correctly obtained
o GetDefaultSpeedInfo
public virtual HRESULT GetDefaultSpeedInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the DefaultSpeedInfo parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDefaultTime
public virtual HRESULT GetDefaultTime(double& oDefaultTime) = 0
Returns the Default Time parameter
Role: Returns the Default Time parameter for a track
Parameters:
oDefaultTime

Will be set to the current value of the Default Time for a track
Returns:
S_OK : if the Default Time value was correctly obtained E_FAIL : if the Default Time value was not correctly obtained
o GetDefaultTimeInfo
public virtual HRESULT GetDefaultTimeInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the DefaultTimeInfo parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetMaxAngle
public virtual HRESULT GetMaxAngle(float& oMaxAngle) = 0
Returns the Maximum Angle if angle limitation is being used.
Role: Returns the Maximum Angle if angle limitation is being used
Parameters:
oMaxAngle

Will be set to the current value of the Maximum Angle for shuttle angle limitation validation.
Returns:
S_OK : if the Max Validation value was correctly obtained E_FAIL : if the Max Validation value was not correctly obtained
o GetMaxAngleInfo
public virtual HRESULT GetMaxAngleInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the MaxAngleInfo parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetPathFinderSmooth
public virtual HRESULT GetPathFinderSmooth(CATBoolean& oPathFinderSmooth)= 0
Returns the Path Finder Automatic Smooth parameter.
Role: Returns the Path Finder Automatic Smooth parameter
Parameters:
oPathFinderSmooth
If Path Finder Automatic Smooth is to be used. Legal values:
TRUE Path Finder Automatic Smooth is enabled
FALSE Path Finder Automatic Smooth is disabled used
Returns:
S_OK : if the Path Finder Automatic Smooth value was correctly obtained E_FAIL : if the Path Finder Automatic Smooth value was not correctly obtained
o GetPathFinderSmoothInfo
public virtual HRESULT GetPathFinderSmoothInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the PathFinderSmoothInfo parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetTrackAutoUpdate
public virtual HRESULT GetTrackAutoUpdate(CATBoolean& oTrackAutoUpdate)= 0
Returns the Automatic Track Update parameter.
Role: Returns the Automatic Track Update parameter
Parameters:
oTrackAutoUpdate
If Automatic Track Update is to be used. Legal values:
TRUE Automatic Track Update is enabled
FALSE Automatic Track Update is disabled used
Returns:
S_OK : if the Automatic Track Update value was correctly obtained E_FAIL : if the Automatic Track Update value was not correctly obtained
o GetTrackAutoUpdateInfo
public virtual HRESULT GetTrackAutoUpdateInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the TrackAutoUpdateInfo parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetVector
public virtual HRESULT GetVector(CATFittingShuttleVector& oVector)= 0
Returns the Vector if angle limitation is being used.
Role: Returns the Vector if angle limitation is being used
Parameters:
oVector
The axis that will be used for shuttle angle validation Legal values:
CATFittingShuttleVectorX Along the vector X axis
CATFittingShuttleVectorY Along the vector Y axis
CATFittingShuttleVectorZ Along the vector Z axis
Returns:
S_OK : if the Vector value was correctly obtained E_FAIL : if the Vector value was not correctly obtained
o GetVectorInfo
public virtual HRESULT GetVectorInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the VectorInfo parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetAngleLimit
public virtual HRESULT SetAngleLimit( const CATBoolean iAngleLimit)= 0
Sets the Shuttle Angle Limit parameter.
Role: Sets the Shuttle Angle Limit parameter
Parameters:
iAngleLimit
If shuttle angle limitation is to be used. Legal values:
TRUE : to enable Angle Limitation
FALSE: to disable Angle Limitation
Returns:
S_OK : if the Angle Limitation value was set correctly E_FAIL : if the Angle Limitation value was not set correctly
o SetAngleLimitLock
public virtual HRESULT SetAngleLimitLock(unsigned char iLocked)= 0
Locks or unlocks the Shuttle Angle Limit parameter.
Role:Locks or unlocks the Shuttle Angle Limit 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 SetClashWhileMoving
public virtual HRESULT SetClashWhileMoving( const CATBoolean iClashWhileMoving)= 0
Sets the Clash While Moving parameter.
Role: Sets the Clash Detection While Moving parameter
Parameters:
iAngleLimit
If Clash Detection While Moving is to be used. Legal values:
TRUE : to enable Clash Detection While Moving
FALSE: to disable Clash Detection While Moving
Returns:
S_OK : if the Clash While Moving value was set correctly E_FAIL : if the Clash While Moving value was not set correctly
o SetClashWhileMovingLock
public virtual HRESULT SetClashWhileMovingLock(unsigned char iLocked)= 0
Locks or unlocks the ClashWhileMoving parameter.
Role:Locks or unlocks the ClashWhileMoving 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 SetDefaultSpeed
public virtual HRESULT SetDefaultSpeed(double iDefaultSpeed)= 0
Sets the Default Speed parameter.
Role: Returns the Default Speed parameter for a track
Parameters:
iDefaultSpeed

Used to set the Default Track Speed for a track
Returns:
S_OK : if the Default Track Speed value was correctly obtained E_FAIL : if the Default Track Speed value was not correctly obtained
o SetDefaultSpeedLock
public virtual HRESULT SetDefaultSpeedLock(unsigned char iLocked)= 0
Locks or unlocks the DefaultSpeed parameter.
Role:Locks or unlocks the DefaultSpeed 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 SetDefaultTime
public virtual HRESULT SetDefaultTime(double iDefaultTime) = 0
Sets the Default Time parameter.
Role: Returns the Default Time parameter for a track
Parameters:
iDefaultTime

Used to set the Default Track Time for a track
Returns:
S_OK : if the Default Track Time value was correctly obtained E_FAIL : if the Default Track Time value was not correctly obtained
o SetDefaultTimeLock
public virtual HRESULT SetDefaultTimeLock(unsigned char iLocked)= 0
Locks or unlocks the DefaultTime parameter.
Role:Locks or unlocks the DefaultTime 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 SetMaxAngle
public virtual HRESULT SetMaxAngle(float iMaxAngle) = 0
Sets the Maximum Angle if angle limitation is being used.
Role: Sets the Maximum Angle if angle limitation is being used
Parameters:
iMaxAngle

Will be used to set the Maximum Angle for shuttle angle limitation validation.
Returns:
S_OK : if the Max Validation value was set correctly E_FAIL : if the Max Validation value was not set correctly
o SetMaxAngleLock
public virtual HRESULT SetMaxAngleLock(unsigned char iLocked)= 0
Locks or unlocks the Shuttle Angle Limit value parameter.
Role:Locks or unlocks the MaxAngle 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 SetPathFinderSmooth
public virtual HRESULT SetPathFinderSmooth( const CATBoolean iPathFinderSmooth)= 0
Sets the Path Finder Automatic Smooth parameter.
Role: Sets the Path Finder Automatic Smooth parameter
Parameters:
iPathFinderSmooth
If Path Finder Automatic Smooth is to be used. Legal values:
TRUE : to enable Path Finder Automatic Smooth
FALSE: to disable Path Finder Automatic Smooth
Returns:
S_OK : if the Angle Limitation value was set correctly E_FAIL : if the Angle Limitation value was not set correctly
o SetPathFinderSmoothLock
public virtual HRESULT SetPathFinderSmoothLock(unsigned char iLocked)= 0
Locks or unlocks the PathFinderSmooth parameter.
Role:Locks or unlocks the PathFinderSmooth 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 SetTrackAutoUpdate
public virtual HRESULT SetTrackAutoUpdate( const CATBoolean iTrackAutoUpdate)= 0
Sets the Automatic Track Update parameter.
Role: Sets the Automatic Track Update parameter
Parameters:
iTrackAutoUpdate
If Automatic Track Update is to be used. Legal values:
TRUE : to enable Automatic Track Update
FALSE: to disable Automatic Track Update
Returns:
S_OK : if the Automatic Track Update value was set correctly E_FAIL : if the Automatic Track Update was not set correctly
o SetTrackAutoUpdateLock
public virtual HRESULT SetTrackAutoUpdateLock(unsigned char iLocked)= 0
Locks or unlocks the TrackAutoUpdate parameter.
Role:Locks or unlocks the TrackAutoUpdate 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 SetVector
public virtual HRESULT SetVector( const CATFittingShuttleVector iVector)= 0
Sets the Vector if angle limitation is being used.
Role: Sets the Vector if angle limitation is being used
Parameters:
iVector
The axis that will be used for shuttle angle validation Legal values:
CATFittingShuttleVectorX Along the vector X axis
CATFittingShuttleVectorY Along the vector Y axis
CATFittingShuttleVectorZ Along the vector Z axis
Returns:
S_OK : if the Vector value was set correctly E_FAIL : if the Vector value was not set correctly
o SetVectorLock
public virtual HRESULT SetVectorLock(unsigned char iLocked)= 0
Locks or unlocks the Shuttle Vector parameter.
Role:Locks or unlocks the Shuttle Vector 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

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

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