pycatia.analysis_interfaces.analysis_general_setting_att

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-09-25 14:34:21.593357

Warning

The notes denoted “CAA V5 Visual Basic Help” are to be used as reference only. They are there as a guide as to how the visual basic / catscript functions work and thus help debugging in pycatia.

class pycatia.analysis_interfaces.analysis_general_setting_att.AnalysisGeneralSettingAtt(com_object)

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

System.IUnknown
System.IDispatch
System.CATBaseUnknown
System.CATBaseDispatch
System.AnyObject
System.SettingController
AnalysisGeneralSettingAtt

Interface to handle the Analysis & Simulation
“GeneralSetting”.
property analysis_cache_mode: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property AnalysisCacheMode() As long

Tells if Product Structure Cache Mode will be handled.
Return type:

int

property analysis_load_mode: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property AnalysisLoadMode() As long

Retrieves if pointed document will be loaded.
Return type:

int

property analysis_naming_auto: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property AnalysisNamingAuto() As long

Tells if Automatic naming will be activated.
Return type:

int

property default_analysis_flag: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property DefaultAnalysisFlag() As long

Retrieves if a default analysis Case will be created.
Return type:

int

property default_analysis_template: str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property DefaultAnalysisTemplate() As CATBSTR

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

str

get_analysis_cache_mode_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetAnalysisCacheModeInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

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
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_analysis_load_mode_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetAnalysisLoadModeInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

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
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_analysis_naming_auto_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetAnalysisNamingAutoInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

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
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_default_analysis_flag_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetDefaultAnalysisFlagInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

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
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_default_analysis_template_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetDefaultAnalysisTemplateInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

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
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_view_analysis_parameter_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetViewAnalysisParameterInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

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
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_view_analysis_relation_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetViewAnalysisRelationInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

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
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

set_analysis_cache_mode_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetAnalysisCacheModeLock(boolean 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
Parameters:

i_locked (bool) –

Return type:

None

set_analysis_load_mode_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetAnalysisLoadModeLock(boolean 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
Parameters:

i_locked (bool) –

Return type:

None

set_analysis_naming_auto_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetAnalysisNamingAutoLock(boolean 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
Parameters:

i_locked (bool) –

Return type:

None

set_default_analysis_flag_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetDefaultAnalysisFlagLock(boolean 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
Parameters:

i_locked (bool) –

Return type:

None

set_default_analysis_template_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetDefaultAnalysisTemplateLock(boolean 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
Parameters:

i_locked (bool) –

Return type:

None

set_view_analysis_parameter_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetViewAnalysisParameterLock(boolean 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
Parameters:

i_locked (bool) –

Return type:

None

set_view_analysis_relation_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetViewAnalysisRelationLock(boolean 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
Parameters:

i_locked (bool) –

Return type:

None

property view_analysis_parameter: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property ViewAnalysisParameter() As long

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

int

property view_analysis_relation: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property ViewAnalysisRelation() As long

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

int