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.


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
public virtual HRESULT GetASNavigationMode(DNBSimNavigationMode& ioASNavigationMode)= 0
Retrieves the ASNavigationMode attribute.
o GetASNavigationModeInfo
public virtual HRESULT GetASNavigationModeInfo(CATSettingInfo* oInfo)= 0
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
public virtual HRESULT GetASStepSizeInfo(CATSettingInfo* oInfo)= 0
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
public virtual HRESULT GetAthAnnotation(CATBoolean& ioAthAnnotation)= 0
Retrieves the AthAnnotation attribute.
o GetAthAnnotationInfo
public virtual HRESULT GetAthAnnotationInfo(CATSettingInfo* oInfo)= 0
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
public virtual HRESULT GetAthDisableSim(CATBoolean& ioAthDisableSim)= 0
Retrieves the AthDisableSim attribute.
o GetAthDisableSimInfo
public virtual HRESULT GetAthDisableSimInfo(CATSettingInfo* oInfo)= 0
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
public virtual HRESULT GetAthEndCondition(CATBoolean& ioAthEndCondition)= 0
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
public virtual HRESULT GetAthEndConditionInfo(CATSettingInfo* oInfo)= 0
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
public virtual HRESULT GetAthHyperlink(CATBoolean& ioAthHyperlink)= 0
Retrieves the AthHyperlink attribute.
o GetAthHyperlinkInfo
public virtual HRESULT GetAthHyperlinkInfo(CATSettingInfo* oInfo)= 0
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
public virtual HRESULT GetAthSelAgentDlg(CATBoolean& ioAthSelAgentDlg)= 0
Retrieves the AthSelAgentDlg attribute.
o GetAthSelAgentDlgInfo
public virtual HRESULT GetAthSelAgentDlgInfo(CATSettingInfo* oInfo)= 0
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
public virtual HRESULT GetAthStateMgt(CATBoolean& ioAthStateMgt)= 0
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
public virtual HRESULT GetAthStateMgtInfo(CATSettingInfo* oInfo)= 0
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
public virtual HRESULT GetAthTextMsg(CATBoolean& ioAthTextMsg)= 0
Retrieves the AthTextMsg attribute.
o GetAthTextMsgInfo
public virtual HRESULT GetAthTextMsgInfo(CATSettingInfo* oInfo)= 0
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
public virtual HRESULT GetAthViewpoint(CATBoolean& ioAthViewpoint)= 0
Retrieves the AthViewpoint attribute.
o GetAthViewpointInfo
public virtual HRESULT GetAthViewpointInfo(CATSettingInfo* oInfo)= 0
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
public virtual HRESULT GetPSCycleTime(CATBoolean& ioPSCycleTime)= 0
Retrieves the PSCycleTime attribute.
o GetPSCycleTimeInfo
public virtual HRESULT GetPSCycleTimeInfo(CATSettingInfo* oInfo)= 0
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
public virtual HRESULT GetPSDynClashMode(DNBVisualizationMode& ioPSDynClashMode)= 0
Retrieves the PSDynClashMode attribute.
o GetPSDynClashModeInfo
public virtual HRESULT GetPSDynClashModeInfo(CATSettingInfo* oInfo)= 0
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
public virtual HRESULT GetPSGraphicSimStepInfo(CATSettingInfo* oInfo)= 0
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
public virtual HRESULT GetPSGraphicUpdate(DNBSimGraphUpdateMode& ioPSGraphicUpdate)= 0
Retrieves the PSGraphicUpdate attribute.
o GetPSGraphicUpdateInfo
public virtual HRESULT GetPSGraphicUpdateInfo(CATSettingInfo* oInfo)= 0
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
public virtual HRESULT GetPVEndCondition(CATBoolean& ioPVEndCondition)= 0
Retrieves the PVEndCondition attribute.
o GetPVEndConditionInfo
public virtual HRESULT GetPVEndConditionInfo(CATSettingInfo* oInfo)= 0
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
public virtual HRESULT GetPVStateMgt(CATBoolean& ioPVStateMgt)= 0
Retrieves the PVStateMgt attribute.
o GetPVStateMgtInfo
public virtual HRESULT GetPVStateMgtInfo(CATSettingInfo* oInfo)= 0
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
public virtual HRESULT GetRunAnnotBehavior(DNBActBehaviorType& ioRunAnnotBehavior)= 0
Retrieves the RunAnnotBehavior attribute.
o GetRunAnnotBehaviorInfo
public virtual HRESULT GetRunAnnotBehaviorInfo(CATSettingInfo* oInfo)= 0
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
public virtual HRESULT GetRunAnnotation(CATBoolean& ioRunAnnotation)= 0
Retrieves the RunAnnotation attribute.
o GetRunAnnotationInfo
public virtual HRESULT GetRunAnnotationInfo(CATSettingInfo* oInfo)= 0
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
public virtual HRESULT GetRunEndCondition(CATBoolean& ioRunEndCondition)= 0
Retrieves the RunEndCondition attribute.
o GetRunEndConditionInfo
public virtual HRESULT GetRunEndConditionInfo(CATSettingInfo* oInfo)= 0
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
public virtual HRESULT GetRunHlnkBehavior(DNBHlnkBehaviorType& ioRunHlnkBehavior)= 0
Retrieves the RunHlnkBehavior attribute.
o GetRunHlnkBehaviorInfo
public virtual HRESULT GetRunHlnkBehaviorInfo(CATSettingInfo* oInfo)= 0
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
public virtual HRESULT GetRunHyperlink(CATBoolean& ioRunHyperlink)= 0
Retrieves the RunHyperlink attribute.
o GetRunHyperlinkInfo
public virtual HRESULT GetRunHyperlinkInfo(CATSettingInfo* oInfo)= 0
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
public virtual HRESULT GetRunPause(CATBoolean& ioRunPause)= 0
Retrieves the RunPause attribute.
o GetRunPauseInfo
public virtual HRESULT GetRunPauseInfo(CATSettingInfo* oInfo)= 0
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
public virtual HRESULT GetRunStateMgt(CATBoolean& ioRunStateMgt)= 0
Retrieves the RunStateMgt attribute.
o GetRunStateMgtInfo
public virtual HRESULT GetRunStateMgtInfo(CATSettingInfo* oInfo)= 0
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
public virtual HRESULT GetRunStepSizeInfo(CATSettingInfo* oInfo)= 0
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
public virtual HRESULT GetRunTextBehavior(DNBActBehaviorType& ioRunTextBehavior)= 0
Retrieves the RunTextBehavior attribute.
o GetRunTextBehaviorInfo
public virtual HRESULT GetRunTextBehaviorInfo(CATSettingInfo* oInfo)= 0
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
public virtual HRESULT GetRunTextMsg(CATBoolean& ioRunTextMsg)= 0
Retrieves the RunTextMsg attribute.
o GetRunTextMsgInfo
public virtual HRESULT GetRunTextMsgInfo(CATSettingInfo* oInfo)= 0
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
public virtual HRESULT GetRunViewpoint(CATBoolean& ioRunViewpoint)= 0
Retrieves the RunViewpoint attribute.
o GetRunViewpointInfo
public virtual HRESULT GetRunViewpointInfo(CATSettingInfo* oInfo)= 0
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
public virtual HRESULT GetRunVisBehavior(DNBActBehaviorType& ioRunVisBehavior)= 0
Retrieves the RunVisBehavior attribute.
o GetRunVisBehaviorInfo
public virtual HRESULT GetRunVisBehaviorInfo(CATSettingInfo* oInfo)= 0
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
public virtual HRESULT SetASNavigationMode( const DNBSimNavigationMode iASNavigationMode)= 0
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
public virtual HRESULT SetAthAnnotation( const CATBoolean iAthAnnotation)= 0
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
public virtual HRESULT SetAthDisableSim( const CATBoolean iAthDisableSim)= 0
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
public virtual HRESULT SetAthEndCondition( const CATBoolean iAthEndCondition)= 0
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
public virtual HRESULT SetAthHyperlink( const CATBoolean iAthHyperlink)= 0
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
public virtual HRESULT SetAthSelAgentDlg( const CATBoolean iAthSelAgentDlg)= 0
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
public virtual HRESULT SetAthStateMgt( const CATBoolean iAthStateMgt)= 0
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
public virtual HRESULT SetAthTextMsg( const CATBoolean iAthTextMsg)= 0
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
public virtual HRESULT SetAthViewpoint( const CATBoolean iAthViewpoint)= 0
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
public virtual HRESULT SetPSCycleTime( const CATBoolean iPSCycleTime)= 0
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
public virtual HRESULT SetPSDynClashMode( const DNBVisualizationMode iPSDynClashMode)= 0
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
public virtual HRESULT SetPSGraphicUpdate( const DNBSimGraphUpdateMode iPSGraphicUpdate)= 0
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
public virtual HRESULT SetPVEndCondition( const CATBoolean iPVEndCondition)= 0
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
public virtual HRESULT SetPVStateMgt( const CATBoolean iPVStateMgt)= 0
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
public virtual HRESULT SetRunAnnotBehavior( const DNBActBehaviorType iRunAnnotBehavior)= 0
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
public virtual HRESULT SetRunAnnotation( const CATBoolean iRunAnnotation)= 0
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
public virtual HRESULT SetRunEndCondition( const CATBoolean iRunEndCondition)= 0
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
public virtual HRESULT SetRunHlnkBehavior( const DNBHlnkBehaviorType iRunHlnkBehavior)= 0
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
public virtual HRESULT SetRunHyperlink( const CATBoolean iRunHyperlink)= 0
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
public virtual HRESULT SetRunPause( const CATBoolean iRunPause)= 0
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
public virtual HRESULT SetRunStateMgt( const CATBoolean iRunStateMgt)= 0
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
public virtual HRESULT SetRunTextBehavior( const DNBActBehaviorType iRunTextBehavior)= 0
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
public virtual HRESULT SetRunTextMsg( const CATBoolean iRunTextMsg)= 0
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
public virtual HRESULT SetRunViewpoint( const CATBoolean iRunViewpoint)= 0
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
public virtual HRESULT SetRunVisBehavior( const DNBActBehaviorType iRunVisBehavior)= 0
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

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