pycatia.cat_tps_interfaces.dmu_tol_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.cat_tps_interfaces.dmu_tol_setting_att.DmuTolSettingAtt(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

DMUTolSettingAtt

Represents the DMU Tolerancing setting controller object.

Role: The DMU Tolerancing setting controller object deals with the setting

parameters displayed in:

The DMU Tolerancing property page for the Related Surface Color and the

Design Mode setting parameters.

To access this property page:

Click the Options command in the Tools menu

Click + left of Digital Mockup to unfold the workbench

list

Click DMU Tolerancing Review

The Cgr Management property page for the Save in CGR setting

parameter.

To access this property page:

Click the Options command in the Tools menu

Click + left of Infrastructure to unfold the workbench

list

Click Product Structure

Click the Cgr Management property page

The Save in CGR setting parameter represents the state of the check button

named: Save FTA 3D Annotation representation in CGR.

property design_mode: bool

Note

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

o Property DesignMode() As boolean

Returns or sets the Design Mode setting parameter value.

True if the Design Mode setting parameter is checked and thus set to

Automatic.

Role: When set to True, models are loaded in Design Mode to access

technological data. Otherwise, when set to False, models are loaded in

Visualization Mode, and only visualization data is loaded.

Return type:

bool

get_design_mode_info(admin_level: str, o_locked: str) → bool

Note

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

o Func GetDesignModeInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves informations about the Design Mode setting parameter

value.

Refer to SettingController for a detailled description.

Parameters:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

get_prev_area_info(admin_level: str, o_locked: str) → bool

Note

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

o Func GetPrevAreaInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves informations about the Preview Area setting parameter

value.

Refer to SettingController for a detailled description.

Parameters:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

get_related_colours(o_related_r: int, o_related_g: int, o_related_b: int) → None

Note

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

o Sub GetRelatedColors(long oRelatedR,

long oRelatedG,

long oRelatedB)

Retrieves the Related Surface Color setting parameter

value.

Role: The Related Surface Color setting parameter defines the color of the

annotation related surfaces, that is, of all the surfaces referenced or

toleranced using the CATIA V4 FD&T function.

Legal values:The three color indexes range from 0 to 255.

Parameters:

oRelatedR

[out] The Related Surface Color red index

oRelatedG

[out] The Related Surface Color green index

oRelatedB

[out] The Related Surface Color blue index

Parameters:

• o_related_r (int) –

• o_related_g (int) –

• o_related_b (int) –

Return type:

None

get_related_colours_info(admin_level: str, o_locked: str) → bool

Note

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

o Func GetRelatedColorsInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves informations about the Related Surface Color setting parameter

value.

Refer to SettingController for a detailled description.

Parameters:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

get_save_cgr_info(admin_level: str, o_locked: str) → bool

Note

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

o Func GetSaveCGRInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves informations about the Save in CGR setting parameter

value.

Refer to SettingController for a detailled description.

Parameters:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

get_sect_pattern_info(admin_level: str, o_locked: str) → bool

Note

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

o Func GetSectPatternInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves informations about the Pattern of Visu setting parameter

value.

Refer to SettingController for a detailled description.

Parameters:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

property prev_area: bool

Note

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

o Property PrevArea() As boolean

Returns or sets the Preview Area setting parameter value.

True if the Preview Area setting parameter is checked.

Return type:

bool

property save_cgr: bool

Note

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

o Property SaveCGR() As boolean

Returns or sets the Save in CGR setting parameter value.

True if the Save in CGR setting parameter is checked.

Role: When set to True, the FTA 3D Annotation representations are saved in

CGR. Otherwise, they are not saved.

Return type:

bool

property sect_pattern: bool

Note

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

o Property SectPattern() As boolean

Returns or sets the Pattern of Visu setting parameter

value.

True if the Pattern of Visu setting parameter is checked.

Role: When set to True, the FTA 3D Annotation representations are saved in

CGR. Otherwise, they are not saved.

Return type:

bool

set_design_mode_lock(i_locked: bool) → None

Note

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

o Sub SetDesignModeLock(boolean iLocked)

Locks or unlocks the Design Mode setting parameter value.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_prev_area_lock(i_locked: bool) → None

Note

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

o Sub SetPrevAreaLock(boolean iLocked)

Locks or unlocks the Preview Area setting parameter value.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_related_colours(i_related_r: int, i_related_g: int, i_related_b: int) → None

Note

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

o Sub SetRelatedColors(long iRelatedR,

long iRelatedG,

long iRelatedB)

Sets the Related Surface Color setting parameter value.

Role: The Related Surface Color setting parameter defines the color of the

annotation related surfaces, that is, of all the surfaces referenced or

toleranced using the CATIA V4 FD&T function.

Legal values:The three color indexes range from 0 to 255.

Parameters:

iRelatedR

[in] The Related Surface Color red index

iRelatedG

[in] The Related Surface Color green index

iRelatedB

[in] The Related Surface Color blue index

Parameters:

• i_related_r (int) –

• i_related_g (int) –

• i_related_b (int) –

Return type:

None

set_related_colours_lock(i_locked: bool) → None

Note

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

o Sub SetRelatedColorsLock(boolean iLocked)

Locks or unlocks the Related Surface Color setting parameter

value.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_save_cgr_lock(i_locked: bool) → None

Note

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

o Sub SetSaveCGRLock(boolean iLocked)

Locks or unlocks the Save in CGR setting parameter value.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_sect_pattern_lock(i_locked: bool) → None

Note

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

o Sub SetSectPatternLock(boolean iLocked)

Locks or unlocks the Pattern of Visu setting parameter

value.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None