All Frameworks  Class Hierarchy  This Framework  Indexes   

DNBSimulationInterfaces Interface 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 GetASNavigationModeInfo(CATSettingInfo*)
Retrieves the state of the ASNavigationMode parameter.
o GetASNavigationMode(DNBSimNavigationMode&)
Retrieves the ASNavigationMode attribute.
o GetASStepSizeInfo(CATSettingInfo*)
Retrieves the state of the ASStepSize parameter.
o GetASStepSize(float&)
Retrieves the ASStepSize attribute.
o GetAthAnnotationInfo(CATSettingInfo*)
Retrieves the state of the AthAnnotation parameter.
o GetAthAnnotation(CATBoolean&)
Retrieves the AthAnnotation attribute.
o GetAthDisableSimInfo(CATSettingInfo*)
Retrieves the state of the AthDisableSim parameter.
o GetAthDisableSim(CATBoolean&)
Retrieves the AthDisableSim attribute.
o GetAthEndConditionInfo(CATSettingInfo*)
Retrieves the state of the AthEndCondition parameter.
o GetAthEndCondition(CATBoolean&)
Retrieves the AthEndCondition attribute.
o GetAthHyperlinkInfo(CATSettingInfo*)
Retrieves the state of the AthHyperlink parameter.
o GetAthHyperlink(CATBoolean&)
Retrieves the AthHyperlink attribute.
o GetAthSelAgentDlgInfo(CATSettingInfo*)
Retrieves the state of the AthSelAgentDlg parameter.
o GetAthSelAgentDlg(CATBoolean&)
Retrieves the AthSelAgentDlg attribute.
o GetAthStateMgtInfo(CATSettingInfo*)
Retrieves the state of the AthStateMgt parameter.
o GetAthStateMgt(CATBoolean&)
Retrieves the AthStateMgt attribute.
o GetAthTextMsgInfo(CATSettingInfo*)
Retrieves the state of the AthTextMsg parameter.
o GetAthTextMsg(CATBoolean&)
Retrieves the AthTextMsg attribute.
o GetAthViewpointInfo(CATSettingInfo*)
Retrieves the state of the AthViewpoint parameter.
o GetAthViewpoint(CATBoolean&)
Retrieves the AthViewpoint attribute.
o GetPSCycleTimeInfo(CATSettingInfo*)
Retrieves the state of the PSCycleTime parameter.
o GetPSCycleTime(CATBoolean&)
Retrieves the PSCycleTime attribute.
o GetPSDynClashModeInfo(CATSettingInfo*)
Retrieves the state of the PSDynClashMode parameter.
o GetPSDynClashMode(DNBVisualizationMode&)
Retrieves the PSDynClashMode attribute.
o GetPSGraphicSimStepInfo(CATSettingInfo*)
Retrieves the state of the PSGraphicSimStep parameter.
o GetPSGraphicSimStep(int&)
Retrieves the PSGraphicSimStep attribute.
o GetPSGraphicUpdateInfo(CATSettingInfo*)
Retrieves the state of the PSGraphicUpdate parameter.
o GetPSGraphicUpdate(DNBSimGraphUpdateMode&)
Retrieves the PSGraphicUpdate attribute.
o GetPVEndConditionInfo(CATSettingInfo*)
Retrieves the state of the PVEndCondition parameter.
o GetPVEndCondition(CATBoolean&)
Retrieves the PVEndCondition attribute.
o GetPVStateMgtInfo(CATSettingInfo*)
Retrieves the state of the PVStateMgt parameter.
o GetPVStateMgt(CATBoolean&)
Retrieves the PVStateMgt attribute.
o GetRunAnnotBehaviorInfo(CATSettingInfo*)
Retrieves the state of the RunAnnotBehavior parameter.
o GetRunAnnotBehavior(DNBActBehaviorType&)
Retrieves the RunAnnotBehavior attribute.
o GetRunAnnotationInfo(CATSettingInfo*)
Retrieves the state of the RunAnnotation parameter.
o GetRunAnnotation(CATBoolean&)
Retrieves the RunAnnotation attribute.
o GetRunEndConditionInfo(CATSettingInfo*)
Retrieves the state of the RunEndCondition parameter.
o GetRunEndCondition(CATBoolean&)
Retrieves the RunEndCondition attribute.
o GetRunHlnkBehaviorInfo(CATSettingInfo*)
Retrieves the state of the RunHlnkBehavior parameter.
o GetRunHlnkBehavior(DNBHlnkBehaviorType&)
Retrieves the RunHlnkBehavior attribute.
o GetRunHyperlinkInfo(CATSettingInfo*)
Retrieves the state of the RunHyperlink parameter.
o GetRunHyperlink(CATBoolean&)
Retrieves the RunHyperlink attribute.
o GetRunPauseInfo(CATSettingInfo*)
Retrieves the state of the RunPause parameter.
o GetRunPause(CATBoolean&)
Retrieves the RunPause attribute.
o GetRunStateMgtInfo(CATSettingInfo*)
Retrieves the state of the RunStateMgt parameter.
o GetRunStateMgt(CATBoolean&)
Retrieves the RunStateMgt attribute.
o GetRunStepSizeInfo(CATSettingInfo*)
Retrieves the state of the RunStepSize parameter.
o GetRunStepSize(float&)
Retrieves the RunStepSize attribute.
o GetRunTextBehaviorInfo(CATSettingInfo*)
Retrieves the state of the RunTextBehavior parameter.
o GetRunTextBehavior(DNBActBehaviorType&)
Retrieves the RunTextBehavior attribute.
o GetRunTextMsgInfo(CATSettingInfo*)
Retrieves the state of the RunTextMsg parameter.
o GetRunTextMsg(CATBoolean&)
Retrieves the RunTextMsg attribute.
o GetRunViewpointInfo(CATSettingInfo*)
Retrieves the state of the RunViewpoint parameter.
o GetRunViewpoint(CATBoolean&)
Retrieves the RunViewpoint attribute.
o GetRunVisBehaviorInfo(CATSettingInfo*)
Retrieves the state of the RunVisBehavior parameter.
o GetRunVisBehavior(DNBActBehaviorType&)
Retrieves the RunVisBehavior attribute.
o SetASNavigationModeLock(unsigned char)
Locks or unlocks the ASNavigationMode parameter.
o SetASNavigationMode(DNBSimNavigationMode)
Sets the ASNavigationMode attribute.
o SetASStepSizeLock(unsigned char)
Locks or unlocks the ASStepSize parameter.
o SetASStepSize(float&)
Sets the ASStepSize attribute.
o SetAthAnnotationLock(unsigned char)
Locks or unlocks the AthAnnotation parameter.
o SetAthAnnotation(CATBoolean)
Sets the AthAnnotation attribute.
o SetAthDisableSimLock(unsigned char)
Locks or unlocks the AthDisableSim parameter.
o SetAthDisableSim(CATBoolean)
Sets the AthDisableSim attribute.
o SetAthEndConditionLock(unsigned char)
Locks or unlocks the AthEndCondition parameter.
o SetAthEndCondition(CATBoolean)
Sets the AthEndCondition attribute.
o SetAthHyperlinkLock(unsigned char)
Locks or unlocks the AthHyperlink parameter.
o SetAthHyperlink(CATBoolean)
Sets the AthHyperlink attribute.
o SetAthSelAgentDlgLock(unsigned char)
Locks or unlocks the AthSelAgentDlg parameter.
o SetAthSelAgentDlg(CATBoolean)
Sets the AthSelAgentDlg attribute.
o SetAthStateMgtLock(unsigned char)
Locks or unlocks the AthStateMgt parameter.
o SetAthStateMgt(CATBoolean)
Sets the AthStateMgt attribute.
o SetAthTextMsgLock(unsigned char)
Locks or unlocks the AthTextMsg parameter.
o SetAthTextMsg(CATBoolean)
Sets the AthTextMsg attribute.
o SetAthViewpointLock(unsigned char)
Locks or unlocks the AthViewpoint parameter.
o SetAthViewpoint(CATBoolean)
Sets the AthViewpoint attribute.
o SetPSCycleTimeLock(unsigned char)
Locks or unlocks the PSCycleTime parameter.
o SetPSCycleTime(CATBoolean)
Sets the PSCycleTime attribute.
o SetPSDynClashModeLock(unsigned char)
Locks or unlocks the PSDynClashMode parameter.
o SetPSDynClashMode(DNBVisualizationMode)
Sets the PSDynClashMode attribute.
o SetPSGraphicSimStepLock(unsigned char)
Locks or unlocks the PSGraphicSimStep parameter.
o SetPSGraphicSimStep(int)
Sets the PSGraphicSimStep attribute.
o SetPSGraphicUpdateLock(unsigned char)
Locks or unlocks the PSGraphicUpdate parameter.
o SetPSGraphicUpdate(DNBSimGraphUpdateMode)
Sets the PSGraphicUpdate attribute.
o SetPVEndConditionLock(unsigned char)
Locks or unlocks the PVEndCondition parameter.
o SetPVEndCondition(CATBoolean)
Sets the PVEndCondition attribute.
o SetPVStateMgtLock(unsigned char)
Locks or unlocks the PVStateMgt parameter.
o SetPVStateMgt(CATBoolean)
Sets the PVStateMgt attribute.
o SetRunAnnotBehaviorLock(unsigned char)
Locks or unlocks the RunAnnotBehavior parameter.
o SetRunAnnotBehavior(DNBActBehaviorType)
Sets the RunAnnotBehavior attribute.
o SetRunAnnotationLock(unsigned char)
Locks or unlocks the RunAnnotation parameter.
o SetRunAnnotation(CATBoolean)
Sets the RunAnnotation attribute.
o SetRunEndConditionLock(unsigned char)
Locks or unlocks the RunEndCondition parameter.
o SetRunEndCondition(CATBoolean)
Sets the RunEndCondition attribute.
o SetRunHlnkBehaviorLock(unsigned char)
Locks or unlocks the RunHlnkBehavior parameter.
o SetRunHlnkBehavior(DNBHlnkBehaviorType)
Sets the RunHlnkBehavior attribute.
o SetRunHyperlinkLock(unsigned char)
Locks or unlocks the RunHyperlink parameter.
o SetRunHyperlink(CATBoolean)
Sets the RunHyperlink attribute.
o SetRunPauseLock(unsigned char)
Locks or unlocks the RunPause parameter.
o SetRunPause(CATBoolean)
Sets the RunPause attribute.
o SetRunStateMgtLock(unsigned char)
Locks or unlocks the RunStateMgt parameter.
o SetRunStateMgt(CATBoolean)
Sets the RunStateMgt attribute.
o SetRunStepSizeLock(unsigned char)
Locks or unlocks the RunStepSize parameter.
o SetRunStepSize(float&)
Sets the RunStepSize attribute.
o SetRunTextBehaviorLock(unsigned char)
Locks or unlocks the RunTextBehavior parameter.
o SetRunTextBehavior(DNBActBehaviorType)
Sets the RunTextBehavior attribute.
o SetRunTextMsgLock(unsigned char)
Locks or unlocks the RunTextMsg parameter.
o SetRunTextMsg(CATBoolean)
Sets the RunTextMsg attribute.
o SetRunViewpointLock(unsigned char)
Locks or unlocks the RunViewpoint parameter.
o SetRunViewpoint(CATBoolean)
Sets the RunViewpoint attribute.
o SetRunVisBehaviorLock(unsigned char)
Locks or unlocks the RunVisBehavior parameter.
o SetRunVisBehavior(DNBActBehaviorType)
Sets the RunVisBehavior attribute.

