pycatia.cat_tps_interfaces.fta_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.fta_setting_att.FTASettingAtt(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

FTASettingAtt

The interface to access a CATIAFTASettingAtt.

property alphabetic_order: bool

Note

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

o Property AlphabeticOrder() As boolean

Returns or sets the AlphabeticOrder setting parameter

value.

True if the AlphabeticOrder 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 analysis_display_mode: bool

Note

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

o Property AnalysisDisplayMode() As boolean

Returns the AnalysisDisplayMode parameter.

Return type:

bool

property angulaire_general_tol_class: int

Note

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

o Property AngulaireGeneralTolClass() As long

Returns or sets the Dimension general class parameter.

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

Return type:

int

property annot_dim_invalid: bool

Note

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

o Property AnnotDimInvalid() As boolean

Returns the AnnotDimInvalid parameter.

Return type:

bool

property annot_dim_on_deleted_geom: bool

Note

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

o Property AnnotDimOnDeletedGeom() As boolean

Returns the AnnotDimOnDeletedGeom parameter.

Return type:

bool

property annot_dim_on_unloaded_geom: bool

Note

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

o Property AnnotDimOnUnloadedGeom() As boolean

Returns the AnnotDimOnUnloadedGeom parameter.

Return type:

bool

property annot_on_zero_z_setting: bool

Note

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

o Property AnnotOnZeroZSetting() As boolean

Returns the AnnotOnZeroZSetting parameter.

Return type:

bool

property body_hide_in_capture: int

Note

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

o Property BodyHideInCapture() As long

Returns or sets the Visibility of Part instances, bodies and geometrical

sets in Capture.

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

Return type:

int

property cat_fta_chamfer_general_tol_class: int

Note

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

o Property CATFTAChamferGeneralTolClass() As long

Returns the CATFTAChamferGeneralTolClass parameter.

Return type:

int

property cat_fta_edges_line_type: int

Note

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

o Property CATFTAEdgesLineType() As long

Returns the CATFTAEdgesLineType parameter.

Return type:

int

property cat_fta_edges_thickness: int

Note

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

o Property CATFTAEdgesThickness() As long

Returns the CATFTAEdgesThickness parameter.

Return type:

int

property cat_fta_use_last_tolerances: bool

Note

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

o Property CATFTAUseLastTolerances() As boolean

Returns the CATFTAUseLastTolerances parameter.

Return type:

bool

property cat_ftauf_auto_tolerancing: str

Note

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

o Property CATFTAUFAutoTolerancing() As CATBSTR

Returns the CATFTAUFAutoTolerancing parameter.

Return type:

str

property dim_after_cre: bool

Note

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

o Property DimAfterCre() As boolean

Returns or sets the Dimension After Creaation parameter.

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

Return type:

bool

property dim_after_mod: bool

Note

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

o Property DimAfterMod() As boolean

Returns or sets the Dimension After Modification

parameter.

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

Return type:

bool

property dim_before_cre: bool

Note

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

o Property DimBeforeCre() As boolean

Returns or sets the Dimension Before Creation parameter.

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

Return type:

bool

property dim_before_mod: bool

Note

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

o Property DimBeforeMod() As boolean

Returns or sets the Dimension Before Modification

parameter.

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

Return type:

bool

property dim_blanking_cre: bool

Note

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

o Property DimBlankingCre() As boolean

Returns or sets the Dimension Blanking Creation parameter.

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

Return type:

bool

property dim_blanking_mod: bool

Note

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

o Property DimBlankingMod() As boolean

Returns or sets the Dimension Blanking Modification

parameter.

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

Return type:

bool

property dim_configure_snapping: int

Note

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

o Property DimConfigureSnapping() As

CATFTADimConfigureSnapping

Returns or sets the DimConfigureSnapping parameter.

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

Returns:

enum catfta_dim_configure_snapping

Return type:

int

property dim_constant_offset: bool

Note

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

o Property DimConstantOffset() As boolean

Returns or sets the Constant Offset parameter.

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

Return type:

bool

property dim_create_on: int

Note

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

o Property DimCreateOn() As CATFTADimCreateOn

Returns or sets the DimCreateOn parameter.

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

Returns:

enum catfta_dim_create_on

Return type:

int

property dim_line_pos_value: float

Note

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

o Property DimLinePosValue() As double

Returns or sets the Dimension Line Position Value

parameter.

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

Return type:

float

property dim_line_up_base_angle: float

Note

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

o Property DimLineUpBaseAngle() As double

Returns or sets the Dimension Line Up Base Angle

parameter.

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

Return type:

float

property dim_line_up_base_length: float

Note

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

o Property DimLineUpBaseLength() As double

Returns or sets the Dimension Line Up Base Length

parameter.

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

Return type:

float

property dim_line_up_cumul: bool

Note

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

o Property DimLineUpCumul() As boolean

Returns or sets the Dimension Line Up Cululated parameter.

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

Return type:

bool

property dim_line_up_funnel: bool

Note

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

o Property DimLineUpFunnel() As boolean

Returns or sets the Dimension Line Up Funnel parameter.

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

Return type:

bool

property dim_line_up_offset_bet_dim_angle: float

Note

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

o Property DimLineUpOffsetBetDimAngle() As double

Returns gets the DimLineUpOffsetBetDimAngle parameter.

Parameters:

oValue

Output value of the DimLineUpOffsetBetDimAngle. If return code

E_FAIL oValue is not obtained. If return code S_OK oValue is obtained.

Return type:

float

property dim_line_up_offset_bet_dim_length: float

Note

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

o Property DimLineUpOffsetBetDimLength() As double

Returns gets the DimLineUpOffsetBetDimLength parameter.

Parameters:

oValue

Output value of the DimLineUpOffsetBetDimLength. If return code

E_FAIL oValue is not obtained. If return code S_OK oValue is obtained.

Return type:

float

property dim_line_up_offset_to_ref_angle: float

Note

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

o Property DimLineUpOffsetToRefAngle() As double

Returns gets the DimLineUpOffsetToRefAngle parameter.

Parameters:

oValue

Output value of the DimLineUpOffsetToRefAngle. If return code

E_FAIL oValue is not obtained. If return code S_OK oValue is obtained.

Return type:

float

property dim_line_up_offset_to_ref_length: float

Note

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

o Property DimLineUpOffsetToRefLength() As double

Returns gets the DimLineUpOffsetToRefLength parameter.

Parameters:

oValue

Output value of the DimLineUpOffsetToRefLength. If return code

E_FAIL oValue is not obtained. If return code S_OK oValue is obtained.

Return type:

float

property dim_line_up_stack: bool

Note

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

o Property DimLineUpStack() As boolean

Returns or sets the Dimension Line Up Stack parameter.

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

Return type:

bool

property dim_manual_positionning: bool

Note

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

o Property DimManualPositionning() As boolean

Returns or sets the Manual Positionning parameter.

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

Return type:

bool

property dim_move_2d_part_cre: bool

Note

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

o Property DimMove2dPartCre() As boolean

Returns or sets the Dimension Move 2D Creation parameter.

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

Return type:

bool

property dim_move_2d_part_mod: bool

Note

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

o Property DimMove2dPartMod() As boolean

Returns or sets the Dimension Move 2D Modification

parameter.

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

Return type:

bool

property dim_move_dim_line_cre: bool

Note

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

o Property DimMoveDimLineCre() As boolean

Returns or sets the Dimension Move Dimension Line Creation

parameter.

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

Return type:

bool

property dim_move_dim_line_mod: bool

Note

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

o Property DimMoveDimLineMod() As boolean

Returns or sets the Dimension Move Dimension Line Modification

parameter.

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

Return type:

bool

property dim_move_leader_cre: bool

Note

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

o Property DimMoveLeaderCre() As boolean

Get the Dimension leader Creation parameter.

Parameters:

oValue

Output value of the Dimension Leader creation check box status. If

return code E_FAIL oValue is not obtained. If return code S_OK oValue is

obtained.

Return type:

bool

property dim_move_leader_mod: bool

Note

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

o Property DimMoveLeaderMod() As boolean

Returns gets the Dimension leader modification parameter.

Parameters:

oValue

Output value of the Dimension Leader modification check box status.

If return code E_FAIL oValue is not obtained. If return code S_OK oValue is

obtained.

Return type:

bool

property dim_move_sub_part: bool

Note

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

o Property DimMoveSubPart() As boolean

Returns or sets the DimMoveSubPart parameter.

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

Return type:

bool

property dim_move_value_cre: bool

Note

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

o Property DimMoveValueCre() As boolean

Returns or sets the Dimension Move Value Creation

parameter.

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

Return type:

bool

property dim_move_value_mod: bool

Note

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

o Property DimMoveValueMod() As boolean

Returns or sets the Dimension Move Value Modification

parameter.

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

Return type:

bool

property dim_o_run_cre: bool

Note

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

o Property DimORunCre() As boolean

Returns or sets the Dimension Over Run Creation parameter.

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

Return type:

bool

property dim_o_run_mod: bool

Note

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

o Property DimORunMod() As boolean

Returns or sets the Dimension Over Run Modification

parameter.

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

Return type:

bool

property dim_ori_default_symb: bool

Note

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

o Property DimOriDefaultSymb() As boolean

Returns or sets the Dimension Orientation Default Symbol

parameter.

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

Return type:

bool

property dim_snapping: bool

Note

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

o Property DimSnapping() As boolean

Returns or sets the Dimension Snapping parameter.

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

Return type:

bool

property general_tol_class: int

Note

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

o Property GeneralTolClass() As long

Returns or sets the Dimension general class parameter.

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

Return type:

int

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

Note

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

o Func GetAlphabeticOrderInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves informations about the AlphabeticOrder setting parameter

value.

Refer to SettingController for a detailled description.

Parameters:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

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

Note

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

o Func GetAnalysisDisplayModeInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves environment informations for the AnalysisDisplayMode

parameter.

Role:Retrieves the state of the AnalysisDisplayMode 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:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

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

Note

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

o Func GetAngulaireGeneralTolClassInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves informations about the Dimension general class tolerance setting

parameter value.

Refer to SettingController for a detailled description.

Parameters:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

get_annot_dim_invalid_colour(o_value_r: int, o_value_g: int, o_value_b: int) → None

Note

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

o Sub GetAnnotDimInvalidColor(long oValueR,

long oValueG,

long oValueB)

Returns the AnnotDimInvalidColor parameter.

Parameters:

• o_value_r (int) –

• o_value_g (int) –

• o_value_b (int) –

Return type:

None

get_annot_dim_invalid_colour_info(io_admin_level: str, io_locked: str, o_modified: bool) → None

Note

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

o Sub GetAnnotDimInvalidColorInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked,

boolean oModified)

