pycatia.dmaps_interfaces.lib_tab_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.dmaps_interfaces.lib_tab_setting_att.LibTabSettingAtt(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
LibTabSettingAtt
get_id_unique_setting(o_is_unique: int) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub GetIDUniqueSetting(long oIsUnique)

Retrieves the option which enables to check ID uniqueness amongst sibling
processes
Role: Retrieves the option which enables to check ID uniqueness amongst
sibling processes

Parameters:

oIsUnique
Flag indicating whether the check should be enabled or not


Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Parameters:

o_is_unique (int) –

Return type:

None

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

Note

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

Retrieves environment informations for the ‘Unique Check’
parameter.
Role:Retrieves the state of the ‘Unique Check’ parameter in the current
environment.

Parameters:

ioAdminLevel

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.

ioLocked
Indicates if the parameter has been locked.

Returns:
Indicates if the parameter has been explicitly modified or remain to
the administrated value.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_list_of_library_file_path() → tuple

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetListOfLibraryFilePath() As CATSafeArrayVariant

Retrieves the List of Libraries that are used in the Process
document
Role: Retrieves the List of Libraries that are used in the Process
document

Parameters:

ioPath
a CATSafeArrayVariant of CATBSTR that has the list of libraries


Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Return type:

tuple

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

Note

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

Retrieves the information about the list of libraries path that are used in
the Process document
Role:Retrieves the information about the list of libraries path that are
used in the Process document

Parameters:

ioAdminLevel

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.

ioLocked
Indicates if the parameter has been locked.

Returns:
Indicates if the parameter has been explicitly modified or remain to
the administrated value.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_process_id_script(o_path: str) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub GetProcessIDScript(CATBSTR oPath)

Retrieves the path of custom VB script to generate process
ID
Role: Retrieves the path of custom VB script to generate process
ID

Parameters:

oPath
The output path of the custom VB script

Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Parameters:

o_path (str) –

Return type:

None

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

Note

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

Retrieves the information about the custom VB script path that are used in
the Process document
Role:Retrieves the information about the custom VB script path that are
used in the Process document

Parameters:

ioAdminLevel

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.

ioLocked
Indicates if the parameter has been locked.

Returns:
Indicates if the parameter has been explicitly modified or remain to
the administrated value.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

put_list_of_library_file_path(i_path: tuple) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub PutListOfLibraryFilePath(CATSafeArrayVariant iPath)

Sets a List of Libraries that are used in the Process
document
Role: Sets the List of Libraries that are used in the Process
document

Parameters:

iPath
a CATSafeArrayVariant of CATBSTR that has the list of libraries.

Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Parameters:

i_path (tuple) –

Return type:

None

set_id_unique_setting(is_unique: int) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetIDUniqueSetting(long isUnique)

Sets the option which enables to check ID uniqueness amongst sibling
processes
Role: Sets the option which enables to check ID uniqueness amongst sibling
processes

Parameters:

isUnique
Sets the option to enable uniqueness check or not

Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Parameters:

is_unique (int) –

Return type:

None

set_id_unique_setting_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetIDUniqueSettingLock(boolean iLocked)

Locks or unlocks the “Unique Check” parameter.
Role: Locks or unlocks the ‘Unique Check’ 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
Parameters:

i_locked (bool) –

Return type:

None

set_list_of_library_file_path_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetListOfLibraryFilePathLock(boolean iLocked)

Locks or unlocks the list of libraries to be used
Role:Locks or unlocks the “list of libraries” parameter if it is possible
in the current administrative context. 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.
Parameters:

i_locked (bool) –

Return type:

None

set_process_id_script(i_path: str) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetProcessIDScript(CATBSTR iPath)

Sets the path of custom VB script to generate process ID
Role: Sets the path of custom VB script to generate process
ID

Parameters:

iPath
Path of the custom VB script to be set

Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Parameters:

i_path (str) –

Return type:

None

set_process_id_script_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetProcessIDScriptLock(boolean iLocked)

Locks or unlocks the “Custom VB Script” parameter.
Role: Locks or unlocks the ‘Custom VB Script’ 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
Parameters:

i_locked (bool) –

Return type:

None