pycatia.dnb_ehm_interfaces.plug_map_view_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.dnb_ehm_interfaces.plug_map_view_setting_att.PlugMapViewSettingAtt(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
PlugMapViewSettingAtt

Interface representing xxx.

Role: Components that implement DNBIAPlugMapViewSettingAtt are
…

Do not use the DNBIAPlugMapViewSettingAtt interface for such and such
ClassReference, Class#MethodReference, #InternalMethod…
addto_logical_data_attr_list(iparameter_name: str, i_refparam_name: str) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub AddtoLogicalDataAttrList(CATBSTR iparameterName,
CATBSTR iRefparamName)

Method to add a parameter to the LogicalDataAttrList.
Parameters:

  • iparameter_name (str) –

  • i_refparam_name (str) –

Return type:

None

addto_termination_attr_list(iparameter_name: str, i_refparam_name: str) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub AddtoTerminationAttrList(CATBSTR iparameterName,
CATBSTR iRefparamName)

Method to add a parameter to the TerminationAttrList.
Parameters:

  • iparameter_name (str) –

  • i_refparam_name (str) –

Return type:

None

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

Note

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

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

Note

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

Retrieves environment informations for the TerminationAttrList
parameter.
Role:Retrieves the state of the TerminationAttrList 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 logical_data_attr_list: tuple

Note

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

Returns or sets the LogicalDataAttrList parameter.

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

tuple

remove_from_logical_data_attr_list(iparameter_name: str) → None

Note

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

Method to Remove a parameter fron the LogicalDataAttrList.
Parameters:

iparameter_name (str) –

Return type:

None

remove_from_termination_attr_list(iparameter_name: str) → None

Note

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

Method to Remove a parameter fron the TerminationAttrList.
Parameters:

iparameter_name (str) –

Return type:

None

set_logical_data_attr_list_lock(i_locked: bool) → None

Note

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

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

Note

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

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

property termination_attr_list: tuple

Note

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

Returns or sets the ConstraintsSimul parameter.

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

tuple