Retrieves environment informations for the AnnotDimInvalidColor

parameter.

Role:Retrieves the state of the AnnotDimInvalidColor 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) –

• o_modified (bool) –

Return type:

None

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

Note

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

o Func GetAnnotDimInvalidInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Locks or unlocks the AnnotDimInvalid parameter.

Role:Locks or unlocks the AnnotDimInvalid 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:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

get_annot_dim_on_deleted_geom_colour(o_value_r: int, o_value_g: int, o_value_b: int) → None

Note

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

o Sub GetAnnotDimOnDeletedGeomColor(long oValueR,

long oValueG,

long oValueB)

Returns the AnnotDimOnDeletedGeomColor parameter.

Parameters:

• o_value_r (int) –

• o_value_g (int) –

• o_value_b (int) –

Return type:

None

get_annot_dim_on_deleted_geom_colour_info(io_admin_level: str, io_locked: str, o_modified: bool) → None

Note

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

o Sub GetAnnotDimOnDeletedGeomColorInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked,

boolean oModified)

Retrieves environment informations for the AnnotDimOnDeletedGeomColor

parameter.

Role:Retrieves the state of the AnnotDimOnDeletedGeomColor 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) –

• o_modified (bool) –

Return type:

None

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

Note

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

o Func GetAnnotDimOnDeletedGeomInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves environment informations for the AnnotDimOnDeletedGeom

parameter.

Role:Retrieves the state of the AnnotDimOnDeletedGeom 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:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

get_annot_dim_on_unloaded_geom_colour(o_value_r: int, o_value_g: int, o_value_b: int) → None

Note

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

o Sub GetAnnotDimOnUnloadedGeomColor(long oValueR,

long oValueG,

long oValueB)

Returns the AnnotDimOnUnloadedGeomColor parameter.

Parameters:

• o_value_r (int) –

