pycatia.cat_dde_settings_interfaces.ig2_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_dde_settings_interfaces.ig2_setting_att.Ig2SettingAtt(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

Ig2SettingAtt

Interface dedicated to modify or read the current settings corresponding to the

IG2 Data Exchange

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

delegated.

property export_mode: int

Note

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

o Property ExportMode() As CatIg2ExportModeEnum (Read Only)

Get the Export Mode option value.

Parameters:

oMode

Legal values: An available value of the enum CatIg2ExportModeEnum.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Returns:

enum cat_ig2_export_mode_enum

Return type:

int

property export_sheets: int

Note

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

o Property ExportSheets() As CatIg2ExportSheetsEnum (Read

Only)

Get the Exported Sheets option value.

Parameters:

oSheets

Legal values: An available value of the enum

CatIg2ExportSheetsEnum.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Return type:

int

get_export_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 GetExportModeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the Export Mode

option.

Parameters:

ioAdminLevel

If the option is locked, AdminLevel gives the administration level

that imposes the value of the option.

If the option is not locked, AdminLevel gives the administration

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

ioLocked

Indicates if the option has been locked.

oModified

Indicates if the option has been explicitly modified or remain to

the administrated value.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetExportSheetsInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the Exported Sheets

option.

Parameters:

ioAdminLevel

If the option is locked, AdminLevel gives the administration level

that imposes the value of the option.

If the option is not locked, AdminLevel gives the administration

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

ioLocked

Indicates if the option has been locked.

oModified

Indicates if the option has been explicitly modified or remain to

the administrated value.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetImportDestinationViewInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the destination view

option.

Parameters:

ioAdminLevel

If the option is locked, AdminLevel gives the administration level

that imposes the value of the option.

If the option is not locked, AdminLevel gives the administration

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

ioLocked

Indicates if the option has been locked.

oModified

Indicates if the option has been explicitly modified or remain to

the administrated value.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetImportDftStandardInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the Drafting standard

option.

Parameters:

ioAdminLevel

If the option is locked, AdminLevel gives the administration level

that imposes the value of the option.

If the option is not locked, AdminLevel gives the administration

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

ioLocked

Indicates if the option has been locked.

oModified

Indicates if the option has been explicitly modified or remain to

the administrated value.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetImportDimensionsInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the Import dimensions

option.

Parameters:

ioAdminLevel

If the option is locked, AdminLevel gives the administration level

that imposes the value of the option.

If the option is not locked, AdminLevel gives the administration

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

ioLocked

Indicates if the option has been locked.

oModified

Indicates if the option has been explicitly modified or remain to

the administrated value.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetImportEndPointsInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the Create End Points

option.

Parameters:

ioAdminLevel

If the option is locked, AdminLevel gives the administration level

that imposes the value of the option.

If the option is not locked, AdminLevel gives the administration

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

ioLocked

Indicates if the option has been locked.

oModified

Indicates if the option has been explicitly modified or remain to

the administrated value.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetImportUnitInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the import unit

option.

Parameters:

ioAdminLevel

If the option is locked, AdminLevel gives the administration level

that imposes the value of the option.

If the option is not locked, AdminLevel gives the administration

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

ioLocked

Indicates if the option has been locked.

oModified

Indicates if the option has been explicitly modified or remain to

the administrated value.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

property import_destination_view: int

Note

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

o Property ImportDestinationView() As CatIg2ImportDestinationViewEnum (Read

Only)

Get the destination view.

Parameters:

oDestinationView

Legal values: An available value of the enum

CatIg2ImportDestinationViewEnum.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Returns:

enum cat_ig2_import_destination_view_enum

Return type:

int

property import_dft_standard: str

Note

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

o Property ImportDftStandard() As CATBSTR (Read Only)

Get the name of the Drafting standard, which define the standard of the

resulting CATDrawing file.

Parameters:

oDftStandard

the CATBSTR corresponding to the Drafting standard.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Return type:

str

property import_dimensions: int

Note

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

o Property ImportDimensions() As CatIg2ImportDimensionsEnum (Read

Only)

Get the Import dimensions option value.

Parameters:

oDimensions

Legal values: An available value of the enum

CatIg2ImportDimensionsEnum.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Returns:

enum cat_ig2_import_dimensions_enum

Return type:

int

property import_end_points: int

Note

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

o Property ImportEndPoints() As CatIg2ImportCreateEndPointsEnum (Read

Only)

Get the Create End Points option value.

Parameters:

oEndPoints

Legal values: An available value of the enum

CatIg2ImportCreateEndPointsEnum.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Returns:

enum cat_ig2_import_create_end_points_enum

Return type:

int

property import_unit: int

Note

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

o Property ImportUnit() As CatIg2ImportUnitEnum (Read Only)

Get the import unit.

Parameters:

oUnit

Legal values: An available value of the enum CatIg2ImportUnitEnum.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Returns:

enum cat_ig2_import_unit_enum

Return type:

int

set_export_mode(i_mode: int) → None

Note

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

o Sub set_ExportMode(CatIg2ExportModeEnum iMode)

Set the Export Mode option value.

Parameters:

iMode

Legal values: An available value of the enum CatIg2ExportModeEnum.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

i_mode (int) – enum cat_ig2_export_mode_enum

Return type:

None

set_export_mode_lock(i_locked: bool) → None

Note

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

o Sub SetExportModeLock(boolean iLocked)

Locks or unlocks the Export Mode option if the operation is allowed in the

current administrated environment. In user mode this method will always return

E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE: to lock the option.

FALSE: to unlock the option.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

i_locked (bool) –

Return type:

None

set_export_sheets(i_sheets: int) → None

Note

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

o Sub set_ExportSheets(CatIg2ExportSheetsEnum iSheets)

set the Exported Sheets option value.

Parameters:

iSheets

Legal values: An available value of the enum

CatIg2ExportSheetsEnum.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

i_sheets (int) –

Return type:

None

set_export_sheets_lock(i_locked: bool) → None

Note

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

o Sub SetExportSheetsLock(boolean iLocked)

Locks or unlocks the Exported Sheets option if the operation is allowed in

the current administrated environment. In user mode this method will always

return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE: to lock the option.

FALSE: to unlock the option.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

i_locked (bool) –

Return type:

None

set_import_destination_view(i_destination_view: int) → None

Note

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

o Sub set_ImportDestinationView(CatIg2ImportDestinationViewEnum

iDestinationView)

Set the destination view.

Parameters:

iDestinationView

Legal values: An available value of the enum

CatIg2ImportDestinationViewEnum

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

i_destination_view (int) – enum cat_ig2_import_destination_view_enum

Return type:

None

set_import_destination_view_lock(i_locked: bool) → None

Note

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

o Sub SetImportDestinationViewLock(boolean iLocked)

Locks or unlocks the import destination view if the operation is allowed in

the current administrated environment. In user mode this method will always

return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE: to lock the option.

FALSE: to unlock the option.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

i_locked (bool) –

Return type:

None

set_import_dft_standard(i_dft_standard: str) → None

Note

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

o Sub set_ImportDftStandard(CATBSTR iDftStandard)

Set the name of the Drafting standard, which define the standard of the

resulting CATDrawing file.

Parameters:

iDftStandard

the CATBSTR corresponding to the Drafting standard.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

i_dft_standard (str) –

Return type:

None

set_import_dft_standard_lock(i_locked: bool) → None

Note

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

o Sub SetImportDftStandardLock(boolean iLocked)

Locks or unlocks the Drafting standard option if the operation is allowed

in the current administrated environment. In user mode this method will always

return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE: to lock the option.

FALSE: to unlock the option.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

i_locked (bool) –

Return type:

None

set_import_dimensions(i_dimensions: int) → None

Note

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

o Sub set_ImportDimensions(CatIg2ImportDimensionsEnum

iDimensions)

Set the Import dimensions option value.

Parameters:

iDimensions

Legal values: An available value of the enum

CatIg2ImportDimensionsEnum.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

i_dimensions (int) – enum cat_ig2_import_dimensions_enum

Return type:

None

set_import_dimensions_lock(i_locked: bool) → None

Note

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

o Sub SetImportDimensionsLock(boolean iLocked)

Locks or unlocks the Import dimensions option if the operation is allowed

in the current administrated environment. In user mode this method will always

return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE: to lock the option.

FALSE: to unlock the option.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

i_locked (bool) –

Return type:

None

set_import_end_points(i_end_points: int) → None

Note

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

o Sub set_ImportEndPoints(CatIg2ImportCreateEndPointsEnum

iEndPoints)

Set the Create End Points option value.

Parameters:

iEndPoints

Legal values: An available value of the enum

CatIg2ImportCreateEndPointsEnum.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

i_end_points (int) – enum cat_ig2_import_create_end_points_enum

Return type:

None

set_import_end_points_lock(i_locked: bool) → None

Note

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

o Sub SetImportEndPointsLock(boolean iLocked)

Locks or unlocks the Create End Points option if the operation is allowed

in the current administrated environment. In user mode this method will always

return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE: to lock the option.

FALSE: to unlock the option.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

i_locked (bool) –

Return type:

None

set_import_unit(i_unit: int) → None

Note

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

o Sub set_ImportUnit(CatIg2ImportUnitEnum iUnit)

Set the import unit.

Parameters:

iUnit

Legal values: An available value of the enum CatIg2ImportUnitEnum

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

i_unit (int) – enum cat_ig2_import_unit_enum

Return type:

None

set_import_unit_lock(i_locked: bool) → None

Note

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

o Sub SetImportUnitLock(boolean iLocked)

Locks or unlocks the import unit option if the operation is allowed in the

current administrated environment. In user mode this method will always return

E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE: to lock the option.

FALSE: to unlock the option.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

i_locked (bool) –

Return type:

None