Role: This interface is implemented by a component which represents the controller of Device Analysis Tools Options parameter settings.
- Methods to set value of each parameter xxx
- Methods to get value of each parameter xxx
- Methods to get information on each parameter xxx
- Methods to lock/unlock value of each parameter xxx
- TravelLimit: defines what behavior you can expect when the DOF travel limits are exeeded.
- VelocityLimit: defines what behavior you can expect when the DOF speed limits are exeeded.
- AccelLimit: defines what behavior you can expect when the DOF acceleration limits are exeeded.
- CautionZone: defines what behavior you can expect when the DOF caution zone limits are exeeded.
- TravelColor: defines the highlight color to be used when the DOF travel limits are exceeded.
- VelocityColor: defines the highlight color to be used when the DOF speed limits are exceeded.
- AccelColor: defines the highlight color to be used when the DOF acceleration limits are exceeded.
- CautionColor: defines the highlight color to be used when the DOF caution zone limits are exceeded.
Properties
- Property AccelColor() As
-
Returns or sets the AccelColor parameter.
Ensure consistency with the C++ interface to which the work is delegated.
- Property AccelLimit() As
-
Returns or sets the AccelLimit parameter.
Ensure consistency with the C++ interface to which the work is delegated.
- Property CautionColor() As
-
Returns or sets the CautionColor parameter.
Ensure consistency with the C++ interface to which the work is delegated.
- Property CautionZone() As
-
Returns or sets the CautionZone parameter.
Ensure consistency with the C++ interface to which the work is delegated.
- Property ToolTipMode() As
-
Returns or sets the ToolTipMode parameter.
Ensure consistency with the C++ interface to which the work is delegated.
- Property TravelColor() As
-
Returns or sets the TravelColor parameter.
Ensure consistency with the C++ interface to which the work is delegated.
- Property TravelLimit() As
-
Returns or sets the TravelLimit parameter.
Ensure consistency with the C++ interface to which the work is delegated.
- Property VelocityColor() As
-
Returns or sets the VelocityColor parameter.
Ensure consistency with the C++ interface to which the work is delegated.
- Property VelocityLimit() As
-
Returns or sets the VelocityLimit parameter.
Ensure consistency with the C++ interface to which the work is delegated.
Methods
- Func GetAccelColorInfo( ioAdminLevel, ioLocked) As
-
Retrieves environment informations for the AccelColor parameter.
Role:Retrieves the state of the AccelColor parameter in the current environment.- Parameters:
-
- ioAdminLevel
-
If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset. - ioLocked
- Indicates if the parameter has been locked.
- Returns:
- Indicates if the parameter has been explicitly modified or remain to the administrated value.
- Func GetAccelLimitInfo( ioAdminLevel, ioLocked) As
-
Retrieves environment informations for the AccelLimit parameter.
Role:Retrieves the state of the AccelLimit parameter in the current environment.- Parameters:
-
- ioAdminLevel
-
If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset. - ioLocked
- Indicates if the parameter has been locked.
- Returns:
- Indicates if the parameter has been explicitly modified or remain to the administrated value.
- Func GetCautionColorInfo( ioAdminLevel, ioLocked) As
-
Retrieves environment informations for the CautionColor parameter.
Role:Retrieves the state of the CautionColor parameter in the current environment.- Parameters:
-
- ioAdminLevel
-
If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset. - ioLocked
- Indicates if the parameter has been locked.
- Returns:
- Indicates if the parameter has been explicitly modified or remain to the administrated value.
- Func GetCautionZoneInfo( ioAdminLevel, ioLocked) As
-
Retrieves environment informations for the CautionZone parameter.
Role:Retrieves the state of the CautionZone parameter in the current environment.- Parameters:
-
- ioAdminLevel
-
If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset. - ioLocked
- Indicates if the parameter has been locked.
- Returns:
- Indicates if the parameter has been explicitly modified or remain to the administrated value.
- Func GetToolTipModeInfo( ioAdminLevel, ioLocked) As
-
Retrieves environment informations for the ToolTipMode parameter.
Role:Retrieves the state of the ToolTipMode parameter in the current environment.- Parameters:
-
- ioAdminLevel
-
If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset. - ioLocked
- Indicates if the parameter has been locked.
- Returns:
- Indicates if the parameter has been explicitly modified or remain to the administrated value.
- Func GetTravelColorInfo( ioAdminLevel, ioLocked) As
-
Retrieves environment informations for the TravelColor parameter.
Role:Retrieves the state of the TravelColor parameter in the current environment.- Parameters:
-
- ioAdminLevel
-
If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset. - ioLocked
- Indicates if the parameter has been locked.
- Returns:
- Indicates if the parameter has been explicitly modified or remain to the administrated value.
- Func GetTravelLimitInfo( ioAdminLevel, ioLocked) As
-
Retrieves environment informations for the TravelLimit parameter.
Role:Retrieves the state of the TravelLimit parameter in the current environment.- Parameters:
-
- ioAdminLevel
-
If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset. - ioLocked
- Indicates if the parameter has been locked.
- Returns:
- Indicates if the parameter has been explicitly modified or remain to the administrated value.
- Func GetVelocityColorInfo( ioAdminLevel, ioLocked) As
-
Retrieves environment informations for the VelocityColor parameter.
Role:Retrieves the state of the VelocityColor parameter in the current environment.- Parameters:
-
- ioAdminLevel
-
If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset. - ioLocked
- Indicates if the parameter has been locked.
- Returns:
- Indicates if the parameter has been explicitly modified or remain to the administrated value.
- Func GetVelocityLimitInfo( ioAdminLevel, ioLocked) As
-
Retrieves environment informations for the VelocityLimit parameter.
Role:Retrieves the state of the VelocityLimit parameter in the current environment.- Parameters:
-
- ioAdminLevel
-
If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset. - ioLocked
- Indicates if the parameter has been locked.
- Returns:
- Indicates if the parameter has been explicitly modified or remain to the administrated value.
- Sub SetAccelColorLock( iLocked)
-
Locks or unlocks the AccelColor parameter.
Role:Locks or unlocks the AccelColor 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.
- Sub SetAccelLimitLock( iLocked)
-
Locks or unlocks the AccelLimit parameter.
Role:Locks or unlocks the AccelLimit 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.
- Sub SetCautionColorLock( iLocked)
-
Locks or unlocks the CautionColor parameter.
Role:Locks or unlocks the CautionColor 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.
- Sub SetCautionZoneLock( iLocked)
-
Locks or unlocks the CautionZone parameter.
Role:Locks or unlocks the CautionZone 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.
- Sub SetToolTipModeLock( iLocked)
-
Locks or unlocks the ToolTipMode parameter.
Role:Locks or unlocks the ToolTipMode 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.
- Sub SetTravelColorLock( iLocked)
-
Locks or unlocks the TravelColor parameter.
Role:Locks or unlocks the TravelColor 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.
- Sub SetTravelLimitLock( iLocked)
-
Locks or unlocks the TravelLimit parameter.
Role:Locks or unlocks the TravelLimit 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.
- Sub SetVelocityColorLock( iLocked)
-
Locks or unlocks the VelocityColor parameter.
Role:Locks or unlocks the VelocityColor 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.
- Sub SetVelocityLimitLock( iLocked)
-
Locks or unlocks the VelocityLimit parameter.
Role:Locks or unlocks the VelocityLimit 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.