• o_value_g (int) –

• o_value_b (int) –

Return type:

None

get_annot_dim_on_unloaded_geom_colour_info(io_admin_level: str, io_locked: str, o_modified: bool) → None

Note

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

o Sub GetAnnotDimOnUnloadedGeomColorInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked,

boolean oModified)

Retrieves environment informations for the AnnotDimOnUnloadedGeomColor

parameter.

Role:Retrieves the state of the AnnotDimOnUnloadedGeomColor 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) –

• o_modified (bool) –

Return type:

None

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

Note

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

o Func GetAnnotDimOnUnloadedGeomInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves environment informations for the AnnotDimOnUnloadedGeom

parameter.

Role:Retrieves the state of the AnnotDimOnUnloadedGeom 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:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

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

Note

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

o Func GetAnnotOnZeroZSettingInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves environment informations for the AnnotOnZeroZSetting

parameter.

Role:Retrieves the state of the AnnotOnZeroZSetting 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:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

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

Note

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

o Func GetBodyHideInCaptureInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves informations about the Visibility of Part instances, bodies and

geometrical sets in Capture.

Refer to SettingController for a detailled description.

Parameters:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

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

Note

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

o Func GetCATFTAChamferGeneralTolClassInfo(CATBSTR

AdminLevel,

CATBSTR oLocked) As boolean

Retrieves environment informations for the CATFTAChamferGeneralTolClass

parameter.

Role:Retrieves the state of the CATFTAChamferGeneralTolClass 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:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

get_cat_fta_edges_colour(o_value_r: int, o_value_g: int, o_value_b: int) → None

Note

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

o Sub GetCATFTAEdgesColor(long oValueR,

long oValueG,

long oValueB)

Returns the GetCATFTAEdgesColor parameter.

Parameters:

• o_value_r (int) –

• o_value_g (int) –

• o_value_b (int) –

Return type:

None

get_cat_fta_edges_colour_info(io_admin_level: str, io_locked: str, o_modified: bool) → None

Note

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

o Sub GetCATFTAEdgesColorInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked,

boolean oModified)

Retrieves environment informations for the GetCATFTAEdgesColor

parameter.

Role:Retrieves the state of the GetCATFTAEdgesColor 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) –

• o_modified (bool) –

Return type:

None

get_cat_fta_edges_line_type_info(io_admin_level: str, io_locked: str, o_modified: bool) → None

Note

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

o Sub GetCATFTAEdgesLineTypeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked,

boolean oModified)

Retrieves environment informations for the CATFTAEdgesLineType

parameter.

Role:Retrieves the state of the CATFTAEdgesLineType 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) –

• o_modified (bool) –

Return type:

None

get_cat_fta_edges_thickness_info(io_admin_level: str, io_locked: str, o_modified: bool) → None

Note

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

o Sub GetCATFTAEdgesThicknessInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked,

boolean oModified)

Retrieves environment informations for the CATFTAEdgesThickness

parameter.

Role:Retrieves the state of the CATFTAEdgesThickness 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) –

• o_modified (bool) –

Return type:

None

get_cat_fta_uf_auto_tolerancing_info(io_admin_level: str, io_locked: str, o_modified: bool) → None

Note

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

o Sub GetCATFTAUFAutoTolerancingInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked,

boolean oModified)

Retrieves environment informations for the CATFTAUFAutoTolerancing

parameter.

Role:Retrieves the state of the CATFTAUFAutoTolerancing 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) –

• o_modified (bool) –

Return type:

None

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

Note

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

o Func GetCATFTAUseLastTolerancesInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves environment informations for the CATFTAUseLastTolerances

parameter.

Role:Retrieves the state of the CATFTAUseLastTolerances 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:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

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

Note

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

o Func GetDimAfterCreInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves informations about the Dimension After Creation setting parameter

value.

Refer to SettingController for a detailled description.

Parameters:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

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

Note

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

o Func GetDimAfterModInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves informations about the Dimension After Modification setting

parameter value.

Refer to SettingController for a detailled description.

Parameters:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

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

Note

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

o Func GetDimBeforeCreInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves informations about the Dimension Before Creation setting

parameter value.

Refer to SettingController for a detailled description.

Parameters:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

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

Note

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

o Func GetDimBeforeModInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves informations about the Dimension Before Modification setting

parameter value.

Refer to SettingController for a detailled description.

Parameters:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

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

Note

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

o Func GetDimBlankingCreInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves informations about the Dimension Blanking Creation setting

parameter value.

Refer to SettingController for a detailled description.

Parameters:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

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

Note

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

o Func GetDimBlankingModInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves informations about the Dimension Blanking Modification setting

parameter value.

Refer to SettingController for a detailled description.

Parameters:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

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

Note

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

o Func GetDimConfigureSnappingInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves informations about the DimMoveSubPart setting parameter

value.

Refer to SettingController for a detailled description.

Parameters:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

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

Note

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

o Func GetDimConstantOffsetInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves informations about the Dimension Constant Offset setting

parameter value.

Refer to SettingController for a detailled description.

Parameters:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

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

Note

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

o Func GetDimCreateOnInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves informations about the DimCreateOn setting parameter

value.

Refer to SettingController for a detailled description.

Parameters:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

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

Note

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

o Func GetDimLinePosValueInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves informations about the Dimension Line Position Value setting

parameter value.

Refer to SettingController for a detailled description.

Parameters:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

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

Note

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

o Func GetDimLineUpBaseAngleInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves informations about the Dimension Line Up Base Angle setting

parameter value.

Refer to SettingController for a detailled description.

Parameters:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

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

Note

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

o Func GetDimLineUpBaseLengthInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves informations about the Dimension Line Up Base Length setting

parameter value.

Refer to SettingController for a detailled description.

Parameters:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

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

Note

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

o Func GetDimLineUpCumulInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves informations about the Dimension Line Up Cululated setting

parameter value.

Refer to SettingController for a detailled description.

Parameters:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

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

Note

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

o Func GetDimLineUpFunnelInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves informations about the Dimension Line Up Funnel setting parameter

value.

Refer to SettingController for a detailled description.

Parameters:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

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

Note

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

o Func GetDimLineUpOffsetBetDimAngleInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves informations about the DimLineUpOffsetBetDimAngle setting

