All Frameworks  Object Hierarchy  This Framework  Indexes

SimulationSettingAtt (Object)

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

Property Index

ASNavigationMode
Returns or sets the ASNavigationMode setting attribute value.
ASStepSize
Returns or sets the ASStepSize setting attribute value.
AthAnnotation
Returns or sets the AthAnnotation setting attribute value.
AthDisableSim
Returns or sets the AthDisableSim setting attribute value.
AthEndCondition
Returns or sets the AthEndCondition setting attribute value.
AthHyperlink
Returns or sets the AthHyperlink setting attribute value.
AthSelAgentDlg
Returns or sets the AthSelAgentDlg setting attribute value.
AthStateMgt
Returns or sets the AthStateMgt setting attribute value.
AthTextMsg
Returns or sets the AthTextMsg setting attribute value.
AthViewpoint
Returns or sets the AthViewpoint setting attribute value.
PSCycleTime
Returns or sets the PSCycleTime setting attribute value.
PSDynClashMode
Returns or sets the PSDynClashMode setting attribute value.
PSGraphicSimStep
Returns or sets the PSGraphicSimStep setting attribute value.
PSGraphicUpdate
Returns or sets the PSGraphicUpdate setting attribute value.
PVEndCondition
Returns or sets the PVEndCondition setting attribute value.
PVStateMgt
Returns or sets the PVStateMgt setting attribute value.
RunAnnotBehavior
Returns or sets the RunAnnotBehavior setting attribute value.
RunAnnotation
Returns or sets the RunAnnotation setting attribute value.
RunEndCondition
Returns or sets the RunEndCondition setting attribute value.
RunHlnkBehavior
Returns or sets the RunHlnkBehavior setting attribute value.
RunHyperlink
Returns or sets the RunHyperlink setting attribute value.
RunPause
Returns or sets the RunPause setting attribute value.
RunStateMgt
Returns or sets the RunStateMgt setting attribute value.
RunStepSize
Returns or sets the RunStepSize setting attribute value.
RunTextBehavior
Returns or sets the RunTextBehavior setting attribute value.
RunTextMsg
Returns or sets the RunTextMsg setting attribute value.
RunViewpoint
Returns or sets the RunViewpoint setting attribute value.
RunVisBehavior
Returns or sets the RunVisBehavior setting attribute value.

Method Index

