pycatia.fitting_interfaces.fitting_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.fitting_interfaces.fitting_setting_att.FittingSettingAtt(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

FittingSettingAtt

Interface to handle parameters of DMU Fitting Tools Options Tab page Role: This

interface is implemented by a component which represents the controller of DMU

Fitting Tools Options parameter settings.

Methods to set value of each parameter

Methods to get value of each parameter

Methods to get information on each parameter

Methods to lock/unlock value of each parameter

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

Note

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

o Func GetAngleLimitInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment information for the AngleLimit

parameter.

Role:Retrieves the state of the AngleLimit parameter in the current

environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetClashWhileMovingInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment information for the AskAnlMode

parameter.

Role:Retrieves the state of the AskAnlMode parameter in the current

environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetDefaultSpeedInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment information for the DefaultSpeed

parameter.

Role:Retrieves the state of the DefaultSpeed parameter in the current

environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetDefaultTimeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment information for the DefaultTime

parameter.

Role:Retrieves the state of the DefaultTime parameter in the current

environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetMaxAngleInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment information for the MaxAngle

parameter.

Role:Retrieves the state of the MaxAngle parameter in the current

environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetPathFinderSmoothInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment information for the PathFinderSmooth

parameter.

Role:Retrieves the state of the PathFinderSmooth parameter in the current

environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetTrackAutoUpdateInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment information for the TrackAutoUpdate

parameter.

Role:Retrieves the state of the TrackAutoUpdate parameter in the current

environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetVectorInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment information for the VisualizationMode

parameter.

Role:Retrieves the state of the VisualizationMode parameter in the current

environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

set_angle_limit_lock(i_locked: bool) → None

Note

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

o Sub SetAngleLimitLock(boolean iLocked)

Locks or unlocks the AngleLimit parameter.

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

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

i_locked (bool) –

Return type:

None

set_clash_while_moving_lock(i_locked: bool) → None

Note

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

o Sub SetClashWhileMovingLock(boolean iLocked)

Locks or unlocks the ClashWhileMoving parameter.

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

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

i_locked (bool) –

Return type:

None

set_default_speed_lock(i_locked: bool) → None

Note

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

o Sub SetDefaultSpeedLock(boolean iLocked)

Locks or unlocks the DefaultSpeed parameter.

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

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

i_locked (bool) –

Return type:

None

set_default_time_lock(i_locked: bool) → None

Note

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

o Sub SetDefaultTimeLock(boolean iLocked)

Locks or unlocks the DefaultTime parameter.

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

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

i_locked (bool) –

Return type:

None

set_max_angle_lock(i_locked: bool) → None

Note

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

o Sub SetMaxAngleLock(boolean iLocked)

Locks or unlocks the MaxAngle parameter.

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

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

i_locked (bool) –

Return type:

None

set_path_finder_smooth_lock(i_locked: bool) → None

Note

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

o Sub SetPathFinderSmoothLock(boolean iLocked)

Locks or unlocks the PathFinderSmooth parameter.

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

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

i_locked (bool) –

Return type:

None

set_track_auto_update_lock(i_locked: bool) → None

Note

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

o Sub SetTrackAutoUpdateLock(boolean iLocked)

Locks or unlocks the TrackAutoUpdate parameter.

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

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

i_locked (bool) –

Return type:

None

set_vector_lock(i_locked: bool) → None

Note

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

o Sub SetVectorLock(boolean iLocked)

Locks or unlocks the VisualizationMode parameter.

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

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

i_locked (bool) –

Return type:

None