pycatia.space_analyses_interfaces.measure_setting_att

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-06-11 12:40:47.360445

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.space_analyses_interfaces.measure_setting_att.MeasureSettingAtt(com_object)

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

System.IUnknown
System.IDispatch
System.CATBaseUnknown
System.CATBaseDispatch
System.AnyObject
System.SettingController
MeasureSettingAtt

The interface to access a CATIAMeasureSettingAtt.
property box_display: bool

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
o Property BoxDisplay() As boolean

Returns or sets the BoxDisplay parameter .

Measure label background is filled if BoxDisplay is True ; there are only
borders if BoxDisplay is False.

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

bool

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

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func GetBoxDisplayInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the BoxDisplay
parameter.
Role:Retrieves the state of the BoxDisplay 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_label_color() → tuple

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub GetLabelColor(long oR,
long oG,
long oB)

Returns the LabelColor parameter.

Parameters:

oR
the red component of the color.
oG
the green component of the color.
oB
the blue component of the color.

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

tuple

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

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func GetLabelColorInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

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

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func GetLineWidthInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

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

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func GetPartUpdateStatusInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

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

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func GetProductUpdateStatusInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the ProductUpdateStatus
parameter.
Role:Retrieves the state of the ProductUpdateStatus 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_text_color() → tuple

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub GetTextColor(long oR,
long oG,
long oB)

Returns the TextColor parameter .

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

tuple

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

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func GetTextColorInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

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

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func GetTildeDisplayInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the TildeDisplay
parameter.
Role:Retrieves the state of the TildeDisplay 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 line_width: int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
o Property LineWidth() As short

Returns or sets the LineWidth parameter.

The line width index, which ranges from 1 to 63.

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

int

property part_update_status: bool

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
o Property PartUpdateStatus() As boolean

Returns or sets the PartUpdateStatus parameter .

Part is automatically updated if PartUpdateStatus is true.

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

bool

property product_update_status: bool

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
o Property ProductUpdateStatus() As boolean

Returns or sets the ProductUpdateStatus parameter .

Product is automatically updated if PartUpdateStatus is
true.

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

bool

set_box_display_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SetBoxDisplayLock(boolean iLocked)

Locks or unlocks the BoxDisplay parameter.
Role:Locks or unlocks the BoxDisplay 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_label_color(i_r: int, i_g: int, i_b: int) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SetLabelColor(long iR,
long iG,
long iB)

Sets the LabelColor parameter.

Parameters:

oR
the red component of the color.
oG
the green component of the color.
oB
the blue component of the color.

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

  • i_r (int) –

  • i_g (int) –

  • i_b (int) –

Return type:

None

set_label_color_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SetLabelColorLock(boolean iLocked)

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

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SetLineWidthLock(boolean iLocked)

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

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SetPartUpdateStatusLock(boolean iLocked)

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

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SetProductUpdateStatusLock(boolean iLocked)

Locks or unlocks the ProductUpdateStatus parameter.
Role:Locks or unlocks the Xxx 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_text_color(i_r: int, i_g: int, i_b: int) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SetTextColor(long iR,
long iG,
long iB)

Sets the TextColor parameter .

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

  • i_r (int) –

  • i_g (int) –

  • i_b (int) –

Return type:

None

set_text_color_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SetTextColorLock(boolean iLocked)

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

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SetTildeDisplayLock(boolean iLocked)

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

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
o Property TildeDisplay() As boolean

Returns or sets the TildeDisplay parameter.

If TildeDisplay is TRUE, a tilde displayed for approximate
measurement.

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

bool