parameter value.

Parameters:

AdminLevel

Input/Output parameter, is the administration level.

oLocked

Input/Output parameter, is the lock status of the check button.

oModified

Output paramter which gives the status as boolean if the status is

modified. If return code E_FAIL the values are not obtained. If return code

S_OK the values are obtained.

Refer to

SettingController for a detailled description.

Parameters:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

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

Note

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

o Func GetDimLineUpOffsetBetDimLengthInfo(CATBSTR

AdminLevel,

CATBSTR oLocked) As boolean

Retrieves informations about the DimLineUpOffsetBetDimLength setting

parameter value.

Parameters:

AdminLevel

Input/Output parameter, is the administration level.

oLocked

Input/Output parameter, is the lock status of the check button.

oModified

Output paramter which gives the status as boolean if the status is

modified. If return code E_FAIL the values are not obtained. If return code

S_OK the values are obtained.

Refer to

SettingController for a detailled description.

Parameters:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

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

Note

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

o Func GetDimLineUpOffsetToRefAngleInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves informations about the DimLineUpOffsetToRefAngle setting

parameter value.

Parameters:

AdminLevel

Input/Output parameter, is the administration level.

oLocked

Input/Output parameter, is the lock status of the check button.

oModified

Output paramter which gives the status as boolean if the status is

modified. If return code E_FAIL the values are not obtained. If return code

S_OK the values are obtained.

Refer to

SettingController for a detailled description.

Parameters:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

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

Note

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

o Func GetDimLineUpOffsetToRefLengthInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves informations about the DimLineUpOffsetToRefLength setting

parameter value.

Parameters:

AdminLevel

Input/Output parameter, is the administration level.

oLocked

Input/Output parameter, is the lock status of the check button.

oModified

Output paramter which gives the status as boolean if the status is

modified. If return code E_FAIL the values are not obtained. If return code

S_OK the values are obtained.

Refer to

SettingController for a detailled description.

Parameters:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

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

Note

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

o Func GetDimLineUpStackInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves informations about the Dimension Line Up Stack setting parameter

value.

Refer to SettingController for a detailled description.

Parameters:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

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

Note

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

o Func GetDimManualPositionningInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves informations about the Dimension Manual Positionning setting

parameter value.

Refer to SettingController for a detailled description.

Parameters:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

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

Note

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

o Func GetDimMove2dPartCreInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves informations about the Dimension Move 2D Creation setting

parameter value.

Refer to SettingController for a detailled description.

Parameters:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

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

Note

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

o Func GetDimMove2dPartModInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves informations about the Dimension Move 2D Modification setting

parameter value.

Refer to SettingController for a detailled description.

Parameters:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

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

Note

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

o Func GetDimMoveDimLineCreInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves informations about the Dimension Move Dimension Line Creation

setting parameter value.

Refer to SettingController for a detailled description.

Parameters:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

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

Note

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

o Func GetDimMoveDimLineModInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves informations about the Dimension Move Dimension Line Modification

setting parameter value.

Refer to SettingController for a detailled description.

Parameters:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

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

Note

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

o Func GetDimMoveLeaderCreInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves informations about the Dimension leader Creation setting

parameter value.

Parameters:

AdminLevel

Input/Output parameter, is the administration level.

oLocked

Input/Output parameter, is the lock status of the check button.

oModified

Output paramter which gives the status as boolean if the status is

modified. If return code E_FAIL the values are not obtained. If return code

S_OK the values are obtained.

Refer to

SettingController for a detailled description.

Parameters:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

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

Note

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

o Func GetDimMoveLeaderModInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves informations about the Dimension leader modification setting

parameter value.

Parameters:

AdminLevel

Input/Output parameter, is the administration level.

oLocked

Input/Output parameter, is the lock status of the check button.

oModified

Output paramter which gives the status as boolean if the status is

modified. If return code E_FAIL the values are not obtained. If return code

S_OK the values are obtained.

Refer to

SettingController for a detailled description.

Parameters:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

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

Note

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

o Func GetDimMoveSubPartInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves informations about the DimMoveSubPart setting parameter

value.

Refer to SettingController for a detailled description.

Parameters:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

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

Note

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

o Func GetDimMoveValueCreInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves informations about the Dimension Move Value Creation setting

parameter value.

Refer to SettingController for a detailled description.

Parameters:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

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

Note

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

o Func GetDimMoveValueModInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves informations about the Dimension Move Value Modification setting

parameter value.

Refer to SettingController for a detailled description.

Parameters:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

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

Note

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

o Func GetDimORunCreInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves informations about the Dimension Over Run Creation setting

parameter value.

Refer to SettingController for a detailled description.

Parameters:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

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

Note

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

o Func GetDimORunModInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves informations about the Dimension Over Run Modification setting

parameter value.

Refer to SettingController for a detailled description.

Parameters:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

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

Note

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

o Func GetDimOriDefaultSymbInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves informations about the Dimension Orientation Default Symbol

setting parameter value.

Refer to SettingController for a detailled description.

Parameters:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

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

Note

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

o Func GetDimSnappingInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves informations about the Dimension Snapping setting parameter

value.

Refer to SettingController for a detailled description.

Parameters:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

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

Note

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

o Func GetGeneralTolClassInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves informations about the Dimension general class tolerance setting

parameter value.

Refer to SettingController for a detailled description.

Parameters:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

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

Note

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

o Func GetHighlightDefAnnotInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves informations about the Highlight Def Annot setting parameter

value.

Refer to SettingController for a detailled description.

Parameters:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

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

Note

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

o Func GetNoaCreationInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves informations about the Noa Creation setting parameter

value.

Refer to SettingController for a detailled description.

Parameters:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

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

Note

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

o Func GetNonSemanticAllwaysUpgradeGeneralTolInfo(CATBSTR

AdminLevel,

CATBSTR oLocked) As boolean

Retrieves informations about the Non Semantic Allways Upgrade general

tolerance setting parameter value.

Refer to SettingController for a detailled description.

Parameters:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

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

Note

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

o Func GetNonSemanticAllwaysUpgradeInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves informations about the Non Semantic Allways Upgrade setting

parameter value.

Refer to SettingController for a detailled description.

Parameters:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

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

Note

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

o Func GetNonSemanticDimAllowedInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves informations about the Non Semantic Dim Allowed setting parameter

value.

Refer to SettingController for a detailled description.

Parameters:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

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

Note

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

o Func GetNonSemanticMarkedInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves informations about the Non Semantic Marked setting parameter

value.

Refer to SettingController for a detailled description.

Parameters:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

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

Note

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

o Func GetNonSemanticTolAllowedInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves informations about the Non Semantic Tol Allowed setting parameter

value.

Refer to SettingController for a detailled description.

Parameters:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

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

Note

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

o Func GetParametersInTreeInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves informations about the Parameters in tree setting parameter

value.

Refer to SettingController for a detailled description.

Parameters:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

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

Note

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

o Func GetRotationSnapAngleInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves informations about the Rotation Snap Angle setting parameter

value.

Refer to SettingController for a detailled description.

Parameters:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

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

Note

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

o Func GetRotationSnapAutoInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves informations about the Rotation Snap Auto 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

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

Note

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

o Func GetSelectPublishedGeometryInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves informations about the Select Published Geometry setting

parameter value.

Refer to SettingController for a detailled description.

Parameters:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

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

Note

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

o Func GetShiftedProfileInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves informations about the Shifted Profile setting parameter

value.

Refer to SettingController for a detailled description.

Parameters:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

get_true_dimension_colour(o_value_r: int, o_value_g: int, o_value_b: int) → None

Note

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

o Sub GetTrueDimensionColor(long oValueR,

long oValueG,

long oValueB)

Returns the TrueDimensionColor parameter.

Parameters:

• o_value_r (int) –

• o_value_g (int) –

• o_value_b (int) –

Return type:

None

get_true_dimension_colour_info(io_admin_level: str, io_locked: str, o_modified: bool) → None

Note

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

o Sub GetTrueDimensionColorInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked,

boolean oModified)

Retrieves environment informations for the TrueDimensionColor

parameter.

Role:Retrieves the state of the TrueDimensionColor 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) –

• o_modified (bool) –

Return type:

None

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

Note

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

o Func GetTrueDimensionInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves environment informations for the TrueDimension

parameter.

Role:Retrieves the state of the TrueDimension 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:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

property highlight_def_annot: bool

Note

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

o Property HighlightDefAnnot() As boolean

Returns or sets the Highlight Def Annot parameter.

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

Return type:

bool

property noa_creation: bool

Note

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

o Property NoaCreation() As boolean

Returns or sets the Noa Creation parameter.

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

Return type:

bool

property non_semantic_always_upgrade: bool

Note

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

o Property NonSemanticAllwaysUpgrade() As boolean

Returns or sets the Non SemanticAllways Upgrade parameter.

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

Return type:

bool

property non_semantic_always_upgrade_general_tol: bool

Note

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

o Property NonSemanticAllwaysUpgradeGeneralTol() As boolean

Returns or sets the Non SemanticAllways Upgrade general tolerance

parameter.

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

Return type:

bool

property non_semantic_dim_allowed: bool

Note

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

o Property NonSemanticDimAllowed() As boolean

Returns or sets the Non Semantic Dim Allowed parameter.

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

Return type:

bool

property non_semantic_marked: bool

Note

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

o Property NonSemanticMarked() As boolean

Returns or sets the Non Semantic Marked parameter.

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

Return type:

bool

property non_semantic_tol_allowed: bool

Note

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

o Property NonSemanticTolAllowed() As boolean

Returns or sets the Non Semantic Tol Allowed parameter.

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

Return type:

bool

property parameters_in_tree: bool

Note

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

o Property ParametersInTree() As boolean

Returns or sets the Parameters in tree parameter.

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

Return type:

bool

property rotation_snap_angle: float

Note

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

o Property RotationSnapAngle() As double

Returns or sets the Rotation Snap Angle parameter.

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

Return type:

float

property rotation_snap_auto: bool

Note

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

o Property RotationSnapAuto() As boolean

Returns or sets the Rotation Snap Auto parameter.

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

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

property select_published_geometry: bool

Note

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

o Property SelectPublishedGeometry() As boolean

Returns or sets the Slect Published Geometry parameter.

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

Return type:

bool

set_alphabetic_order_lock(i_locked: bool) → None

Note

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

o Sub SetAlphabeticOrderLock(boolean iLocked)

Locks or unlocks the AlphabeticOrder setting parameter

value.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_analysis_display_mode_lock(i_locked: bool) → None

Note

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

o Sub SetAnalysisDisplayModeLock(boolean iLocked)

Locks or unlocks the AnalysisDisplayMode parameter.

Role:Locks or unlocks the AnalysisDisplayMode 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_angulaire_general_tol_class_lock(i_locked: bool) → None

Note

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

o Sub SetAngulaireGeneralTolClassLock(boolean iLocked)

Locks or unlocks the Dimension general class parameter.

Parameters:

i_locked (bool) –

Return type:

None

set_annot_dim_invalid_colour(i_value_r: int, i_value_g: int, i_value_b: int) → None

Note

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

o Sub SetAnnotDimInvalidColor(long iValueR,

long iValueG,

long iValueB)

Sets the AnnotDimInvalidColor parameter.

Parameters:

• i_value_r (int) –

• i_value_g (int) –

• i_value_b (int) –

Return type:

None

set_annot_dim_invalid_colour_lock(i_locked: bool) → None

Note

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

o Sub SetAnnotDimInvalidColorLock(boolean iLocked)

Locks or unlocks the AnnotDimInvalidColor parameter.

Role:Locks or unlocks the AnnotDimInvalidColor 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_annot_dim_invalid_lock(i_locked: bool) → None

Note

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

o Sub SetAnnotDimInvalidLock(boolean iLocked)

Retrieves environment informations for the AnnotDimInvalid

parameter.

Role:Retrieves the state of the AnnotDimInvalid 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:

i_locked (bool) –

Return type:

None

set_annot_dim_on_deleted_geom_colour(i_value_r: int, i_value_g: int, i_value_b: int) → None

Note

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

o Sub SetAnnotDimOnDeletedGeomColor(long iValueR,

long iValueG,

long iValueB)

Sets the AnnotDimOnDeletedGeomColor parameter.

Parameters:

• i_value_r (int) –

• i_value_g (int) –

• i_value_b (int) –

Return type:

None

