pycatia.analysis_interfaces.analysis_post_pro_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.analysis_interfaces.analysis_post_pro_setting_att.AnalysisPostProSettingAtt(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

AnalysisPostProSettingAtt

Interface to handle the Analysis & Simulation

“PostProcessingSetting”.

property auto_preview_mode: bool

Note

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

o Property AutoPreviewMode() As boolean

Returns or sets the AutoPreviewMode parameter.

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

Return type:

bool

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

Note

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

o Func GetAutoPreviewModeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the AutoPreviewMode

parameter.

Role:Retrieves the state of the AutoPreviewMode 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_image_text_size_info(io_admin_level: str, io_locked: str) → bool

Note

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

o Func GetImageTextSizeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the ImageTextSize

parameter.

Role:Retrieves the state of the ImageTextSize 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_image_text_stacking_info(io_admin_level: str, io_locked: str) → bool

Note

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

o Func GetImageTextStackingInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the ImageTextStacking

parameter.

Role:Retrieves the state of the ImageTextStacking 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_mode_image_text_size_info(io_admin_level: str, io_locked: str) → bool

Note

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

o Func GetModeImageTextSizeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the ModeImageTextSize

parameter.

Role:Retrieves the state of the ModeImageTextSize 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_save_as_new_template_directory_info(io_admin_level: str, io_locked: str) → bool

Note

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

o Func GetSaveAsNewTemplateDirectoryInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the SaveAsNewTemplateDirectory

parameter.

Role:Retrieves the state of the SaveAsNewTemplateDirectory parameter in the

current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

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

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

property image_text_size: float

Note

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

o Property ImageTextSize() As float

Returns or sets the ImageTextSize parameter.

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

Return type:

float

property image_text_stacking: int

Note

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

o Property ImageTextStacking() As long

Returns or sets the ImageTextStacking parameter.

Parameters:

iImageTextStacking

Legal values:

0 : Text stacking is Horizontal

1 : Text stacking is Vertical Ensure consistency with the C++ interface to which the work is delegated.

Return type:

int

property mode_image_text_size: bool

Note

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

o Property ModeImageTextSize() As boolean

Returns or sets the ModeImageTextSize parameter.

Parameters:

iModeImageTextSize

Legal values:

TRUE : Enables the setting of image text size

FALSE: Disables the setting of image text size Ensure consistency

with the C++ interface to which the work is

delegated.

Return type:

bool

property save_as_new_template_directory: str

Note

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

o Property SaveAsNewTemplateDirectory() As CATBSTR

Returns or sets the SaveAsNewTemplateDirectory parameter.

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

Return type:

str

set_auto_preview_mode_lock(i_locked: bool) → None

Note

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

o Sub SetAutoPreviewModeLock(boolean iLocked)

Locks or unlocks the AutoPreviewMode parameter.

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

Note

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

o Sub SetImageTextSizeLock(boolean iLocked)

Locks or unlocks the ImageTextSize parameter.

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

Note

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

o Sub SetImageTextStackingLock(boolean iLocked)

Locks or unlocks the ImageTextStacking parameter.

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

Note

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

o Sub SetModeImageTextSizeLock(boolean iLocked)

Locks or unlocks the ModeImageTextSize parameter.

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

Note

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

o Sub SetSaveAsNewTemplateDirectoryLock(boolean iLocked)

Locks or unlocks the SaveAsNewTemplateDirectory parameter.

Role:Locks or unlocks the Xxx parameter if it is possible in the current

administrative context. In user mode this method will always return

E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Parameters:

i_locked (bool) –

Return type:

None