All Frameworks Class Hierarchy This Framework Indexes
FittingInterfaces Interface 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.
- Methods to set value of each parameter
- Methods to get value of each parameter
- Methods to get information on each parameter
- Methods to lock/unlock value of each parameter
Method Index
- o
GetAngleLimitInfo(CATSettingInfo*)
- Retrieves the state of the AngleLimitInfo parameter.
- o
GetAngleLimit(CATBoolean&)
- Returns the Shuttle Angle Limit parameter.
- o
GetClashWhileMovingInfo(CATSettingInfo*)
- Retrieves the state of the ClashWhileMovingInfo parameter.
- o
GetClashWhileMoving(CATBoolean&)
- Returns the Clash While Moving parameter.
- o
GetDefaultSpeedInfo(CATSettingInfo*)
- Retrieves the state of the DefaultSpeedInfo parameter.
- o
GetDefaultSpeed(double&)
- Returns the Default Speed parameter.
- o
GetDefaultTimeInfo(CATSettingInfo*)
- Retrieves the state of the DefaultTimeInfo parameter.
- o
GetDefaultTime(double&)
- Returns the Default Time parameter
Role: Returns the Default Time parameter for a track
- o
GetMaxAngleInfo(CATSettingInfo*)
- Retrieves the state of the MaxAngleInfo parameter.
- o
GetMaxAngle(float&)
- Returns the Maximum Angle if angle limitation is being used.
- o
GetPathFinderSmoothInfo(CATSettingInfo*)
- Retrieves the state of the PathFinderSmoothInfo parameter.
- o
GetPathFinderSmooth(CATBoolean&)
- Returns the Path Finder Automatic Smooth parameter.
- o
GetTrackAutoUpdateInfo(CATSettingInfo*)
- Retrieves the state of the TrackAutoUpdateInfo parameter.
- o
GetTrackAutoUpdate(CATBoolean&)
- Returns the Automatic Track Update parameter.
- o
GetVectorInfo(CATSettingInfo*)
- Retrieves the state of the VectorInfo parameter.
- o
GetVector(CATFittingShuttleVector&)
- Returns the Vector if angle limitation is being used.
- o
SetAngleLimitLock(unsigned char)
- Locks or unlocks the Shuttle Angle Limit parameter.
- o
SetAngleLimit(CATBoolean)
- Sets the Shuttle Angle Limit parameter.
- o
SetClashWhileMovingLock(unsigned char)
- Locks or unlocks the ClashWhileMoving parameter.
- o
SetClashWhileMoving(CATBoolean)
- Sets the Clash While Moving parameter.
- o
SetDefaultSpeedLock(unsigned char)
- Locks or unlocks the DefaultSpeed parameter.
- o
SetDefaultSpeed(double)
- Sets the Default Speed parameter.
- o
SetDefaultTimeLock(unsigned char)
- Locks or unlocks the DefaultTime parameter.
- o
SetDefaultTime(double)
- Sets the Default Time parameter.
- o
SetMaxAngleLock(unsigned char)
- Locks or unlocks the Shuttle Angle Limit value parameter.
- o
SetMaxAngle(float)
- Sets the Maximum Angle if angle limitation is being used.
- o
SetPathFinderSmoothLock(unsigned char)
- Locks or unlocks the PathFinderSmooth parameter.
- o
SetPathFinderSmooth(CATBoolean)
- Sets the Path Finder Automatic Smooth parameter.
- o
SetTrackAutoUpdateLock(unsigned char)
- Locks or unlocks the TrackAutoUpdate parameter.
- o
SetTrackAutoUpdate(CATBoolean)
- Sets the Automatic Track Update parameter.
- o
SetVectorLock(unsigned char)
- Locks or unlocks the Shuttle Vector parameter.
- o
SetVector(CATFittingShuttleVector)
- Sets the Vector if angle limitation is being used.
Methods
o GetAngleLimitInfo
| public virtual GetAngleLimitInfo( | | oInfo) |
-
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 GetAngleLimit
| public virtual GetAngleLimit( | | oAngleLimit) |
-
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 GetClashWhileMovingInfo
| public virtual GetClashWhileMovingInfo( | | oInfo) |
-
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 GetClashWhileMoving
| public virtual GetClashWhileMoving( | | oClashWhileMoving) |
-
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 GetDefaultSpeedInfo
| public virtual GetDefaultSpeedInfo( | | oInfo) |
-
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 GetDefaultSpeed
| public virtual GetDefaultSpeed( | | oDefaultSpeed) |
-
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 GetDefaultTimeInfo
| public virtual GetDefaultTimeInfo( | | oInfo) |
-
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 GetDefaultTime
| public virtual GetDefaultTime( | | oDefaultTime) |
-
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 GetMaxAngleInfo
| public virtual GetMaxAngleInfo( | | oInfo) |
-
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 GetMaxAngle
| public virtual GetMaxAngle( | | oMaxAngle) |
-
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 GetPathFinderSmoothInfo
| public virtual GetPathFinderSmoothInfo( | | oInfo) |
-
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 GetPathFinderSmooth
| public virtual GetPathFinderSmooth( | | oPathFinderSmooth) |
-
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 GetTrackAutoUpdateInfo
| public virtual GetTrackAutoUpdateInfo( | | oInfo) |
-
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 GetTrackAutoUpdate
| public virtual GetTrackAutoUpdate( | | oTrackAutoUpdate) |
-
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 GetVectorInfo
| public virtual GetVectorInfo( | | oInfo) |
-
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 GetVector
| public virtual GetVector( | | oVector) |
-
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 SetAngleLimitLock
| public virtual SetAngleLimitLock( | | iLocked) |
-
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 SetAngleLimit
| public virtual SetAngleLimit( | const | iAngleLimit) |
-
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 SetClashWhileMovingLock
| public virtual SetClashWhileMovingLock( | | iLocked) |
-
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 SetClashWhileMoving
| public virtual SetClashWhileMoving( | const | iClashWhileMoving) |
-
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 SetDefaultSpeedLock
| public virtual SetDefaultSpeedLock( | | iLocked) |
-
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 SetDefaultSpeed
| public virtual SetDefaultSpeed( | | iDefaultSpeed) |
-
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 SetDefaultTimeLock
| public virtual SetDefaultTimeLock( | | iLocked) |
-
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 SetDefaultTime
| public virtual SetDefaultTime( | | iDefaultTime) |
-
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 SetMaxAngleLock
| public virtual SetMaxAngleLock( | | iLocked) |
-
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 SetMaxAngle
| public virtual SetMaxAngle( | | iMaxAngle) |
-
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 SetPathFinderSmoothLock
| public virtual SetPathFinderSmoothLock( | | iLocked) |
-
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 SetPathFinderSmooth
| public virtual SetPathFinderSmooth( | const | iPathFinderSmooth) |
-
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 SetTrackAutoUpdateLock
| public virtual SetTrackAutoUpdateLock( | | iLocked) |
-
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 SetTrackAutoUpdate
| public virtual SetTrackAutoUpdate( | const | iTrackAutoUpdate) |
-
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 SetVectorLock
| public virtual SetVectorLock( | | iLocked) |
-
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
o SetVector
| public virtual SetVector( | const | iVector) |
-
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
This object is included in the file: CATISiFiFittingSettingAtt.h
If needed, your Imakefile.mk should include the module: CATFittingInterfaces