pycatia.dmaps_interfaces.verif_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.verif_tab_setting_att.VerifyTabSettingAtt(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
VerifTabSettingAtt
property all_resource_filter: int

Note

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

Returns or sets the value to signify Whether all the resources will appear
during Process Navigation
Role: Returns or sets the value to signify Whether all the resources will
appear during Process Navigation
Return type:

int

property auto_reframe_filter: int

Note

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

Returns or sets the value to signify Whether the ‘Auto Reframe’ will happen
during Process navigation
Role: Returns or sets the value to signify Whether all the items/resources
will be reframed during Process Navigation
Return type:

int

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

Note

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

Retrieves environment informations for the “View All Resources”
parameter.
Role:Retrieves the state of the “View All Resources” 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_auto_reframe_filter_info(io_admin_level: str, io_locked: str) → bool

Note

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

Retrieves environment informations for the “Auto Reframe”
parameter.
Role:Retrieves the state of the “Auto Reframe” 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_implied_resource_filter_info(io_admin_level: str, io_locked: str) → bool

Note

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

Retrieves environment informations for the “View Implied Resource”
parameter.
Role:Retrieves the state of the “View Implied Resource” 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

property implied_resource_filter: int

Note

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

Returns or sets the value to signify Whether the Assigned resource will
appear during Process Navigation
Role: Returns or sets the value to signify Whether all the Assigned
resource will appear during Process Navigation
Return type:

int

set_all_resource_filter_lock(i_locked: bool) → None

Note

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

Locks or unlocks the “View All Resources” parameter.
Role:Locks or unlocks the “View All Resources” 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_auto_reframe_filter_lock(i_locked: bool) → None

Note

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

Locks or unlocks the “Auto Reframe” parameter.
Role:Locks or unlocks the “Auto Reframe” 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_implied_resource_filter_lock(i_locked: bool) → None

Note

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

Locks or unlocks the Xxx parameter.
Role:Locks or unlocks the “View Implied Resource” 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