pycatia.structure_interfaces.type_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.type_ess_object_setting_att.TypeEssObjectSettingAtt(com_object)¶
Note
CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
System.IUnknownSystem.IDispatchSystem.CATBaseUnknownSystem.CATBaseDispatchSystem.AnyObjectSystem.SettingControllerTypeESSObjectSettingAttThe interface to access a CATIATypeESSObjectSettingAtt.- get_member_types_info(io_admin_level: str, io_locked: str) bool ¶
Note
- CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
- o Func GetMemberTypesInfo(CATBSTR ioAdminLevel,CATBSTR ioLocked) As booleanRetrieves environment informations for the MemberTypesparameter.Role:Retrieves the state of the MemberTypes parameter in the currentenvironment.Parameters:ioAdminLevelIf the parameter is locked, AdminLevel gives the administrationlevel that imposes the value of the parameter.If the parameter is not locked, AdminLevel gives the administrationlevel that will give the value of the parameter after a reset.ioLockedIndicates if the parameter has been locked.Returns:Indicates if the parameter has been explicitly modified or remain tothe administrated value.
- Parameters:
io_admin_level (str) –
io_locked (str) –
- Return type:
bool
- get_plate_types_info(io_admin_level: str, io_locked: str) bool ¶
Note
- CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
- o Func GetPlateTypesInfo(CATBSTR ioAdminLevel,CATBSTR ioLocked) As booleanRetrieves environment informations for the PlateTypesparameter.Role:Retrieves the state of the PlateTypes parameter in the currentenvironment.Parameters:ioAdminLevelIf the parameter is locked, AdminLevel gives the administrationlevel that imposes the value of the parameter.If the parameter is not locked, AdminLevel gives the administrationlevel that will give the value of the parameter after a reset.ioLockedIndicates if the parameter has been locked.Returns:Indicates if the parameter has been explicitly modified or remain tothe administrated value.
- Parameters:
io_admin_level (str) –
io_locked (str) –
- Return type:
bool
- property member_types: str¶
Note
- CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
- o Property MemberTypes() As CATBSTRReturns or sets the MemberTypes parameter.Ensure consistency with the C++ interface to which the work is delegated.
- Return type:
str
- property plate_types: str¶
Note
- CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
- o Property PlateTypes() As CATBSTRReturns or sets the PlateTypes parameter.Ensure consistency with the C++ interface to which the work is delegated.
- Return type:
str
- set_member_types_lock(i_locked: bool) None ¶
Note
- CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
- o Sub SetMemberTypesLock(boolean iLocked)Locks or unlocks the MemberTypes parameter.Role:Locks or unlocks the MemberTypes parameter if it is possible in thecurrent administrative context. In user mode this method will always returnE_FAIL.Parameters:iLockedthe locking operation to be performed Legalvalues:TRUE : to lock the parameter.FALSE: to unlock the parameter.
- Parameters:
i_locked (bool) –
- Return type:
None
- set_plate_types_lock(i_locked: bool) None ¶
Note
- CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
- o Sub SetPlateTypesLock(boolean iLocked)Locks or unlocks the PlateTypes parameter.Role:Locks or unlocks the PlateTypes parameter if it is possible in thecurrent administrative context. In user mode this method will always returnE_FAIL.Parameters:iLockedthe locking operation to be performed Legalvalues:TRUE : to lock the parameter.FALSE: to unlock the parameter.
- Parameters:
i_locked (bool) –
- Return type:
None