pycatia.analysis_interfaces.analysis_reporting_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_reporting_setting_att.AnalysisReportingSettingAtt(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
AnalysisReportingSettingAtt

Interface to handle the Analysis & Simulation
“ReportingSetting”.
property background_image_mode: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property BackgroundImageMode() As boolean

Returns or sets the BackgroundImageMode parameter.

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

bool

property custom_background_image: str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property CustomBackgroundImage() As CATBSTR

Returns or sets the CustomBackgroundImage parameter.

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

str

property custom_image_format: str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property CustomImageFormat() As CATBSTR

Returns or sets the CustomImageFormat parameter.

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

str

property custom_image_height: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property CustomImageHeight() As long

Returns or sets the CustomImageHeight parameter.

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

int

property custom_image_width: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property CustomImageWidth() As long

Returns or sets the CustomImageWidth parameter.

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

int

get_background_image_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 GetBackgroundImageModeInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

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

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetCustomBackgroundImageInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

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

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetCustomImageFormatInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

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

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetCustomImageHeightInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

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

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetCustomImageWidthInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the CustomImageWidth
parameter.
Role:Retrieves the state of the CustomImageWidth 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_quality_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 GetImageQualityModeInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the ImageQualityMode
parameter.
Role:Retrieves the state of the ImageQualityMode 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_temp_output_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 GetTempOutputDirectoryInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the TempOutputDirectory
parameter.
Role:Retrieves the state of the TempOutputDirectory 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_quality_mode: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property ImageQualityMode() As boolean

Returns or sets the ImageQualityMode parameter.

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

bool

set_background_image_mode_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetBackgroundImageModeLock(boolean iLocked)

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

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetCustomBackgroundImageLock(boolean iLocked)

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

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetCustomImageFormatLock(boolean iLocked)

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

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetCustomImageHeightLock(boolean iLocked)

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

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetCustomImageWidthLock(boolean iLocked)

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

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetImageQualityModeLock(boolean iLocked)

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

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetTempOutputDirectoryLock(boolean iLocked)

Locks or unlocks the TempOutputDirectory parameter.
Role:Locks or unlocks the TempOutputDirectory 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 temp_output_directory: str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property TempOutputDirectory() As CATBSTR

Returns or sets the TempOutputDirectory parameter.

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

str