set_annot_dim_on_deleted_geom_colour_lock(i_locked: bool) → None

Note

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

o Sub SetAnnotDimOnDeletedGeomColorLock(boolean iLocked)

Locks or unlocks the AnnotDimOnDeletedGeomColor parameter.

Role:Locks or unlocks the AnnotDimOnDeletedGeomColor 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_annot_dim_on_deleted_geom_lock(i_locked: bool) → None

Note

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

o Sub SetAnnotDimOnDeletedGeomLock(boolean iLocked)

Locks or unlocks the AnnotDimOnDeletedGeom parameter.

Role:Locks or unlocks the AnnotDimOnDeletedGeom 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_annot_dim_on_unloaded_geom_colour(i_value_r: int, i_value_g: int, i_value_b: int) → None

Note

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

o Sub SetAnnotDimOnUnloadedGeomColor(long iValueR,

long iValueG,

long iValueB)

Sets the AnnotDimOnUnloadedGeomColor parameter.

Parameters:

• i_value_r (int) –

• i_value_g (int) –

• i_value_b (int) –

Return type:

None

set_annot_dim_on_unloaded_geom_colour_lock(i_locked: bool) → None

Note

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

o Sub SetAnnotDimOnUnloadedGeomColorLock(boolean iLocked)

Locks or unlocks the AnnotDimOnUnloadedGeomColor

parameter.

Role:Locks or unlocks the AnnotDimOnUnloadedGeomColor 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_annot_dim_on_unloaded_geom_lock(i_locked: bool) → None

Note

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

o Sub SetAnnotDimOnUnloadedGeomLock(boolean iLocked)

Locks or unlocks the AnnotDimOnUnloadedGeom parameter.

Role:Locks or unlocks the AnnotDimOnUnloadedGeom 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_annot_on_zero_z_setting_lock(i_locked: bool) → None

Note

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

o Sub SetAnnotOnZeroZSettingLock(boolean iLocked)

Locks or unlocks the AnnotOnZeroZSetting parameter.

Role:Locks or unlocks the AnnotOnZeroZSetting 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_body_hide_in_capture_lock(i_locked: bool) → None

Note

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

o Sub SetBodyHideInCaptureLock(boolean iLocked)

Locks or unlocks the Dimension general class parameter.

Parameters:

i_locked (bool) –

Return type:

None

set_cat_fta_chamfer_general_tol_class_lock(i_locked: bool) → None

Note

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

o Sub SetCATFTAChamferGeneralTolClassLock(boolean iLocked)

Locks or unlocks the CATFTAChamferGeneralTolClass

parameter.

Role:Locks or unlocks the CATFTAChamferGeneralTolClass 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_cat_fta_edges_colour(i_value_r: int, i_value_g: int, i_value_b: int) → None

Note

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

o Sub SetCATFTAEdgesColor(long iValueR,

long iValueG,

long iValueB)

Sets the GetCATFTAEdgesColor parameter.

Parameters:

• i_value_r (int) –

• i_value_g (int) –

• i_value_b (int) –

Return type:

None

set_cat_fta_edges_colour_lock(i_locked: bool) → None

Note

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

o Sub SetCATFTAEdgesColorLock(boolean iLocked)

Locks or unlocks the GetCATFTAEdgesColor parameter.

Role:Locks or unlocks the GetCATFTAEdgesColor 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_cat_fta_edges_line_type_lock(i_locked: bool) → None

Note

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

o Sub SetCATFTAEdgesLineTypeLock(boolean iLocked)

Locks or unlocks the CATFTAEdgesLineType parameter.

Role:Locks or unlocks the CATFTAEdgesLineType 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_cat_fta_edges_thickness_lock(i_locked: bool) → None

Note

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

o Sub SetCATFTAEdgesThicknessLock(boolean iLocked)

Locks or unlocks the CATFTAEdgesThickness parameter.

Role:Locks or unlocks the CATFTAEdgesThickness 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_cat_fta_use_last_tolerances_lock(i_locked: bool) → None

Note

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

o Sub SetCATFTAUseLastTolerancesLock(boolean iLocked)

Locks or unlocks the CATFTAUseLastTolerances parameter.

Role:Locks or unlocks the CATFTAUseLastTolerances 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_cat_ftauf_auto_tolerancing_lock(i_locked: bool) → None

Note

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

o Sub SetCATFTAUFAutoTolerancingLock(boolean iLocked)

Locks or unlocks the CATFTAUFAutoTolerancing parameter.

Role:Locks or unlocks the CATFTAUFAutoTolerancing 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_dim_after_cre_lock(i_locked: bool) → None

Note

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

o Sub SetDimAfterCreLock(boolean iLocked)

Locks or unlocks the Dimension After Creaation parameter.

Parameters:

i_locked (bool) –

Return type:

None

set_dim_after_mod_lock(i_locked: bool) → None

Note

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

o Sub SetDimAfterModLock(boolean iLocked)

Locks or unlocks the Dimension After Modification parameter.

Parameters:

i_locked (bool) –

Return type:

None

set_dim_before_cre_lock(i_locked: bool) → None

Note

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

o Sub SetDimBeforeCreLock(boolean iLocked)

Locks or unlocks the Dimension Before Creation parameter.

Parameters:

i_locked (bool) –

Return type:

None

set_dim_before_mod_lock(i_locked: bool) → None

Note

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

o Sub SetDimBeforeModLock(boolean iLocked)

Locks or unlocks the Dimension Before Modification parameter.

Parameters:

i_locked (bool) –

Return type:

None

set_dim_blanking_cre_lock(i_locked: bool) → None

Note

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

o Sub SetDimBlankingCreLock(boolean iLocked)

Locks or unlocks the Dimension Blanking Creation parameter.

Parameters:

i_locked (bool) –

Return type:

None

set_dim_blanking_mod_lock(i_locked: bool) → None

Note

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

o Sub SetDimBlankingModLock(boolean iLocked)

Locks or unlocks the Dimension Blanking Modification parameter.

Parameters:

i_locked (bool) –

Return type:

None

set_dim_configure_snapping_lock(i_locked: bool) → None

Note

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

o Sub SetDimConfigureSnappingLock(boolean iLocked)

Locks or unlocks the DimConfigureSnapping parameter.

Parameters:

i_locked (bool) –

Return type:

None

set_dim_constant_offset_lock(i_locked: bool) → None