GetASNavigationModeInfo
Retrieves environment informations for the ASNavigationMode parameter.
GetASStepSizeInfo
Retrieves environment informations for the ASStepSize parameter.
GetAthAnnotationInfo
Retrieves environment informations for the AthAnnotation parameter.
GetAthDisableSimInfo
Retrieves environment informations for the AthDisableSim parameter.
GetAthEndConditionInfo
Retrieves environment informations for the AthEndCondition parameter.
GetAthHyperlinkInfo
Retrieves environment informations for the AthHyperlink parameter.
GetAthSelAgentDlgInfo
Retrieves environment informations for the AthSelAgentDlg parameter.
GetAthStateMgtInfo
Retrieves environment informations for the AthStateMgt parameter.
GetAthTextMsgInfo
Retrieves environment informations for the AthTextMsg parameter.
GetAthViewpointInfo
Retrieves environment informations for the AthViewpoint parameter.
GetPSCycleTimeInfo
Retrieves environment informations for the PSCycleTime parameter.
GetPSDynClashModeInfo
Retrieves environment informations for the PSDynClashMode parameter.
GetPSGraphicSimStepInfo
Retrieves environment informations for the PSGraphicSimStep parameter.
GetPSGraphicUpdateInfo
Retrieves environment informations for the PSGraphicUpdate parameter.
GetPVEndConditionInfo
Retrieves environment informations for the PVEndCondition parameter.
GetPVStateMgtInfo
Retrieves environment informations for the PVStateMgt parameter.
GetRunAnnotBehaviorInfo
Retrieves environment informations for the RunAnnotBehavior parameter.
GetRunAnnotationInfo
Retrieves environment informations for the RunAnnotation parameter.
GetRunEndConditionInfo
Retrieves environment informations for the RunEndCondition parameter.
GetRunHlnkBehaviorInfo
Retrieves environment informations for the RunHlnkBehavior parameter.
GetRunHyperlinkInfo
Retrieves environment informations for the RunHyperlink parameter.
GetRunPauseInfo
Retrieves environment informations for the RunPause parameter.
GetRunStateMgtInfo
Retrieves environment informations for the RunStateMgt parameter.
GetRunStepSizeInfo
Retrieves environment informations for the RunStepSize parameter.
GetRunTextBehaviorInfo
Retrieves environment informations for the RunTextBehavior parameter.
GetRunTextMsgInfo
Retrieves environment informations for the RunTextMsg parameter.
GetRunViewpointInfo
Retrieves environment informations for the RunViewpoint parameter.
GetRunVisBehaviorInfo
Retrieves environment informations for the RunVisBehavior parameter.
SetASNavigationModeLock
Locks or unlocks the ASNavigationMode parameter.
SetASStepSizeLock
Locks or unlocks the ASStepSize parameter.
SetAthAnnotationLock
Locks or unlocks the AthAnnotation parameter.
SetAthDisableSimLock
Locks or unlocks the AthDisableSim parameter.
SetAthEndConditionLock
Locks or unlocks the AthEndCondition parameter.
SetAthHyperlinkLock
Locks or unlocks the AthHyperlink parameter.
SetAthSelAgentDlgLock
Locks or unlocks the AthSelAgentDlg parameter.
SetAthStateMgtLock
Locks or unlocks the AthStateMgt parameter.
SetAthTextMsgLock
Locks or unlocks the AthTextMsg parameter.
SetAthViewpointLock
Locks or unlocks the AthViewpoint parameter.
SetPSCycleTimeLock
Locks or unlocks the PSCycleTime parameter.
SetPSDynClashModeLock
Locks or unlocks the PSDynClashMode parameter.
SetPSGraphicSimStepLock
Locks or unlocks the PSGraphicSimStep parameter.
SetPSGraphicUpdateLock
Locks or unlocks the PSGraphicUpdate parameter.
SetPVEndConditionLock
Locks or unlocks the PVEndCondition parameter.
SetPVStateMgtLock
Locks or unlocks the PVStateMgt parameter.
SetRunAnnotBehaviorLock
Locks or unlocks the RunAnnotBehavior parameter.
SetRunAnnotationLock
Locks or unlocks the RunAnnotation parameter.
SetRunEndConditionLock
Locks or unlocks the RunEndCondition parameter.
SetRunHlnkBehaviorLock
Locks or unlocks the RunHlnkBehavior parameter.
SetRunHyperlinkLock
Locks or unlocks the RunHyperlink parameter.
SetRunPauseLock
Locks or unlocks the RunPause parameter.
SetRunStateMgtLock
Locks or unlocks the RunStateMgt parameter.
SetRunStepSizeLock
Locks or unlocks the RunStepSize parameter.
SetRunTextBehaviorLock
Locks or unlocks the RunTextBehavior parameter.
SetRunTextMsgLock
Locks or unlocks the RunTextMsg parameter.
SetRunViewpointLock
Locks or unlocks the RunViewpoint parameter.
SetRunVisBehaviorLock
Locks or unlocks the RunVisBehavior parameter.

Properties


o Property ASNavigationMode() As
Returns or sets the ASNavigationMode setting attribute value.

o Property ASStepSize() As
Returns or sets the ASStepSize setting attribute value.

o Property AthAnnotation() As
Returns or sets the AthAnnotation setting attribute value.

o Property AthDisableSim() As
Returns or sets the AthDisableSim setting attribute value.

o Property AthEndCondition() As
Returns or sets the AthEndCondition setting attribute value.

o Property AthHyperlink() As
Returns or sets the AthHyperlink setting attribute value.

o Property AthSelAgentDlg() As
Returns or sets the AthSelAgentDlg setting attribute value.

o Property AthStateMgt() As
Returns or sets the AthStateMgt setting attribute value.

o Property AthTextMsg() As
Returns or sets the AthTextMsg setting attribute value.

o Property AthViewpoint() As
Returns or sets the AthViewpoint setting attribute value.

o Property PSCycleTime() As
Returns or sets the PSCycleTime setting attribute value.

o Property PSDynClashMode() As
Returns or sets the PSDynClashMode setting attribute value.

o Property PSGraphicSimStep() As
Returns or sets the PSGraphicSimStep setting attribute value.

o Property PSGraphicUpdate() As
Returns or sets the PSGraphicUpdate setting attribute value.

o Property PVEndCondition() As
Returns or sets the PVEndCondition setting attribute value.

o Property PVStateMgt() As
Returns or sets the PVStateMgt setting attribute value.

o Property RunAnnotBehavior() As
Returns or sets the RunAnnotBehavior setting attribute value.

