pycatia.structure_interfaces.material_ess_object_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.structure_interfaces.material_ess_object_setting_att.MaterialEssObjectSettingAtt(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
MaterialESSObjectSettingAtt

The interface to access a CATIAMaterialESSObjectSettingAtt.
get_member_material_info(io_admin_level: str, io_locked: str) → bool

Note

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

Retrieves environment informations for the MemberMaterial
parameter.
Role:Retrieves the state of the MemberMaterial 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_plate_material_info(io_admin_level: str, io_locked: str) → bool

Note

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

Retrieves environment informations for the PlateMaterial
parameter.
Role:Retrieves the state of the PlateMaterial 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 member_material: str

Note

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

Returns or sets the MemberMaterial parameter.

Ensure consistency with the C++ interface to which the work is delegated.
Return type:

str

property plate_material: str

Note

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

Returns or sets the PlateMaterial parameter.

Ensure consistency with the C++ interface to which the work is delegated.
Return type:

str

set_member_material_lock(i_locked: bool) → None

Note

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

Locks or unlocks the MemberMaterial parameter.
Role:Locks or unlocks the MemberMaterial 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_plate_material_lock(i_locked: bool) → None

Note

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

Locks or unlocks the PlateMaterial parameter.
Role:Locks or unlocks the PlateMaterial 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