Note

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

o Sub SetDimConstantOffsetLock(boolean iLocked)

Locks or unlocks the Constant Offset parameter.

Parameters:

i_locked (bool) –

Return type:

None

set_dim_create_on_lock(i_locked: bool) → None

Note

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

o Sub SetDimCreateOnLock(boolean iLocked)

Locks or unlocks the DimCreateOn parameter.

Parameters:

i_locked (bool) –

Return type:

None

set_dim_line_pos_value_lock(i_locked: bool) → None

Note

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

o Sub SetDimLinePosValueLock(boolean iLocked)

Locks or unlocks the Dimension Line Position Value parameter.

Parameters:

i_locked (bool) –

Return type:

None

set_dim_line_up_base_angle_lock(i_locked: bool) → None

Note

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

o Sub SetDimLineUpBaseAngleLock(boolean iLocked)

Locks or unlocks the Dimension Line Up Base Angle parameter.

Parameters:

i_locked (bool) –

Return type:

None

set_dim_line_up_base_length_lock(i_locked: bool) → None

Note

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

o Sub SetDimLineUpBaseLengthLock(boolean iLocked)

Locks or unlocks the Dimension Line Up Base Length parameter.

Parameters:

i_locked (bool) –

Return type:

None

set_dim_line_up_cumul_lock(i_locked: bool) → None

Note

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

o Sub SetDimLineUpCumulLock(boolean iLocked)

Locks or unlocks the Dimension Line Up Cululated parameter.

Parameters:

i_locked (bool) –

Return type:

None

set_dim_line_up_funnel_lock(i_locked: bool) → None

Note

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

o Sub SetDimLineUpFunnelLock(boolean iLocked)

Locks or unlocks the Dimension Line Up Funnel parameter.

Parameters:

i_locked (bool) –

Return type:

None

set_dim_line_up_offset_bet_dim_angle_lock(i_locked: bool) → None

Note

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

o Sub SetDimLineUpOffsetBetDimAngleLock(boolean iLocked)

Locks or unlocks the DimLineUpOffsetBetDimAngle parameter.

Parameters:

iLocked

Input value of the DimLineUpOffsetBetDimAngle (lock/unlock). If

return code E_FAIL iLocked is not set. If return code S_OK iLocked is

set.

Parameters:

i_locked (bool) –

Return type:

None

set_dim_line_up_offset_bet_dim_length_lock(i_locked: bool) → None

Note

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

o Sub SetDimLineUpOffsetBetDimLengthLock(boolean iLocked)

Locks or unlocks the DimLineUpOffsetBetDimLength

parameter.

Parameters:

iLocked

Input value of the DimLineUpOffsetBetDimLength (lock/unlock). If

return code E_FAIL iLocked is not set. If return code S_OK iLocked is

set.

Parameters:

i_locked (bool) –

Return type:

None

set_dim_line_up_offset_to_ref_angle_lock(i_locked: bool) → None

Note

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

o Sub SetDimLineUpOffsetToRefAngleLock(boolean iLocked)

Locks or unlocks the DimLineUpOffsetToRefAngle parameter.

Parameters:

iLocked

Input value of the DimLineUpOffsetToRefAngle (lock/unlock). If

return code E_FAIL iLocked is not set. If return code S_OK iLocked is

set.

Parameters:

i_locked (bool) –

Return type:

None

set_dim_line_up_offset_to_ref_length_lock(i_locked: bool) → None

Note

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

o Sub SetDimLineUpOffsetToRefLengthLock(boolean iLocked)

Locks or unlocks the DimLineUpOffsetToRefLength parameter.

Parameters:

iLocked

Input value of the DimLineUpOffsetToRefLength (lock/unlock). If

return code E_FAIL iLocked is not set. If return code S_OK iLocked is

set.

Parameters:

i_locked (bool) –

Return type:

None

set_dim_line_up_stack_lock(i_locked: bool) → None

Note

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

o Sub SetDimLineUpStackLock(boolean iLocked)

Locks or unlocks the Dimension Line Up Stack parameter.

Parameters:

i_locked (bool) –

Return type:

None

set_dim_manual_positioning_lock(i_locked: bool) → None

Note

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

o Sub SetDimManualPositionningLock(boolean iLocked)

Locks or unlocks the Manual Positionning parameter.

Parameters:

i_locked (bool) –

Return type:

None

set_dim_move_2d_part_cre_lock(i_locked: bool) → None

Note

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

o Sub SetDimMove2dPartCreLock(boolean iLocked)

Locks or unlocks the Dimension Move 2D Creation parameter.

Parameters:

i_locked (bool) –

Return type:

None

set_dim_move_2d_part_mod_lock(i_locked: bool) → None

Note

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

o Sub SetDimMove2dPartModLock(boolean iLocked)

Locks or unlocks the Dimension Move 2D Modification parameter.

Parameters:

i_locked (bool) –

Return type:

None

set_dim_move_dim_line_cre_lock(i_locked: bool) → None

Note

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

o Sub SetDimMoveDimLineCreLock(boolean iLocked)

Locks or unlocks the Dimension Move Dimension Line Creation parameter.

Parameters:

i_locked (bool) –

Return type:

None

set_dim_move_dim_line_mod_lock(i_locked: bool) → None

Note

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

o Sub SetDimMoveDimLineModLock(boolean iLocked)

Locks or unlocks the Dimension Move Dimension Line Modification parameter.

Parameters:

i_locked (bool) –

Return type:

None

set_dim_move_leader_cre_lock(i_locked: bool) → None

Note

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

o Sub SetDimMoveLeaderCreLock(boolean iLocked)

Locks or unlocks the Dimension leader Creation parameter.

Parameters:

iLocked

Input value of the Dimension leader creation check box lock/unlock

status. If return code E_FAIL iLocked is not set. If return code S_OK iLocked

is set.

Parameters:

i_locked (bool) –

Return type:

None

set_dim_move_leader_mod_lock(i_locked: bool) → None

Note

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

o Sub SetDimMoveLeaderModLock(boolean iLocked)

Locks or unlocks the Dimension leader modification

parameter.

Parameters:

iLocked

Input value of the Dimension leader modification check box

(lock/unlock). If return code E_FAIL iLocked is not set. If return code S_OK

iLocked is set.

Parameters:

i_locked (bool) –

Return type:

None