o Property RunAnnotation() As
Returns or sets the RunAnnotation setting attribute value.

o Property RunEndCondition() As
Returns or sets the RunEndCondition setting attribute value.

o Property RunHlnkBehavior() As
Returns or sets the RunHlnkBehavior setting attribute value.

o Property RunHyperlink() As
Returns or sets the RunHyperlink setting attribute value.

o Property RunPause() As
Returns or sets the RunPause setting attribute value.

o Property RunStateMgt() As
Returns or sets the RunStateMgt setting attribute value.

o Property RunStepSize() As
Returns or sets the RunStepSize setting attribute value.

o Property RunTextBehavior() As
Returns or sets the RunTextBehavior setting attribute value.

o Property RunTextMsg() As
Returns or sets the RunTextMsg setting attribute value.

o Property RunViewpoint() As
Returns or sets the RunViewpoint setting attribute value.

o Property RunVisBehavior() As
Returns or sets the RunVisBehavior setting attribute value.

Methods


o Func GetASNavigationModeInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the ASNavigationMode parameter.
Role:Retrieves the state of the ASNavigationMode 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 GetASStepSizeInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the ASStepSize parameter.
Role:Retrieves the state of the ASStepSize 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 GetAthAnnotationInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the AthAnnotation parameter.
Role:Retrieves the state of the AthAnnotation 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 GetAthDisableSimInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the AthDisableSim parameter.
Role:Retrieves the state of the AthDisableSim 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 GetAthEndConditionInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the AthEndCondition parameter.
Role:Retrieves the state of the AthEndCondition 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 GetAthHyperlinkInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the AthHyperlink parameter.
Role:Retrieves the state of the AthHyperlink 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 GetAthSelAgentDlgInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the AthSelAgentDlg parameter.
Role:Retrieves the state of the AthSelAgentDlg 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 GetAthStateMgtInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the AthStateMgt parameter.
Role:Retrieves the state of the AthStateMgt 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 GetAthTextMsgInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the AthTextMsg parameter.
Role:Retrieves the state of the AthTextMsg 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 GetAthViewpointInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the AthViewpoint parameter.
Role:Retrieves the state of the AthViewpoint 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 GetPSCycleTimeInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the PSCycleTime parameter.
Role:Retrieves the state of the PSCycleTime 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 GetPSDynClashModeInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the PSDynClashMode parameter.
Role:Retrieves the state of the PSDynClashMode 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 GetPSGraphicSimStepInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the PSGraphicSimStep parameter.
Role:Retrieves the state of the PSGraphicSimStep 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 GetPSGraphicUpdateInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the PSGraphicUpdate parameter.
Role:Retrieves the state of the PSGraphicUpdate 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 GetPVEndConditionInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the PVEndCondition parameter.
Role:Retrieves the state of the PVEndCondition 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 GetPVStateMgtInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the PVStateMgt parameter.
Role:Retrieves the state of the PVStateMgt 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 GetRunAnnotBehaviorInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the RunAnnotBehavior parameter.
Role:Retrieves the state of the RunAnnotBehavior 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 GetRunAnnotationInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the RunAnnotation parameter.
Role:Retrieves the state of the RunAnnotation 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 GetRunEndConditionInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the RunEndCondition parameter.
Role:Retrieves the state of the RunEndCondition 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 GetRunHlnkBehaviorInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the RunHlnkBehavior parameter.
Role:Retrieves the state of the RunHlnkBehavior 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 GetRunHyperlinkInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the RunHyperlink parameter.
Role:Retrieves the state of the RunHyperlink 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 GetRunPauseInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the RunPause parameter.
Role:Retrieves the state of the RunPause 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 GetRunStateMgtInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the RunStateMgt parameter.
Role:Retrieves the state of the RunStateMgt 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 GetRunStepSizeInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the RunStepSize parameter.
Role:Retrieves the state of the RunStepSize 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 GetRunTextBehaviorInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the RunTextBehavior parameter.
Role:Retrieves the state of the RunTextBehavior 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 GetRunTextMsgInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the RunTextMsg parameter.
Role:Retrieves the state of the RunTextMsg 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 GetRunViewpointInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the RunViewpoint parameter.
Role:Retrieves the state of the RunViewpoint 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 GetRunVisBehaviorInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the RunVisBehavior parameter.
Role:Retrieves the state of the RunVisBehavior 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 SetASNavigationModeLock( iLocked)
Locks or unlocks the ASNavigationMode parameter.
Role:Locks or unlocks the ASNavigationMode 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 SetASStepSizeLock( iLocked)
Locks or unlocks the ASStepSize parameter.
Role:Locks or unlocks the ASStepSize 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 SetAthAnnotationLock( iLocked)
Locks or unlocks the AthAnnotation parameter.
Role:Locks or unlocks the AthAnnotation 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 SetAthDisableSimLock( iLocked)
Locks or unlocks the AthDisableSim parameter.
Role:Locks or unlocks the AthDisableSim 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 SetAthEndConditionLock( iLocked)
Locks or unlocks the AthEndCondition parameter.
Role:Locks or unlocks the AthEndCondition 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 SetAthHyperlinkLock( iLocked)
Locks or unlocks the AthHyperlink parameter.
Role:Locks or unlocks the AthHyperlink 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 SetAthSelAgentDlgLock( iLocked)
Locks or unlocks the AthSelAgentDlg parameter.
Role:Locks or unlocks the AthSelAgentDlg 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 SetAthStateMgtLock( iLocked)
Locks or unlocks the AthStateMgt parameter.
Role:Locks or unlocks the AthStateMgt 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 SetAthTextMsgLock( iLocked)
Locks or unlocks the AthTextMsg parameter.
Role:Locks or unlocks the AthTextMsg 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 SetAthViewpointLock( iLocked)
Locks or unlocks the AthViewpoint parameter.
Role:Locks or unlocks the AthViewpoint 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 SetPSCycleTimeLock( iLocked)
Locks or unlocks the PSCycleTime parameter.
Role:Locks or unlocks the PSCycleTime 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 SetPSDynClashModeLock( iLocked)
Locks or unlocks the PSDynClashMode parameter.
Role:Locks or unlocks the PSDynClashMode 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 SetPSGraphicSimStepLock( iLocked)
Locks or unlocks the PSGraphicSimStep parameter.
Role:Locks or unlocks the PSGraphicSimStep 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 SetPSGraphicUpdateLock( iLocked)
Locks or unlocks the PSGraphicUpdate parameter.
Role:Locks or unlocks the PSGraphicUpdate 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 SetPVEndConditionLock( iLocked)
Locks or unlocks the PVEndCondition parameter.
Role:Locks or unlocks the PVEndCondition 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 SetPVStateMgtLock( iLocked)
Locks or unlocks the PVStateMgt parameter.
Role:Locks or unlocks the PVStateMgt 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 SetRunAnnotBehaviorLock( iLocked)
Locks or unlocks the RunAnnotBehavior parameter.
Role:Locks or unlocks the RunAnnotBehavior 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 SetRunAnnotationLock( iLocked)
Locks or unlocks the RunAnnotation parameter.
Role:Locks or unlocks the RunAnnotation 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 SetRunEndConditionLock( iLocked)
Locks or unlocks the RunEndCondition parameter.
Role:Locks or unlocks the RunEndCondition 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 SetRunHlnkBehaviorLock( iLocked)
Locks or unlocks the RunHlnkBehavior parameter.
Role:Locks or unlocks the RunHlnkBehavior 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 SetRunHyperlinkLock( iLocked)
Locks or unlocks the RunHyperlink parameter.
Role:Locks or unlocks the RunHyperlink 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 SetRunPauseLock( iLocked)
Locks or unlocks the RunPause parameter.
Role:Locks or unlocks the RunPause 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 SetRunStateMgtLock( iLocked)
Locks or unlocks the RunStateMgt parameter.
Role:Locks or unlocks the RunStateMgt 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 SetRunStepSizeLock( iLocked)
Locks or unlocks the RunStepSize parameter.
Role:Locks or unlocks the RunStepSize 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 SetRunTextBehaviorLock( iLocked)
Locks or unlocks the RunTextBehavior parameter.
Role:Locks or unlocks the RunTextBehavior 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 SetRunTextMsgLock( iLocked)
Locks or unlocks the RunTextMsg parameter.
Role:Locks or unlocks the RunTextMsg 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 SetRunViewpointLock( iLocked)
Locks or unlocks the RunViewpoint parameter.
Role:Locks or unlocks the RunViewpoint 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 SetRunVisBehaviorLock( iLocked)
Locks or unlocks the RunVisBehavior parameter.
Role:Locks or unlocks the RunVisBehavior 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.