pycatia.dnb_igp_olp_ui.igp_olp_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.dnb_igp_olp_ui.igp_olp_setting_att.IgpOlpSettingAtt(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

IgpOlpSettingAtt

Represents the Offline Programming setting controller object.

Role: The Offline Programming setting controller object deals with the setting

attributes displayed in the IGRIP/Offline Programming property page. To access

this property page:

Click the Options command in the Tools menu

Click IGRIP

Right scroll to display the property pages titles until you get Offline

Programming

Click Offline Programming

The Offline Programming setting controller object can be retrieved as an item

of the setting controller collection using its name “DNBIgpOlpAutoSettingCtrl”

as follows:

Dim settingControllers1 As SettingControllers

Set settingControllers1 = CATIA.SettingControllers

Dim DNBIAIgpOlpSettingAtt1 As SettingController

Set DNBIAIgpOlpSettingAtt1 = settingControllers1.Item(“DNBIgpOlpAutoSettingCtrl”)

property downloader: str

Note

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

o Property Downloader() As CATBSTR

Returns or sets value of OLP Translator parameter.

Role: The OLP Translator setting parameter stores the name of currently

selected downloader, also known as the XSLT translator.

Return type:

str

property downloader_dir: str

Note

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

o Property DownloaderDir() As CATBSTR

Returns or sets value of OLP Translator Directory

parameter.

Role: The OLP Translator Directory setting parameter stores the full file

path to directory where OLP downloaders, also known as XSLT translators, are

stored.

Return type:

str

property existing_task_treatment: int

Note

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

o Property ExistingTaskTreatment() As long

Returns or sets value of OLP Existing Task Treatment On Upload

parameter.

Role: The OLP Existing Task Treatment On Upload setting parameter

determines how will the existing robot tasks with identical names as the tasks

to be uploaded be treated during upload.

Legal values:

2 Delete existing robot tasks and all the referenced tags

1 Delete existing robot tasks only

0 Do not delete existing robot tasks

Return type:

int

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

Note

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

o Func GetDownloaderDirInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the OLP Translator Directory setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetDownloaderInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the OLP Translator setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetExistingTaskTreatmentInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the OLP Existing Task Treatment On Upload

setting parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetJavaClassPathInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the OLP Java Class Path setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetJavaExeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the OLP Java Executable setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetNRLDirInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the NRL configuration file directory setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_nrl_teach_dialog_display_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 GetNRLTeachDialogDisplayModeInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the OLPNRLTeachDialogDisplay setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetRobotProgramDirInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the OLP Directory setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetUploaderDirInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the OLP Parser Directory setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetUploaderInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the OLP Parser setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetXMLDirInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the OLP XML Directory setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetXMLSchemaInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the OLP XML Schema setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

property java_class_path: str

Note

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

o Property JavaClassPath() As CATBSTR

Returns or sets value of OLP Java Class Path parameter.

Role: The OLP Java Class Path setting parameter stores the full file path

to Java JAR files required to proper functioning of OLP download.

Return type:

str

property java_exe: str

Note

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

o Property JavaExe() As CATBSTR

Returns or sets value of OLP Java Executable parameter.

Role: The OLP Java Executable setting parameter stores the full file path

to java.exe file of Java JRE 1_4_1, or later.

Return type:

str

property nrl_dir: str

Note

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

o Property NRLDir() As CATBSTR

Returns or sets value of NRL configuration file directory

parameter.

Role: The NRL configuration file directory parameter stores the full file

path to directory where NRL configuration files are stored.

Return type:

str

property nrl_teach_dialog_display_mode: int

Note

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

o Property NRLTeachDialogDisplayMode() As long

Returns or sets value of OLPNRLTeachDialogDisplay

parameter.

Role: The OLPNRLTeachDialogDisplay setting parameter determines whether NRL

Teach dialog will be displayed while creating and/or V5 editing of RobotMotion

activities.

Legal values:

1 NRL Teach dialog will be hidden

0 NRL Teach dialog will remain displayed

Return type:

int

property robot_program_dir: str

Note

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

o Property RobotProgramDir() As CATBSTR

Returns or sets value of OLP Directory parameter.

Role: The OLP Directory setting parameter stores the full file path to

directory where native robot language programs on upload should be stored.

Return type:

str

set_downloader_dir_lock(i_locked: bool) → None

Note

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

o Sub SetDownloaderDirLock(boolean iLocked)

Locks or unlocks the OLP Translator Directory setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_downloader_lock(i_locked: bool) → None

Note

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

o Sub SetDownloaderLock(boolean iLocked)

Locks or unlocks the OLP Translator setting parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_existing_task_treatment_lock(i_locked: bool) → None

Note

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

o Sub SetExistingTaskTreatmentLock(boolean iLocked)

Locks or unlocks the OLP Existing Task Treatment On Upload

parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_java_class_path_lock(i_locked: bool) → None

Note

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

o Sub SetJavaClassPathLock(boolean iLocked)

Locks or unlocks the OLP Java Class Path parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_java_exe_lock(i_locked: bool) → None

Note

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

o Sub SetJavaExeLock(boolean iLocked)

Locks or unlocks the OLP Java Executable parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_nrl_dir_lock(i_locked: bool) → None

Note

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

o Sub SetNRLDirLock(boolean iLocked)

Locks or unlocks the NRL configuration file directory setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_nrl_teach_dialog_display_mode_lock(i_locked: bool) → None

Note

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

o Sub SetNRLTeachDialogDisplayModeLock(boolean iLocked)

Locks or unlocks the OLPNRLTeachDialogDisplay parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_robot_program_dir_lock(i_locked: bool) → None

Note

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

o Sub SetRobotProgramDirLock(boolean iLocked)

Locks or unlocks the OLP Directory setting parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_uploader_dir_lock(i_locked: bool) → None

Note

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

o Sub SetUploaderDirLock(boolean iLocked)

Locks or unlocks the OLP Parser Directory setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_uploader_lock(i_locked: bool) → None

Note

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

o Sub SetUploaderLock(boolean iLocked)

Locks or unlocks the OLP Parser setting parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_xml_dir_lock(i_locked: bool) → None

Note

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

o Sub SetXMLDirLock(boolean iLocked)

Locks or unlocks the OLP XML Directory setting parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_xml_schema_lock(i_locked: bool) → None

Note

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

o Sub SetXMLSchemaLock(boolean iLocked)

Locks or unlocks the OLP XML Schema setting parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

property uploader: str

Note

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

o Property Uploader() As CATBSTR

Returns or sets value of OLP Parser parameter.

Role: The OLP Parser setting parameter stores the name of currently

selected uploader, also known as the Java Parser.

Return type:

str

property uploader_dir: str

Note

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

o Property UploaderDir() As CATBSTR

Returns or sets value of OLP Parser Directory parameter.

Role: The OLP Parser Directory setting parameter stores the full file path

to directory where OLP uploaders, also known as Java Parsers, are stored.

Return type:

str

property xml_dir: str

Note

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

o Property XMLDir() As CATBSTR

Returns or sets value of OLP XML Directory parameter.

Role: The OLP XML Directory setting parameter stores the full file path to

directory where XML file created during download, named simResult.xml, is

stored.

Return type:

str

property xml_schema: str

Note

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

o Property XMLSchema() As CATBSTR

Returns or sets value of OLP XML Schema parameter.

Role: The OLP XML Schema setting parameter stores the full file path to an

W3C XML Schema file, used for XML file validation on upload, is stored.

Return type:

str