Methods


o GetASNavigationModeInfo
public virtual GetASNavigationModeInfo( oInfo)
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 GetASNavigationMode
public virtual GetASNavigationMode( ioASNavigationMode)
Retrieves the ASNavigationMode attribute.
o GetASStepSizeInfo
public virtual GetASStepSizeInfo( oInfo)
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 GetASStepSize
public virtual GetASStepSize( ioASStepSize)
Retrieves the ASStepSize attribute.
o GetAthAnnotationInfo
public virtual GetAthAnnotationInfo( oInfo)
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 GetAthAnnotation
public virtual GetAthAnnotation( ioAthAnnotation)
Retrieves the AthAnnotation attribute.
o GetAthDisableSimInfo
public virtual GetAthDisableSimInfo( oInfo)
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 GetAthDisableSim
public virtual GetAthDisableSim( ioAthDisableSim)
Retrieves the AthDisableSim attribute.
o GetAthEndConditionInfo
public virtual GetAthEndConditionInfo( oInfo)
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 GetAthEndCondition
public virtual GetAthEndCondition( ioAthEndCondition)
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 GetAthHyperlinkInfo
public virtual GetAthHyperlinkInfo( oInfo)
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 GetAthHyperlink
public virtual GetAthHyperlink( ioAthHyperlink)
Retrieves the AthHyperlink attribute.
o GetAthSelAgentDlgInfo
public virtual GetAthSelAgentDlgInfo( oInfo)
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 GetAthSelAgentDlg
public virtual GetAthSelAgentDlg( ioAthSelAgentDlg)
Retrieves the AthSelAgentDlg attribute.
o GetAthStateMgtInfo
public virtual GetAthStateMgtInfo( oInfo)
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 GetAthStateMgt
public virtual GetAthStateMgt( ioAthStateMgt)
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 GetAthTextMsgInfo
public virtual GetAthTextMsgInfo( oInfo)
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 GetAthTextMsg
public virtual GetAthTextMsg( ioAthTextMsg)
Retrieves the AthTextMsg attribute.
o GetAthViewpointInfo
public virtual GetAthViewpointInfo( oInfo)
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 GetAthViewpoint
public virtual GetAthViewpoint( ioAthViewpoint)
Retrieves the AthViewpoint attribute.
o GetPSCycleTimeInfo
public virtual GetPSCycleTimeInfo( oInfo)
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 GetPSCycleTime
public virtual GetPSCycleTime( ioPSCycleTime)
Retrieves the PSCycleTime attribute.
o GetPSDynClashModeInfo
public virtual GetPSDynClashModeInfo( oInfo)
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 GetPSDynClashMode
public virtual GetPSDynClashMode( ioPSDynClashMode)
Retrieves the PSDynClashMode attribute.
o GetPSGraphicSimStepInfo
public virtual GetPSGraphicSimStepInfo( oInfo)
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 GetPSGraphicSimStep
public virtual GetPSGraphicSimStep( ioPSGraphicSimStep)
Retrieves the PSGraphicSimStep attribute.
o GetPSGraphicUpdateInfo
public virtual GetPSGraphicUpdateInfo( oInfo)
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 GetPSGraphicUpdate
public virtual GetPSGraphicUpdate( ioPSGraphicUpdate)
Retrieves the PSGraphicUpdate attribute.
o GetPVEndConditionInfo
public virtual GetPVEndConditionInfo( oInfo)
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 GetPVEndCondition
public virtual GetPVEndCondition( ioPVEndCondition)
Retrieves the PVEndCondition attribute.
o GetPVStateMgtInfo
public virtual GetPVStateMgtInfo( oInfo)
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 GetPVStateMgt
public virtual GetPVStateMgt( ioPVStateMgt)
Retrieves the PVStateMgt attribute.
o GetRunAnnotBehaviorInfo
public virtual GetRunAnnotBehaviorInfo( oInfo)
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 GetRunAnnotBehavior
public virtual GetRunAnnotBehavior( ioRunAnnotBehavior)
Retrieves the RunAnnotBehavior attribute.
o GetRunAnnotationInfo
public virtual GetRunAnnotationInfo( oInfo)
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 GetRunAnnotation
public virtual GetRunAnnotation( ioRunAnnotation)
Retrieves the RunAnnotation attribute.
o GetRunEndConditionInfo
public virtual GetRunEndConditionInfo( oInfo)
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 GetRunEndCondition
public virtual GetRunEndCondition( ioRunEndCondition)
Retrieves the RunEndCondition attribute.
o GetRunHlnkBehaviorInfo
public virtual GetRunHlnkBehaviorInfo( oInfo)
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 GetRunHlnkBehavior
public virtual GetRunHlnkBehavior( ioRunHlnkBehavior)
Retrieves the RunHlnkBehavior attribute.
o GetRunHyperlinkInfo
public virtual GetRunHyperlinkInfo( oInfo)
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 GetRunHyperlink
public virtual GetRunHyperlink( ioRunHyperlink)
Retrieves the RunHyperlink attribute.
o GetRunPauseInfo
public virtual GetRunPauseInfo( oInfo)
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 GetRunPause
public virtual GetRunPause( ioRunPause)
Retrieves the RunPause attribute.
o GetRunStateMgtInfo
public virtual GetRunStateMgtInfo( oInfo)
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 GetRunStateMgt
public virtual GetRunStateMgt( ioRunStateMgt)
Retrieves the RunStateMgt attribute.
o GetRunStepSizeInfo
public virtual GetRunStepSizeInfo( oInfo)
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 GetRunStepSize
public virtual GetRunStepSize( ioRunStepSize)
Retrieves the RunStepSize attribute.
o GetRunTextBehaviorInfo
public virtual GetRunTextBehaviorInfo( oInfo)
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 GetRunTextBehavior
public virtual GetRunTextBehavior( ioRunTextBehavior)
Retrieves the RunTextBehavior attribute.
o GetRunTextMsgInfo
public virtual GetRunTextMsgInfo( oInfo)
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 GetRunTextMsg
public virtual GetRunTextMsg( ioRunTextMsg)
Retrieves the RunTextMsg attribute.
o GetRunViewpointInfo
public virtual GetRunViewpointInfo( oInfo)
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 GetRunViewpoint
public virtual GetRunViewpoint( ioRunViewpoint)
Retrieves the RunViewpoint attribute.
o GetRunVisBehaviorInfo
public virtual GetRunVisBehaviorInfo( oInfo)
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 GetRunVisBehavior
public virtual GetRunVisBehavior( ioRunVisBehavior)
Retrieves the RunVisBehavior attribute.
o SetASNavigationModeLock
public virtual SetASNavigationModeLock( iLocked)
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 SetASNavigationMode
public virtual SetASNavigationMode( const iASNavigationMode)
Sets the ASNavigationMode attribute.
o SetASStepSizeLock
public virtual SetASStepSizeLock( iLocked)
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 SetASStepSize
public virtual SetASStepSize( const iASStepSize)
Sets the ASStepSize attribute.
o SetAthAnnotationLock
public virtual SetAthAnnotationLock( iLocked)
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 SetAthAnnotation
public virtual SetAthAnnotation( const iAthAnnotation)
Sets the AthAnnotation attribute.
o SetAthDisableSimLock
public virtual SetAthDisableSimLock( iLocked)
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 SetAthDisableSim
public virtual SetAthDisableSim( const iAthDisableSim)
Sets the AthDisableSim attribute.
o SetAthEndConditionLock
public virtual SetAthEndConditionLock( iLocked)
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 SetAthEndCondition
public virtual SetAthEndCondition( const iAthEndCondition)
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 SetAthHyperlinkLock
public virtual SetAthHyperlinkLock( iLocked)
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 SetAthHyperlink
public virtual SetAthHyperlink( const iAthHyperlink)
Sets the AthHyperlink attribute.
o SetAthSelAgentDlgLock
public virtual SetAthSelAgentDlgLock( iLocked)
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 SetAthSelAgentDlg
public virtual SetAthSelAgentDlg( const iAthSelAgentDlg)
Sets the AthSelAgentDlg attribute.
o SetAthStateMgtLock
public virtual SetAthStateMgtLock( iLocked)
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 SetAthStateMgt
public virtual SetAthStateMgt( const iAthStateMgt)
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 SetAthTextMsgLock
public virtual SetAthTextMsgLock( iLocked)
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 SetAthTextMsg
public virtual SetAthTextMsg( const iAthTextMsg)
Sets the AthTextMsg attribute.
o SetAthViewpointLock
public virtual SetAthViewpointLock( iLocked)
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 SetAthViewpoint
public virtual SetAthViewpoint( const iAthViewpoint)
Sets the AthViewpoint attribute.
o SetPSCycleTimeLock
public virtual SetPSCycleTimeLock( iLocked)
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 SetPSCycleTime
public virtual SetPSCycleTime( const iPSCycleTime)
Sets the PSCycleTime attribute.
o SetPSDynClashModeLock
public virtual SetPSDynClashModeLock( iLocked)
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 SetPSDynClashMode
public virtual SetPSDynClashMode( const iPSDynClashMode)
Sets the PSDynClashMode attribute.
o SetPSGraphicSimStepLock
public virtual SetPSGraphicSimStepLock( iLocked)
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 SetPSGraphicSimStep
public virtual SetPSGraphicSimStep( const iPSGraphicSimStep)
Sets the PSGraphicSimStep attribute.
o SetPSGraphicUpdateLock
public virtual SetPSGraphicUpdateLock( iLocked)
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 SetPSGraphicUpdate
public virtual SetPSGraphicUpdate( const iPSGraphicUpdate)
Sets the PSGraphicUpdate attribute.
o SetPVEndConditionLock
public virtual SetPVEndConditionLock( iLocked)
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 SetPVEndCondition
public virtual SetPVEndCondition( const iPVEndCondition)
Sets the PVEndCondition attribute.
o SetPVStateMgtLock
public virtual SetPVStateMgtLock( iLocked)
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 SetPVStateMgt
public virtual SetPVStateMgt( const iPVStateMgt)
Sets the PVStateMgt attribute.
o SetRunAnnotBehaviorLock
public virtual SetRunAnnotBehaviorLock( iLocked)
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 SetRunAnnotBehavior
public virtual SetRunAnnotBehavior( const iRunAnnotBehavior)
Sets the RunAnnotBehavior attribute.
o SetRunAnnotationLock
public virtual SetRunAnnotationLock( iLocked)
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 SetRunAnnotation
public virtual SetRunAnnotation( const iRunAnnotation)
Sets the RunAnnotation attribute.
o SetRunEndConditionLock
public virtual SetRunEndConditionLock( iLocked)
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 SetRunEndCondition
public virtual SetRunEndCondition( const iRunEndCondition)
Sets the RunEndCondition attribute.
o SetRunHlnkBehaviorLock
public virtual SetRunHlnkBehaviorLock( iLocked)
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 SetRunHlnkBehavior
public virtual SetRunHlnkBehavior( const iRunHlnkBehavior)
Sets the RunHlnkBehavior attribute.
o SetRunHyperlinkLock
public virtual SetRunHyperlinkLock( iLocked)
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 SetRunHyperlink
public virtual SetRunHyperlink( const iRunHyperlink)
Sets the RunHyperlink attribute.
o SetRunPauseLock
public virtual SetRunPauseLock( iLocked)
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 SetRunPause
public virtual SetRunPause( const iRunPause)
Sets the RunPause attribute.
o SetRunStateMgtLock
public virtual SetRunStateMgtLock( iLocked)
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 SetRunStateMgt
public virtual SetRunStateMgt( const iRunStateMgt)
Sets the RunStateMgt attribute.
o SetRunStepSizeLock
public virtual SetRunStepSizeLock( iLocked)
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 SetRunStepSize
public virtual SetRunStepSize( const iRunStepSize)
Sets the RunStepSize attribute.
o SetRunTextBehaviorLock
public virtual SetRunTextBehaviorLock( iLocked)
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 SetRunTextBehavior
public virtual SetRunTextBehavior( const iRunTextBehavior)
Sets the RunTextBehavior attribute.
o SetRunTextMsgLock
public virtual SetRunTextMsgLock( iLocked)
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 SetRunTextMsg
public virtual SetRunTextMsg( const iRunTextMsg)
Sets the RunTextMsg attribute.
o SetRunViewpointLock
public virtual SetRunViewpointLock( iLocked)
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 SetRunViewpoint
public virtual SetRunViewpoint( const iRunViewpoint)
Sets the RunViewpoint attribute.
o SetRunVisBehaviorLock
public virtual SetRunVisBehaviorLock( iLocked)
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
o SetRunVisBehavior
public virtual SetRunVisBehavior( const iRunVisBehavior)
Sets the RunVisBehavior attribute.

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.