Interface to handle the Analysis & Simulation "GeneralSetting".

Properties

Property AnalysisCacheMode() As

Tells if Product Structure Cache Mode will be handled.

Property AnalysisLoadMode() As

Retrieves if pointed document will be loaded.

Property AnalysisNamingAuto() As

Tells if Automatic naming will be activated.

Property DefaultAnalysisFlag() As

Retrieves if a default analysis Case will be created.

Property DefaultAnalysisTemplate() As

Retrieves the name of the default analysis Case that will be created.

Property ViewAnalysisParameter() As

Retrieves if the Parameter set is visible in the feature tree of the analysis document.

Property ViewAnalysisRelation() As

Retrieves if the Relation set is visible in the feature tree of the analysis document.

Methods

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

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

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

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

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

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

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

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

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

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

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

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

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

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