All Frameworks  Object Hierarchy  This Framework  Indexes

AnalysisGeneralSettingAtt (Object)

Interface to handle the Analysis & Simulation "GeneralSetting".

Property Index

AnalysisCacheMode
Tells if Product Structure Cache Mode will be handled.
AnalysisLoadMode
Retrieves if pointed document will be loaded.
AnalysisNamingAuto
Tells if Automatic naming will be activated.
DefaultAnalysisFlag
Retrieves if a default analysis Case will be created.
DefaultAnalysisTemplate
Retrieves the name of the default analysis Case that will be created.
ViewAnalysisParameter
Retrieves if the Parameter set is visible in the feature tree of the analysis document.
ViewAnalysisRelation
Retrieves if the Relation set is visible in the feature tree of the analysis document.

Method Index

GetAnalysisCacheModeInfo
Retrieves environment informations for the parameter.
GetAnalysisLoadModeInfo
Retrieves environment informations for the parameter.
GetAnalysisNamingAutoInfo
Retrieves environment informations for the parameter.
GetDefaultAnalysisFlagInfo
Retrieves environment informations for the default flag.
GetDefaultAnalysisTemplateInfo
Retrieves environment informations for the default template.
GetViewAnalysisParameterInfo
Retrieves environment informations for the parameter.
GetViewAnalysisRelationInfo
Retrieves environment informations for the parameter.
SetAnalysisCacheModeLock
Locks or unlocks the flag.
SetAnalysisLoadModeLock
Locks or unlocks the flag.
SetAnalysisNamingAutoLock
Locks or unlocks the flag.
SetDefaultAnalysisFlagLock
Locks or unlocks the flag.
SetDefaultAnalysisTemplateLock
Locks or unlocks the flag.
SetViewAnalysisParameterLock
Locks or unlocks the flag.
SetViewAnalysisRelationLock
Locks or unlocks the flag.

Properties


o Property AnalysisCacheMode() As
Tells if Product Structure Cache Mode will be handled.
o Property AnalysisLoadMode() As
Retrieves if pointed document will be loaded.
o Property AnalysisNamingAuto() As
Tells if Automatic naming will be activated.
o Property DefaultAnalysisFlag() As
Retrieves if a default analysis Case will be created.
o Property DefaultAnalysisTemplate() As
Retrieves the name of the default analysis Case that will be created.
o Property ViewAnalysisParameter() As
Retrieves if the Parameter set is visible in the feature tree of the analysis document.
o Property ViewAnalysisRelation() As
Retrieves if the Relation set is visible in the feature tree of the analysis document.

Methods


o Func GetAnalysisCacheModeInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the parameter.
Role:Retrieves the state of the parameter in the current environment.
Parameters:
AdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
oLocked
Indicates if the parameter has been locked.
oModified
Indicates if the parameter has been explicitly modified or remain to the administrated value.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o Func GetAnalysisLoadModeInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the parameter.
Role:Retrieves the state of the parameter in the current environment.
Parameters:
AdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
oLocked
Indicates if the parameter has been locked.
oModified
Indicates if the parameter has been explicitly modified or remain to the administrated value.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o Func GetAnalysisNamingAutoInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the parameter.
Role:Retrieves the state of the parameter in the current environment.
Parameters:
AdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
oLocked
Indicates if the parameter has been locked.
oModified
Indicates if the parameter has been explicitly modified or remain to the administrated value.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o Func GetDefaultAnalysisFlagInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the default flag.
Role:Retrieves the state of the default flag in the current environment.
Parameters:
AdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
oLocked
Indicates if the parameter has been locked.
oModified
Indicates if the parameter has been explicitly modified or remain to the administrated value.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o Func GetDefaultAnalysisTemplateInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the default template.
Role:Retrieves the state of the default template in the current environment.
Parameters:
AdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
oLocked
Indicates if the parameter has been locked.
oModified
Indicates if the parameter has been explicitly modified or remain to the administrated value.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o Func GetViewAnalysisParameterInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the parameter.
Role:Retrieves the state of the parameter in the current environment.
Parameters:
AdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
oLocked
Indicates if the parameter has been locked.
oModified
Indicates if the parameter has been explicitly modified or remain to the administrated value.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o Func GetViewAnalysisRelationInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the parameter.
Role:Retrieves the state of the parameter in the current environment.
Parameters:
AdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
oLocked
Indicates if the parameter has been locked.
oModified
Indicates if the parameter has been explicitly modified or remain to the administrated value.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o Sub SetAnalysisCacheModeLock( iLocked)
Locks or unlocks the flag.
Role:Locks or unlocks the parameter if it is possible in the current administrated. In user mode this method will always return E_FAIL.
Parameters:
iLocked
The locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o Sub SetAnalysisLoadModeLock( iLocked)
Locks or unlocks the flag.
Role:Locks or unlocks the parameter if it is possible in the current administrated. In user mode this method will always return E_FAIL.
Parameters:
iLocked
The locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o Sub SetAnalysisNamingAutoLock( iLocked)
Locks or unlocks the flag.
Role:Locks or unlocks the parameter if it is possible in the current administrated. In user mode this method will always return E_FAIL.
Parameters:
iLocked
The locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o Sub SetDefaultAnalysisFlagLock( iLocked)
Locks or unlocks the flag.
Role:Locks or unlocks the parameter if it is possible in the current administrated. In user mode this method will always return E_FAIL.
Parameters:
iLocked
The locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o Sub SetDefaultAnalysisTemplateLock( iLocked)
Locks or unlocks the flag.
Role:Locks or unlocks the parameter if it is possible in the current administrated. In user mode this method will always return E_FAIL.
Parameters:
iLocked
The locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o Sub SetViewAnalysisParameterLock( iLocked)
Locks or unlocks the flag.
Role:Locks or unlocks the parameter if it is possible in the current administrated. In user mode this method will always return E_FAIL.
Parameters:
iLocked
The locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o Sub SetViewAnalysisRelationLock( iLocked)
Locks or unlocks the flag.
Role:Locks or unlocks the parameter if it is possible in the current administrated. In user mode this method will always return E_FAIL.
Parameters:
iLocked
The locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure

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