All Frameworks Class Hierarchy This Framework Previous Indexes
DNBSimulationInterfaces Interface DNBISimSimulationSettingAtt
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---DNBISimSimulationSettingAtt
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface DNBISimSimulationSettingAtt
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.
- 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
GetASNavigationMode(DNBSimNavigationMode&)
- Retrieves the ASNavigationMode attribute.
- o
GetASNavigationModeInfo(CATSettingInfo*)
- Retrieves the state of the ASNavigationMode parameter.
- o
GetASStepSize(float&)
- Retrieves the ASStepSize attribute.
- o
GetASStepSizeInfo(CATSettingInfo*)
- Retrieves the state of the ASStepSize parameter.
- o
GetAthAnnotation(CATBoolean&)
- Retrieves the AthAnnotation attribute.
- o
GetAthAnnotationInfo(CATSettingInfo*)
- Retrieves the state of the AthAnnotation parameter.
- o
GetAthDisableSim(CATBoolean&)
- Retrieves the AthDisableSim attribute.
- o
GetAthDisableSimInfo(CATSettingInfo*)
- Retrieves the state of the AthDisableSim parameter.
- o
GetAthEndCondition(CATBoolean&)
- Retrieves the AthEndCondition attribute.
- o
GetAthEndConditionInfo(CATSettingInfo*)
- Retrieves the state of the AthEndCondition parameter.
- o
GetAthHyperlink(CATBoolean&)
- Retrieves the AthHyperlink attribute.
- o
GetAthHyperlinkInfo(CATSettingInfo*)
- Retrieves the state of the AthHyperlink parameter.
- o
GetAthSelAgentDlg(CATBoolean&)
- Retrieves the AthSelAgentDlg attribute.
- o
GetAthSelAgentDlgInfo(CATSettingInfo*)
- Retrieves the state of the AthSelAgentDlg parameter.
- o
GetAthStateMgt(CATBoolean&)
- Retrieves the AthStateMgt attribute.
- o
GetAthStateMgtInfo(CATSettingInfo*)
- Retrieves the state of the AthStateMgt parameter.
- o
GetAthTextMsg(CATBoolean&)
- Retrieves the AthTextMsg attribute.
- o
GetAthTextMsgInfo(CATSettingInfo*)
- Retrieves the state of the AthTextMsg parameter.
- o
GetAthViewpoint(CATBoolean&)
- Retrieves the AthViewpoint attribute.
- o
GetAthViewpointInfo(CATSettingInfo*)
- Retrieves the state of the AthViewpoint parameter.
- o
GetPSCycleTime(CATBoolean&)
- Retrieves the PSCycleTime attribute.
- o
GetPSCycleTimeInfo(CATSettingInfo*)
- Retrieves the state of the PSCycleTime parameter.
- o
GetPSDynClashMode(DNBVisualizationMode&)
- Retrieves the PSDynClashMode attribute.
- o
GetPSDynClashModeInfo(CATSettingInfo*)
- Retrieves the state of the PSDynClashMode parameter.
- o
GetPSGraphicSimStep(int&)
- Retrieves the PSGraphicSimStep attribute.
- o
GetPSGraphicSimStepInfo(CATSettingInfo*)
- Retrieves the state of the PSGraphicSimStep parameter.
- o
GetPSGraphicUpdate(DNBSimGraphUpdateMode&)
- Retrieves the PSGraphicUpdate attribute.
- o
GetPSGraphicUpdateInfo(CATSettingInfo*)
- Retrieves the state of the PSGraphicUpdate parameter.
- o
GetPVEndCondition(CATBoolean&)
- Retrieves the PVEndCondition attribute.
- o
GetPVEndConditionInfo(CATSettingInfo*)
- Retrieves the state of the PVEndCondition parameter.
- o
GetPVStateMgt(CATBoolean&)
- Retrieves the PVStateMgt attribute.
- o
GetPVStateMgtInfo(CATSettingInfo*)
- Retrieves the state of the PVStateMgt parameter.
- o
GetRunAnnotBehavior(DNBActBehaviorType&)
- Retrieves the RunAnnotBehavior attribute.
- o
GetRunAnnotBehaviorInfo(CATSettingInfo*)
- Retrieves the state of the RunAnnotBehavior parameter.
- o
GetRunAnnotation(CATBoolean&)
- Retrieves the RunAnnotation attribute.
- o
GetRunAnnotationInfo(CATSettingInfo*)
- Retrieves the state of the RunAnnotation parameter.
- o
GetRunEndCondition(CATBoolean&)
- Retrieves the RunEndCondition attribute.
- o
GetRunEndConditionInfo(CATSettingInfo*)
- Retrieves the state of the RunEndCondition parameter.
- o
GetRunHlnkBehavior(DNBHlnkBehaviorType&)
- Retrieves the RunHlnkBehavior attribute.
- o
GetRunHlnkBehaviorInfo(CATSettingInfo*)
- Retrieves the state of the RunHlnkBehavior parameter.
- o
GetRunHyperlink(CATBoolean&)
- Retrieves the RunHyperlink attribute.
- o
GetRunHyperlinkInfo(CATSettingInfo*)
- Retrieves the state of the RunHyperlink parameter.
- o
GetRunPause(CATBoolean&)
- Retrieves the RunPause attribute.
- o
GetRunPauseInfo(CATSettingInfo*)
- Retrieves the state of the RunPause parameter.
- o
GetRunStateMgt(CATBoolean&)
- Retrieves the RunStateMgt attribute.
- o
GetRunStateMgtInfo(CATSettingInfo*)
- Retrieves the state of the RunStateMgt parameter.
- o
GetRunStepSize(float&)
- Retrieves the RunStepSize attribute.
- o
GetRunStepSizeInfo(CATSettingInfo*)
- Retrieves the state of the RunStepSize parameter.
- o
GetRunTextBehavior(DNBActBehaviorType&)
- Retrieves the RunTextBehavior attribute.
- o
GetRunTextBehaviorInfo(CATSettingInfo*)
- Retrieves the state of the RunTextBehavior parameter.
- o
GetRunTextMsg(CATBoolean&)
- Retrieves the RunTextMsg attribute.
- o
GetRunTextMsgInfo(CATSettingInfo*)
- Retrieves the state of the RunTextMsg parameter.
- o
GetRunViewpoint(CATBoolean&)
- Retrieves the RunViewpoint attribute.
- o
GetRunViewpointInfo(CATSettingInfo*)
- Retrieves the state of the RunViewpoint parameter.
- o
GetRunVisBehavior(DNBActBehaviorType&)
- Retrieves the RunVisBehavior attribute.
- o
GetRunVisBehaviorInfo(CATSettingInfo*)
- Retrieves the state of the RunVisBehavior parameter.
- o
SetASNavigationMode(DNBSimNavigationMode)
- Sets the ASNavigationMode attribute.
- o
SetASNavigationModeLock(unsigned char)
- Locks or unlocks the ASNavigationMode parameter.
- o
SetASStepSize(float&)
- Sets the ASStepSize attribute.
- o
SetASStepSizeLock(unsigned char)
- Locks or unlocks the ASStepSize parameter.
- o
SetAthAnnotation(CATBoolean)
- Sets the AthAnnotation attribute.
- o
SetAthAnnotationLock(unsigned char)
- Locks or unlocks the AthAnnotation parameter.
- o
SetAthDisableSim(CATBoolean)
- Sets the AthDisableSim attribute.
- o
SetAthDisableSimLock(unsigned char)
- Locks or unlocks the AthDisableSim parameter.
- o
SetAthEndCondition(CATBoolean)
- Sets the AthEndCondition attribute.
- o
SetAthEndConditionLock(unsigned char)
- Locks or unlocks the AthEndCondition parameter.
- o
SetAthHyperlink(CATBoolean)
- Sets the AthHyperlink attribute.
- o
SetAthHyperlinkLock(unsigned char)
- Locks or unlocks the AthHyperlink parameter.
- o
SetAthSelAgentDlg(CATBoolean)
- Sets the AthSelAgentDlg attribute.
- o
SetAthSelAgentDlgLock(unsigned char)
- Locks or unlocks the AthSelAgentDlg parameter.
- o
SetAthStateMgt(CATBoolean)
- Sets the AthStateMgt attribute.
- o
SetAthStateMgtLock(unsigned char)
- Locks or unlocks the AthStateMgt parameter.
- o
SetAthTextMsg(CATBoolean)
- Sets the AthTextMsg attribute.
- o
SetAthTextMsgLock(unsigned char)
- Locks or unlocks the AthTextMsg parameter.
- o
SetAthViewpoint(CATBoolean)
- Sets the AthViewpoint attribute.
- o
SetAthViewpointLock(unsigned char)
- Locks or unlocks the AthViewpoint parameter.
- o
SetPSCycleTime(CATBoolean)
- Sets the PSCycleTime attribute.
- o
SetPSCycleTimeLock(unsigned char)
- Locks or unlocks the PSCycleTime parameter.
- o
SetPSDynClashMode(DNBVisualizationMode)
- Sets the PSDynClashMode attribute.
- o
SetPSDynClashModeLock(unsigned char)
- Locks or unlocks the PSDynClashMode parameter.
- o
SetPSGraphicSimStep(int)
- Sets the PSGraphicSimStep attribute.
- o
SetPSGraphicSimStepLock(unsigned char)
- Locks or unlocks the PSGraphicSimStep parameter.
- o
SetPSGraphicUpdate(DNBSimGraphUpdateMode)
- Sets the PSGraphicUpdate attribute.
- o
SetPSGraphicUpdateLock(unsigned char)
- Locks or unlocks the PSGraphicUpdate parameter.
- o
SetPVEndCondition(CATBoolean)
- Sets the PVEndCondition attribute.
- o
SetPVEndConditionLock(unsigned char)
- Locks or unlocks the PVEndCondition parameter.
- o
SetPVStateMgt(CATBoolean)
- Sets the PVStateMgt attribute.
- o
SetPVStateMgtLock(unsigned char)
- Locks or unlocks the PVStateMgt parameter.
- o
SetRunAnnotBehavior(DNBActBehaviorType)
- Sets the RunAnnotBehavior attribute.
- o
SetRunAnnotBehaviorLock(unsigned char)
- Locks or unlocks the RunAnnotBehavior parameter.
- o
SetRunAnnotation(CATBoolean)
- Sets the RunAnnotation attribute.
- o
SetRunAnnotationLock(unsigned char)
- Locks or unlocks the RunAnnotation parameter.
- o
SetRunEndCondition(CATBoolean)
- Sets the RunEndCondition attribute.
- o
SetRunEndConditionLock(unsigned char)
- Locks or unlocks the RunEndCondition parameter.
- o
SetRunHlnkBehavior(DNBHlnkBehaviorType)
- Sets the RunHlnkBehavior attribute.
- o
SetRunHlnkBehaviorLock(unsigned char)
- Locks or unlocks the RunHlnkBehavior parameter.
- o
SetRunHyperlink(CATBoolean)
- Sets the RunHyperlink attribute.
- o
SetRunHyperlinkLock(unsigned char)
- Locks or unlocks the RunHyperlink parameter.
- o
SetRunPause(CATBoolean)
- Sets the RunPause attribute.
- o
SetRunPauseLock(unsigned char)
- Locks or unlocks the RunPause parameter.
- o
SetRunStateMgt(CATBoolean)
- Sets the RunStateMgt attribute.
- o
SetRunStateMgtLock(unsigned char)
- Locks or unlocks the RunStateMgt parameter.
- o
SetRunStepSize(float&)
- Sets the RunStepSize attribute.
- o
SetRunStepSizeLock(unsigned char)
- Locks or unlocks the RunStepSize parameter.
- o
SetRunTextBehavior(DNBActBehaviorType)
- Sets the RunTextBehavior attribute.
- o
SetRunTextBehaviorLock(unsigned char)
- Locks or unlocks the RunTextBehavior parameter.
- o
SetRunTextMsg(CATBoolean)
- Sets the RunTextMsg attribute.
- o
SetRunTextMsgLock(unsigned char)
- Locks or unlocks the RunTextMsg parameter.
- o
SetRunViewpoint(CATBoolean)
- Sets the RunViewpoint attribute.
- o
SetRunViewpointLock(unsigned char)
- Locks or unlocks the RunViewpoint parameter.
- o
SetRunVisBehavior(DNBActBehaviorType)
- Sets the RunVisBehavior attribute.
- o
SetRunVisBehaviorLock(unsigned char)
- Locks or unlocks the RunVisBehavior parameter.
Methods
o GetASNavigationMode
-
Retrieves the ASNavigationMode attribute.
o GetASNavigationModeInfo
-
Retrieves the state of the ASNavigationMode parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetASStepSize
public virtual HRESULT GetASStepSize( | float& | ioASStepSize)= 0 |
-
Retrieves the ASStepSize attribute.
o GetASStepSizeInfo
-
Retrieves the state of the ASStepSize parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetAthAnnotation
-
Retrieves the AthAnnotation attribute.
o GetAthAnnotationInfo
-
Retrieves the state of the AthAnnotation parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetAthDisableSim
-
Retrieves the AthDisableSim attribute.
o GetAthDisableSimInfo
-
Retrieves the state of the AthDisableSim parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetAthEndCondition
-
Retrieves the AthEndCondition attribute.
Role: The Process Authoring Apply End Condition setting attribute
controls the applying of End Conditions (or End States) beaviour during process creation.
- Parameters:
-
- iAthEndCondition
- [inout] The Process Authoring State Management setting attribute value
Legal values:
TRUE : the Apply End Condition is enabled
FALSE: the Apply End Condition is disabled
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetAthEndConditionInfo
-
Retrieves the state of the AthEndCondition parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetAthHyperlink
-
Retrieves the AthHyperlink attribute.
o GetAthHyperlinkInfo
-
Retrieves the state of the AthHyperlink parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetAthSelAgentDlg
-
Retrieves the AthSelAgentDlg attribute.
o GetAthSelAgentDlgInfo
-
Retrieves the state of the AthSelAgentDlg parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetAthStateMgt
-
Retrieves the AthStateMgt attribute.
Role: The Process Authoring State Management setting attribute
controls the state management beaviour during process creation.
- Parameters:
-
- iAthStateMgt
- [inout] The Process Authoring State Management setting attribute value
Legal values:
TRUE : the State Management is enabled
FALSE: the State Management is disabled
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetAthStateMgtInfo
-
Retrieves the state of the AthStateMgt parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetAthTextMsg
-
Retrieves the AthTextMsg attribute.
o GetAthTextMsgInfo
-
Retrieves the state of the AthTextMsg parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetAthViewpoint
-
Retrieves the AthViewpoint attribute.
o GetAthViewpointInfo
-
Retrieves the state of the AthViewpoint parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetPSCycleTime
-
Retrieves the PSCycleTime attribute.
o GetPSCycleTimeInfo
-
Retrieves the state of the PSCycleTime parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetPSDynClashMode
-
Retrieves the PSDynClashMode attribute.
o GetPSDynClashModeInfo
-
Retrieves the state of the PSDynClashMode parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetPSGraphicSimStep
public virtual HRESULT GetPSGraphicSimStep( | int& | ioPSGraphicSimStep)= 0 |
-
Retrieves the PSGraphicSimStep attribute.
o GetPSGraphicSimStepInfo
-
Retrieves the state of the PSGraphicSimStep parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetPSGraphicUpdate
-
Retrieves the PSGraphicUpdate attribute.
o GetPSGraphicUpdateInfo
-
Retrieves the state of the PSGraphicUpdate parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetPVEndCondition
-
Retrieves the PVEndCondition attribute.
o GetPVEndConditionInfo
-
Retrieves the state of the PVEndCondition parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetPVStateMgt
-
Retrieves the PVStateMgt attribute.
o GetPVStateMgtInfo
-
Retrieves the state of the PVStateMgt parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetRunAnnotBehavior
-
Retrieves the RunAnnotBehavior attribute.
o GetRunAnnotBehaviorInfo
-
Retrieves the state of the RunAnnotBehavior parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetRunAnnotation
-
Retrieves the RunAnnotation attribute.
o GetRunAnnotationInfo
-
Retrieves the state of the RunAnnotation parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetRunEndCondition
-
Retrieves the RunEndCondition attribute.
o GetRunEndConditionInfo
-
Retrieves the state of the RunEndCondition parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetRunHlnkBehavior
-
Retrieves the RunHlnkBehavior attribute.
o GetRunHlnkBehaviorInfo
-
Retrieves the state of the RunHlnkBehavior parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetRunHyperlink
-
Retrieves the RunHyperlink attribute.
o GetRunHyperlinkInfo
-
Retrieves the state of the RunHyperlink parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetRunPause
-
Retrieves the RunPause attribute.
o GetRunPauseInfo
-
Retrieves the state of the RunPause parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetRunStateMgt
-
Retrieves the RunStateMgt attribute.
o GetRunStateMgtInfo
-
Retrieves the state of the RunStateMgt parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetRunStepSize
public virtual HRESULT GetRunStepSize( | float& | ioRunStepSize)= 0 |
-
Retrieves the RunStepSize attribute.
o GetRunStepSizeInfo
-
Retrieves the state of the RunStepSize parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetRunTextBehavior
-
Retrieves the RunTextBehavior attribute.
o GetRunTextBehaviorInfo
-
Retrieves the state of the RunTextBehavior parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetRunTextMsg
-
Retrieves the RunTextMsg attribute.
o GetRunTextMsgInfo
-
Retrieves the state of the RunTextMsg parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetRunViewpoint
-
Retrieves the RunViewpoint attribute.
o GetRunViewpointInfo
-
Retrieves the state of the RunViewpoint parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetRunVisBehavior
-
Retrieves the RunVisBehavior attribute.
o GetRunVisBehaviorInfo
-
Retrieves the state of the RunVisBehavior parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetASNavigationMode
-
Sets the ASNavigationMode attribute.
o SetASNavigationModeLock
public virtual HRESULT SetASNavigationModeLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the ASNavigationMode parameter.
Role: Locks or unlocks the ASNavigationMode parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetASStepSize
public virtual HRESULT SetASStepSize( | const float& | iASStepSize)= 0 |
-
Sets the ASStepSize attribute.
o SetASStepSizeLock
public virtual HRESULT SetASStepSizeLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the ASStepSize parameter.
Role: Locks or unlocks the ASStepSize parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetAthAnnotation
-
Sets the AthAnnotation attribute.
o SetAthAnnotationLock
public virtual HRESULT SetAthAnnotationLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the AthAnnotation parameter.
Role: Locks or unlocks the AthAnnotation parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetAthDisableSim
-
Sets the AthDisableSim attribute.
o SetAthDisableSimLock
public virtual HRESULT SetAthDisableSimLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the AthDisableSim parameter.
Role: Locks or unlocks the AthDisableSim parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetAthEndCondition
-
Sets the AthEndCondition attribute.
- Parameters:
-
- iAthEndCondition
- [in] The Process Authoring Apply End Condition setting attribute value.
Legal values: see #GetAthEndCondition
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetAthEndConditionLock
public virtual HRESULT SetAthEndConditionLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the AthEndCondition parameter.
Role: Locks or unlocks the AthEndCondition parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetAthHyperlink
-
Sets the AthHyperlink attribute.
o SetAthHyperlinkLock
public virtual HRESULT SetAthHyperlinkLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the AthHyperlink parameter.
Role: Locks or unlocks the AthHyperlink parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetAthSelAgentDlg
-
Sets the AthSelAgentDlg attribute.
o SetAthSelAgentDlgLock
public virtual HRESULT SetAthSelAgentDlgLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the AthSelAgentDlg parameter.
Role: Locks or unlocks the AthSelAgentDlg parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetAthStateMgt
-
Sets the AthStateMgt attribute.
- Parameters:
-
- iAthStateMgt
- [in] The Process Authoring State Management setting attribute value.
Legal values: see #GetAthStateMgt
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetAthStateMgtLock
public virtual HRESULT SetAthStateMgtLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the AthStateMgt parameter.
Role: Locks or unlocks the AthStateMgt parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetAthTextMsg
-
Sets the AthTextMsg attribute.
o SetAthTextMsgLock
public virtual HRESULT SetAthTextMsgLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the AthTextMsg parameter.
Role: Locks or unlocks the AthTextMsg parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetAthViewpoint
-
Sets the AthViewpoint attribute.
o SetAthViewpointLock
public virtual HRESULT SetAthViewpointLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the AthViewpoint parameter.
Role: Locks or unlocks the AthViewpoint parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetPSCycleTime
-
Sets the PSCycleTime attribute.
o SetPSCycleTimeLock
public virtual HRESULT SetPSCycleTimeLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the PSCycleTime parameter.
Role: Locks or unlocks the PSCycleTime parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetPSDynClashMode
-
Sets the PSDynClashMode attribute.
o SetPSDynClashModeLock
public virtual HRESULT SetPSDynClashModeLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the PSDynClashMode parameter.
Role: Locks or unlocks the PSDynClashMode parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetPSGraphicSimStep
public virtual HRESULT SetPSGraphicSimStep( | const int | iPSGraphicSimStep)= 0 |
-
Sets the PSGraphicSimStep attribute.
o SetPSGraphicSimStepLock
public virtual HRESULT SetPSGraphicSimStepLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the PSGraphicSimStep parameter.
Role: Locks or unlocks the PSGraphicSimStep parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetPSGraphicUpdate
-
Sets the PSGraphicUpdate attribute.
o SetPSGraphicUpdateLock
public virtual HRESULT SetPSGraphicUpdateLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the PSGraphicUpdate parameter.
Role: Locks or unlocks the PSGraphicUpdate parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetPVEndCondition
-
Sets the PVEndCondition attribute.
o SetPVEndConditionLock
public virtual HRESULT SetPVEndConditionLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the PVEndCondition parameter.
Role: Locks or unlocks the PVEndCondition parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetPVStateMgt
-
Sets the PVStateMgt attribute.
o SetPVStateMgtLock
public virtual HRESULT SetPVStateMgtLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the PVStateMgt parameter.
Role: Locks or unlocks the PVStateMgt parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetRunAnnotBehavior
-
Sets the RunAnnotBehavior attribute.
o SetRunAnnotBehaviorLock
public virtual HRESULT SetRunAnnotBehaviorLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the RunAnnotBehavior parameter.
Role: Locks or unlocks the RunAnnotBehavior parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetRunAnnotation
-
Sets the RunAnnotation attribute.
o SetRunAnnotationLock
public virtual HRESULT SetRunAnnotationLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the RunAnnotation parameter.
Role: Locks or unlocks the RunAnnotation parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetRunEndCondition
-
Sets the RunEndCondition attribute.
o SetRunEndConditionLock
public virtual HRESULT SetRunEndConditionLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the RunEndCondition parameter.
Role: Locks or unlocks the RunEndCondition parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetRunHlnkBehavior
-
Sets the RunHlnkBehavior attribute.
o SetRunHlnkBehaviorLock
public virtual HRESULT SetRunHlnkBehaviorLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the RunHlnkBehavior parameter.
Role: Locks or unlocks the RunHlnkBehavior parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetRunHyperlink
-
Sets the RunHyperlink attribute.
o SetRunHyperlinkLock
public virtual HRESULT SetRunHyperlinkLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the RunHyperlink parameter.
Role: Locks or unlocks the RunHyperlink parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetRunPause
-
Sets the RunPause attribute.
o SetRunPauseLock
public virtual HRESULT SetRunPauseLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the RunPause parameter.
Role: Locks or unlocks the RunPause parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetRunStateMgt
-
Sets the RunStateMgt attribute.
o SetRunStateMgtLock
public virtual HRESULT SetRunStateMgtLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the RunStateMgt parameter.
Role: Locks or unlocks the RunStateMgt parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetRunStepSize
public virtual HRESULT SetRunStepSize( | const float& | iRunStepSize)= 0 |
-
Sets the RunStepSize attribute.
o SetRunStepSizeLock
public virtual HRESULT SetRunStepSizeLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the RunStepSize parameter.
Role: Locks or unlocks the RunStepSize parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetRunTextBehavior
-
Sets the RunTextBehavior attribute.
o SetRunTextBehaviorLock
public virtual HRESULT SetRunTextBehaviorLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the RunTextBehavior parameter.
Role: Locks or unlocks the RunTextBehavior parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetRunTextMsg
-
Sets the RunTextMsg attribute.
o SetRunTextMsgLock
public virtual HRESULT SetRunTextMsgLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the RunTextMsg parameter.
Role: Locks or unlocks the RunTextMsg parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetRunViewpoint
-
Sets the RunViewpoint attribute.
o SetRunViewpointLock
public virtual HRESULT SetRunViewpointLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the RunViewpoint parameter.
Role: Locks or unlocks the RunViewpoint parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetRunVisBehavior
-
Sets the RunVisBehavior attribute.
o SetRunVisBehaviorLock
public virtual HRESULT SetRunVisBehaviorLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the RunVisBehavior parameter.
Role: Locks or unlocks the RunVisBehavior parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
This object is included in the file: DNBISimSimulationSettingAtt.h
If needed, your Imakefile.mk should include the module: DNBSimulationItf