set_dim_move_sub_part_lock(i_locked: bool) → None

Note

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

o Sub SetDimMoveSubPartLock(boolean iLocked)

Locks or unlocks the DimMoveSubPart parameter.

Parameters:

i_locked (bool) –

Return type:

None

set_dim_move_value_cre_lock(i_locked: bool) → None

Note

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

o Sub SetDimMoveValueCreLock(boolean iLocked)

Locks or unlocks the Dimension Move Value Creation parameter.

Parameters:

i_locked (bool) –

Return type:

None

set_dim_move_value_mod_lock(i_locked: bool) → None

Note

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

o Sub SetDimMoveValueModLock(boolean iLocked)

Locks or unlocks the Dimension Move Value Modification parameter.

Parameters:

i_locked (bool) –

Return type:

None

set_dim_o_run_cre_lock(i_locked: bool) → None

Note

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

o Sub SetDimORunCreLock(boolean iLocked)

Locks or unlocks the Dimension Over Run Creation parameter.

Parameters:

i_locked (bool) –

Return type:

None

set_dim_o_run_mod_lock(i_locked: bool) → None

Note

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

o Sub SetDimORunModLock(boolean iLocked)

Locks or unlocks the Dimension Over Run Modification parameter.

Parameters:

i_locked (bool) –

Return type:

None

set_dim_ori_default_symb_lock(i_locked: bool) → None

Note

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

o Sub SetDimOriDefaultSymbLock(boolean iLocked)

Locks or unlocks the Dimension Orientation Default Symbol parameter.

Parameters:

i_locked (bool) –

Return type:

None

set_dim_snapping_lock(i_locked: bool) → None

Note

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

o Sub SetDimSnappingLock(boolean iLocked)

Locks or unlocks the Dimension Snapping parameter.

Parameters:

i_locked (bool) –

Return type:

None

set_general_tol_class_lock(i_locked: bool) → None

Note

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

o Sub SetGeneralTolClassLock(boolean iLocked)

Locks or unlocks the Dimension general class parameter.

Parameters:

i_locked (bool) –

Return type:

None

set_highlight_def_annot_lock(i_locked: bool) → None

Note

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

o Sub SetHighlightDefAnnotLock(boolean iLocked)

Locks or unlocks the Highlight Def Annot parameter.

Parameters:

i_locked (bool) –

Return type:

None

set_noa_creation_lock(i_locked: bool) → None

Note

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

o Sub SetNoaCreationLock(boolean iLocked)

Locks or unlocks the Noa Creation parameter.

Parameters:

i_locked (bool) –

Return type:

None

set_non_semantic_always_upgrade_general_tol_lock(i_locked: bool) → None

Note

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

o Sub SetNonSemanticAllwaysUpgradeGeneralTolLock(boolean

iLocked)

Locks or unlocks the Non Semantic Allways Upgrade general tolerance

parameter.

Parameters:

i_locked (bool) –

Return type:

None

set_non_semantic_always_upgrade_lock(i_locked: bool) → None

Note

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

o Sub SetNonSemanticAllwaysUpgradeLock(boolean iLocked)

Locks or unlocks the Non Semantic Allways Upgrade parameter.

Parameters:

i_locked (bool) –

Return type:

None

set_non_semantic_dim_allowed_lock(i_locked: bool) → None

Note

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

o Sub SetNonSemanticDimAllowedLock(boolean iLocked)

Locks or unlocks the Non Semantic Dim Allowed parameter.

Parameters:

i_locked (bool) –

Return type:

None

set_non_semantic_marked_lock(i_locked: bool) → None

Note

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

o Sub SetNonSemanticMarkedLock(boolean iLocked)

Locks or unlocks the Non Semantic Marked parameter.

Parameters:

i_locked (bool) –

Return type:

None

set_non_semantic_tol_allowed_lock(i_locked: bool) → None

Note

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

o Sub SetNonSemanticTolAllowedLock(boolean iLocked)

Locks or unlocks the Non Semantic Tol Allowed parameter.

Parameters:

i_locked (bool) –

Return type:

None

set_parameters_in_tree_lock(i_locked: bool) → None

Note

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

o Sub SetParametersInTreeLock(boolean iLocked)

Locks or unlocks the Parameters in tree parameter.

Parameters:

i_locked (bool) –

Return type:

None

set_rotation_snap_angle_lock(i_locked: bool) → None

Note

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

o Sub SetRotationSnapAngleLock(boolean iLocked)

Locks or unlocks the Rotation Snap Angle parameter.

Parameters:

i_locked (bool) –

Return type:

None

set_rotation_snap_auto_lock(i_locked: bool) → None

Note

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

o Sub SetRotationSnapAutoLock(boolean iLocked)

Locks or unlocks the Rotation Snap Auto parameter.

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

set_select_published_geometry_lock(i_locked: bool) → None

Note

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

o Sub SetSelectPublishedGeometryLock(boolean iLocked)

Locks or unlocks the Select Published Geometry parameter.

Parameters:

i_locked (bool) –

Return type:

None

set_shifted_profile_lock(i_locked: bool) → None

Note

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

o Sub SetShiftedProfileLock(boolean iLocked)

Locks or unlocks the Shifted Profile parameter.

Parameters:

i_locked (bool) –

Return type:

None

set_true_dimension_color(i_value_r: int, i_value_g: int, i_value_b: int) → None

Note

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

o Sub SetTrueDimensionColor(long iValueR,

long iValueG,

long iValueB)

Sets the TrueDimensionColor parameter.

Parameters:

• i_value_r (int) –

• i_value_g (int) –

• i_value_b (int) –

Return type:

None

set_true_dimension_color_lock(i_locked: bool) → None

Note

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

o Sub SetTrueDimensionColorLock(boolean iLocked)

Locks or unlocks the TrueDimensionColor parameter.

Role:Locks or unlocks the TrueDimensionColor 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_true_dimension_lock(i_locked: bool) → None

Note

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

o Sub SetTrueDimensionLock(boolean iLocked)

Locks or unlocks the TrueDimension parameter.

Role:Locks or unlocks the TrueDimension 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 shifted_profile: bool

Note

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

o Property ShiftedProfile() As boolean

Returns or sets the Shifted Profile parameter.

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

Return type:

bool

property true_dimension: bool

Note

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

o Property TrueDimension() As boolean

Returns the TrueDimension parameter.

Return type:

bool