All Frameworks  Object Hierarchy  This Framework  Indexes

RobAnalysisSettingAtt (Object)

Interface to handle parameters of Infrastructure-DELMIA Infrastructure-Robot Analysis Tools Options Tab page.
Role: This interface is implemented by a component which represents the controller of Robot Analysis Tools Options parameter settings. Here is the list of parameters to use and their meaning:

Property Index

LinAccelColor
Returns or sets the LinAccelColor parameter.
LinAccelLimit
Returns or sets the LinAccelLimit parameter.
LinSpeedColor
Returns or sets the LinSpeedColor parameter.
LinSpeedLimit
Returns or sets the LinSpeedLimit parameter.
ReachColor
Returns or sets the ReachColor parameter.
RotAccelColor
Returns or sets the RotAccelColor parameter.
RotAccelLimit
Returns or sets the RotAccelLimit parameter.
RotSpeedColor
Returns or sets the RotSpeedColor parameter.
RotSpeedLimit
Returns or sets the RotSpeedLimit parameter.
SingularColor
Returns or sets the SingularColor parameter.

Method Index

GetLinAccelColorInfo
Retrieves environment informations for the LinAccelColor parameter.
GetLinAccelLimitInfo
Retrieves environment informations for the LinAccelLimit parameter.
GetLinSpeedColorInfo
Retrieves environment informations for the LinSpeedColor parameter.
GetLinSpeedLimitInfo
Retrieves environment informations for the LinSpeedLimit parameter.
GetReachColorInfo
Retrieves environment informations for the ReachColor parameter.
GetRotAccelColorInfo
Retrieves environment informations for the RotAccelColor parameter.
GetRotAccelLimitInfo
Retrieves environment informations for the RotAccelLimit parameter.
GetRotSpeedColorInfo
Retrieves environment informations for the RotSpeedColor parameter.
GetRotSpeedLimitInfo
Retrieves environment informations for the RotSpeedLimit parameter.
GetSingularColorInfo
Retrieves environment informations for the SingularColor parameter.
SetLinAccelColorLock
Locks or unlocks the LinAccelColor parameter.
SetLinAccelLimitLock
Locks or unlocks the LinAccelLimit parameter.
SetLinSpeedColorLock
Locks or unlocks the LinSpeedColor parameter.
SetLinSpeedLimitLock
Locks or unlocks the LinSpeedLimit parameter.
SetReachColorLock
Locks or unlocks the ReachColor parameter.
SetRotAccelColorLock
Locks or unlocks the RotAccelColor parameter.
SetRotAccelLimitLock
Locks or unlocks the RotAccelLimit parameter.
SetRotSpeedColorLock
Locks or unlocks the RotSpeedColor parameter.
SetRotSpeedLimitLock
Locks or unlocks the RotSpeedLimit parameter.
SetSingularColorLock
Locks or unlocks the SingularColor parameter.

Properties


o Property LinAccelColor() As
Returns or sets the LinAccelColor parameter.

Ensure consistency with the C++ interface to which the work is delegated.

o Property LinAccelLimit() As
Returns or sets the LinAccelLimit parameter.

Ensure consistency with the C++ interface to which the work is delegated.

o Property LinSpeedColor() As
Returns or sets the LinSpeedColor parameter.

Ensure consistency with the C++ interface to which the work is delegated.

o Property LinSpeedLimit() As
Returns or sets the LinSpeedLimit parameter.

Ensure consistency with the C++ interface to which the work is delegated.

o Property ReachColor() As
Returns or sets the ReachColor parameter.

Ensure consistency with the C++ interface to which the work is delegated.

o Property RotAccelColor() As
Returns or sets the RotAccelColor parameter.

Ensure consistency with the C++ interface to which the work is delegated.

o Property RotAccelLimit() As
Returns or sets the RotAccelLimit parameter.

Ensure consistency with the C++ interface to which the work is delegated.

o Property RotSpeedColor() As
Returns or sets the RotSpeedColor parameter.

Ensure consistency with the C++ interface to which the work is delegated.

o Property RotSpeedLimit() As
Returns or sets the RotSpeedLimit parameter.

Ensure consistency with the C++ interface to which the work is delegated.

o Property SingularColor() As
Returns or sets the SingularColor parameter.

Ensure consistency with the C++ interface to which the work is delegated.

Methods


o Func GetLinAccelColorInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the LinAccelColor parameter.
Role:Retrieves the state of the LinAccelColor 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.
o Func GetLinAccelLimitInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the LinAccelLimit parameter.
Role:Retrieves the state of the LinAccelLimit 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.
o Func GetLinSpeedColorInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the LinSpeedColor parameter.
Role:Retrieves the state of the LinSpeedColor 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.
o Func GetLinSpeedLimitInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the LinSpeedLimit parameter.
Role:Retrieves the state of the LinSpeedLimit 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.
o Func GetReachColorInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the ReachColor parameter.
Role:Retrieves the state of the ReachColor 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.
o Func GetRotAccelColorInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the RotAccelColor parameter.
Role:Retrieves the state of the RotAccelColor 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.
o Func GetRotAccelLimitInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the RotAccelLimit parameter.
Role:Retrieves the state of the RotAccelLimit 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.
o Func GetRotSpeedColorInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the RotSpeedColor parameter.
Role:Retrieves the state of the RotSpeedColor 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.
o Func GetRotSpeedLimitInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the RotSpeedLimit parameter.
Role:Retrieves the state of the RotSpeedLimit 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.
o Func GetSingularColorInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the SingularColor parameter.
Role:Retrieves the state of the SingularColor 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.
o Sub SetLinAccelColorLock( iLocked)
Locks or unlocks the LinAccelColor parameter.
Role:Locks or unlocks the LinAccelColor 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.
o Sub SetLinAccelLimitLock( iLocked)
Locks or unlocks the LinAccelLimit parameter.
Role:Locks or unlocks the LinAccelLimit 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.
o Sub SetLinSpeedColorLock( iLocked)
Locks or unlocks the LinSpeedColor parameter.
Role:Locks or unlocks the LinSpeedColor 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.
o Sub SetLinSpeedLimitLock( iLocked)
Locks or unlocks the LinSpeedLimit parameter.
Role:Locks or unlocks the LinSpeedLimit 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.
o Sub SetReachColorLock( iLocked)
Locks or unlocks the ReachColor parameter.
Role:Locks or unlocks the ReachColor 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.
o Sub SetRotAccelColorLock( iLocked)
Locks or unlocks the RotAccelColor parameter.
Role:Locks or unlocks the RotAccelColor 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.
o Sub SetRotAccelLimitLock( iLocked)
Locks or unlocks the RotAccelLimit parameter.
Role:Locks or unlocks the RotAccelLimit 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.
o Sub SetRotSpeedColorLock( iLocked)
Locks or unlocks the RotSpeedColor parameter.
Role:Locks or unlocks the RotSpeedColor 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.
o Sub SetRotSpeedLimitLock( iLocked)
Locks or unlocks the RotSpeedLimit parameter.
Role:Locks or unlocks the RotSpeedLimit 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.
o Sub SetSingularColorLock( iLocked)
Locks or unlocks the SingularColor parameter.
Role:Locks or unlocks the SingularColor 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.

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