pycatia.bkt_interfaces.behavior_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.bkt_interfaces.behavior_setting_att.BehaviorSettingAtt(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

BehaviorSettingAtt

Enables attribute access to BKT options.

property bkt_access_rights: int

Note

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

o Property BKTAccessRights() As long

Returns or sets the BKTAccessRights parameter.

Parameters:

iBKTAccessRights

oBKTAccessRights Legal values:

0 : User mode

1: Administrator mode

2: Expert mode

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Return type:

int

property bkt_behavior_operation_message: int

Note

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

o Property BKTBehaviorOperationMessage() As long

Returns or sets the BKTBehaviorOperationMessage parameter.

Parameters:

iBKTBehaviorOperationMessage

oBKTBehaviorOperationMessage Legal values:

0 : No operation messages

1: with operation messages

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Return type:

int

property bkt_specification_tree: int

Note

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

o Property BKTSpecificationTree() As long

Returns or sets the BKTSpecificationTree parameter.

Parameters:

iBKTSpecificationTree

oBKTSpecificationTree Legal values:

0 : hides behaviors variables

1: displays behaviors variables

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Return type:

int

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

Note

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

o Func GetBKTAccessRightsInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the BKTAccessRights

parameter.

Role:Retrieves the state of the BKTAccessRights 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_bkt_behavior_operation_message_info(io_admin_level: str, io_locked: str) → bool

Note

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

o Func GetBKTBehaviorOperationMessageInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the BKTBehaviorOperationMessage

parameter.

Role:Retrieves the state of the BKTBehaviorOperationMessage 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_bkt_specification_tree_info(io_admin_level: str, io_locked: str) → bool

Note

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

o Func GetBKTSpecificationTreeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the BKTSpecificationTree

parameter.

Role:Retrieves the state of the BKTSpecificationTree 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

set_bkt_access_rights_lock(i_locked: bool) → None

Note

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

o Sub SetBKTAccessRightsLock(boolean iLocked)

Locks or unlocks the BKTAccessRights parameter.

Role:Locks or unlocks the BKTAccessRights 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_bkt_behavior_operation_message_lock(i_locked: bool) → None

Note

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

o Sub SetBKTBehaviorOperationMessageLock(boolean iLocked)

Locks or unlocks the BKTBehaviorOperationMessage

parameter.

Role:Locks or unlocks the BKTBehaviorOperationMessage 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_bkt_specification_tree_lock(i_locked: bool) → None

Note

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

o Sub SetBKTSpecificationTreeLock(boolean iLocked)

Locks or unlocks the BKTSpecificationTree parameter.

Role:Locks or unlocks the BKTSpecificationTree 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