All Frameworks Class Hierarchy This Framework Indexes
DNBIgpOlpUI Interface DNBIIgpOlpSettingAtt
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---DNBIIgpOlpSettingAtt
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface DNBIIgpOlpSettingAtt
Interface to the Offline Programming setting controller.
Role: The Offline Programming setting controller is dedicated to manage the
setting parameters displayed in the 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
Retrieve a pointer to DNBIIgpOlpSettingAtt as follows:
DNBIIgpOlpSettingAtt * pINewDNBIgpOlpSettingCtrl;
HRESULT rc = E_FAIL;
rc = ::CATInstantiateComponent("DNBIgpOlpSettingCtrl",
IID_DNBIIgpOlpSettingAtt,
(void**) &pINewDNBIgpOlpSettingCtrl);
Method Index
- o
GetDownloader(CATUnicodeString&)
- Retrieves the OLP Translator setting parameter value.
- o
GetDownloaderDir(CATUnicodeString&)
- Retrieves the OLP Translator Directory setting parameter value.
- o
GetDownloaderDirInfo(CATSettingInfo*)
- Retrieves information about the OLP Translator Directory setting parameter.
- o
GetDownloaderInfo(CATSettingInfo*)
- Retrieves information about the OLP Translator setting parameter.
- o
GetExistingTaskTreatment(int&)
- Retrieves the OLP Existing Task Treatment On Upload setting parameter value.
- o
GetExistingTaskTreatmentInfo(CATSettingInfo*)
- Retrieves information about the OLP Existing Task Treatment On Upload setting parameter.
- o
GetJavaClassPath(CATUnicodeString&)
- Retrieves the OLP Java Class Path setting parameter value.
- o
GetJavaClassPathInfo(CATSettingInfo*)
- Retrieves information about the OLP Java Class Path setting parameter.
- o
GetJavaExe(CATUnicodeString&)
- Retrieves the OLP Java Executable setting parameter value.
- o
GetJavaExeInfo(CATSettingInfo*)
- Retrieves information about the OLP Java Executable setting parameter.
- o
GetNRLDir(CATUnicodeString&)
- Retrieves the NRL Configuration File Directory setting parameter value.
- o
GetNRLDirInfo(CATSettingInfo*)
- Retrieves information about the NRL Configuration File Directory setting parameter.
- o
GetNRLTeachDialogDisplayMode(int&)
- Retrieves the OLPNRLTeachDialogDisplayMode setting parameter value.
- o
GetNRLTeachDialogDisplayModeInfo(CATSettingInfo*)
- Retrieves information about the OLPNRLTeachDialogDisplayMode setting parameter.
- o
GetRobotProgramDir(CATUnicodeString&)
- Retrieves the OLP Directory setting parameter value.
- o
GetRobotProgramDirInfo(CATSettingInfo*)
- Retrieves information about the OLP Directory setting parameter.
- o
GetUploader(CATUnicodeString&)
- Retrieves the OLP Parser setting parameter value.
- o
GetUploaderDir(CATUnicodeString&)
- Retrieves the OLP Parser Directory setting parameter value.
- o
GetUploaderDirInfo(CATSettingInfo*)
- Retrieves information about the OLP Parser Directory setting parameter.
- o
GetUploaderInfo(CATSettingInfo*)
- Retrieves information about the OLP Parser setting parameter.
- o
GetXMLDir(CATUnicodeString&)
- Retrieves the OLP XML Directory setting parameter value.
- o
GetXMLDirInfo(CATSettingInfo*)
- Retrieves information about the OLP XML Directory setting parameter.
- o
GetXMLSchema(CATUnicodeString&)
- Retrieves the OLP XML Schema setting parameter value.
- o
GetXMLSchemaInfo(CATSettingInfo*)
- Retrieves information about the OLP XML Schema setting parameter.
- o
SetDownloader(CATUnicodeString&)
- Sets the OLP Translator setting parameter value.
- o
SetDownloaderDir(CATUnicodeString&)
- Sets the OLP Translator Directory setting parameter value.
- o
SetDownloaderDirLock(unsigned char)
- Locks or unlocks the OLP Translator Directory setting parameter.
- o
SetDownloaderLock(unsigned char)
- Locks or unlocks the OLP Translator setting parameter.
- o
SetExistingTaskTreatment(int&)
- Sets the OLP Existing Task Treatment On Upload setting parameter value.
- o
SetExistingTaskTreatmentLock(unsigned char)
- Locks or unlocks the OLP Existing Task Treatment On Upload setting parameter.
- o
SetJavaClassPath(CATUnicodeString&)
- Sets the OLP Java Class Path setting parameter value.
- o
SetJavaClassPathLock(unsigned char)
- Locks or unlocks the OLP Java Class Path setting parameter.
- o
SetJavaExe(CATUnicodeString&)
- Sets the OLP Java Executable setting parameter value.
- o
SetJavaExeLock(unsigned char)
- Locks or unlocks the OLP Java Executable setting parameter.
- o
SetNRLDir(CATUnicodeString&)
- Sets the NRL Configuration File Directory setting parameter value.
- o
SetNRLDirLock(unsigned char)
- Locks or unlocks the NRL Configuration File Directory setting parameter.
- o
SetNRLTeachDialogDisplayMode(int&)
- Sets the OLPNRLTeachDialogDisplayMode setting parameter value.
- o
SetNRLTeachDialogDisplayModeLock(unsigned char)
- Locks or unlocks the OLPNRLTeachDialogDisplayMode setting parameter.
- o
SetRobotProgramDir(CATUnicodeString&)
- Sets the OLP Directory setting parameter value.
- o
SetRobotProgramDirLock(unsigned char)
- Locks or unlocks the OLP Directory setting parameter.
- o
SetUploader(CATUnicodeString&)
- Sets the OLP Parser setting parameter value.
- o
SetUploaderDir(CATUnicodeString&)
- Sets the OLP Parser Directory setting parameter value.
- o
SetUploaderDirLock(unsigned char)
- Locks or unlocks the OLP Parser Directory setting parameter.
- o
SetUploaderLock(unsigned char)
- Locks or unlocks the OLP Parser setting parameter.
- o
SetXMLDir(CATUnicodeString&)
- Sets the OLP XML Directory setting parameter value.
- o
SetXMLDirLock(unsigned char)
- Locks or unlocks the OLP XML Directory setting parameter.
- o
SetXMLSchema(CATUnicodeString&)
- Sets the OLP XML Schema setting parameter value.
- o
SetXMLSchemaLock(unsigned char)
- Locks or unlocks the OLP XML Schema setting parameter.
Methods
o GetDownloader
-
Retrieves the OLP Translator setting parameter value.
Role: The OLP Translator setting parameter stores the name
of currently selected downloader, also known as the XSLT translator.
- Parameters:
-
- oDownloader
- [inout] The OLP Translator setting parameter value
- Returns:
- S_OK if the OLP Translator setting parameter value
is successfully retrieved, and E_FAIL otherwise
o GetDownloaderDir
-
Retrieves the OLP Translator Directory setting parameter value.
Role: The OLP Translator Directory setting parameter stores the full
file path to directory where OLP downloaders, also known as XSLT translators, are stored.
- Parameters:
-
- oDnldDir
- [inout] The OLP Translator Directory setting parameter value
- Returns:
- S_OK if the OLP Translator Directory setting parameter value
is successfully retrieved, and E_FAIL otherwise
o GetDownloaderDirInfo
-
Retrieves information about the OLP Translator Directory setting parameter.
Refer to
CATSysSettingController for a detailed description.
o GetDownloaderInfo
-
Retrieves information about the OLP Translator setting parameter.
Refer to
CATSysSettingController for a detailed description.
o GetExistingTaskTreatment
public virtual HRESULT GetExistingTaskTreatment( | int& | oVerdict) = 0 |
-
Retrieves the OLP Existing Task Treatment On Upload setting parameter value.
Role: The OLP Existing Task Treatment On Upload setting parameter
value determines how will the existing robot tasks with identical names as the
tasks to be uploaded be treated during upload.
- Parameters:
-
- oVerdict
- [inout] The OLP Existing Task Treatment On Upload setting parameter value.
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 |
- Returns:
- S_OK if the OLP Existing Task Treatment On Upload setting parameter value
is successfully retrieved, and E_FAIL otherwise
o GetExistingTaskTreatmentInfo
-
Retrieves information about the OLP Existing Task Treatment On Upload setting parameter.
Refer to
CATSysSettingController for a detailed description.
o GetJavaClassPath
-
Retrieves the OLP Java Class Path setting parameter value.
Role: The OLP Java Class Path setting parameter stores the full
file path to Java JAR files required to proper functioning of OLP download.
- Parameters:
-
- oJavaClassPath
- [inout] The OLP Java Class Path setting parameter value
- Returns:
- S_OK if the OLP Java Class Path setting parameter value
is successfully retrieved, and E_FAIL otherwise
o GetJavaClassPathInfo
-
Retrieves information about the OLP Java Class Path setting parameter.
Refer to
CATSysSettingController for a detailed description.
o GetJavaExe
-
Retrieves the OLP Java Executable setting parameter value.
Role: The OLP Java Executable setting parameter stores the full
file path to java.exe file of Java JRE 1_4_1, or later.
- Parameters:
-
- oJavaExe
- [inout] The OLP Java Executable setting parameter value
- Returns:
- S_OK if the OLP Java Executable setting parameter value
is successfully retrieved, and E_FAIL otherwise
o GetJavaExeInfo
-
Retrieves information about the OLP Java Executable setting parameter.
Refer to
CATSysSettingController for a detailed description.
o GetNRLDir
-
Retrieves the NRL Configuration File Directory setting parameter value.
Role: The NRL Configuration File Directory setting parameter stores the full
file path to directory where the NRL configuration files are stored.
- Parameters:
-
- oNRLDir
- [inout] The NRL Configuration File Directory setting parameter value
- Returns:
- S_OK if the NRL Configuration File Directory setting parameter value
is successfully retrieved, and E_FAIL otherwise
o GetNRLDirInfo
-
Retrieves information about the NRL Configuration File Directory setting parameter.
Refer to
CATSysSettingController for a detailed description.
o GetNRLTeachDialogDisplayMode
public virtual HRESULT GetNRLTeachDialogDisplayMode( | int& | oIsHidden) = 0 |
-
Retrieves the OLPNRLTeachDialogDisplayMode setting parameter value.
Role: OLPNRLTeachDialogDisplayMode setting parameter
value determines whether NRL Teach dialog will be displayed while creating and/or
V5 editing of RobotMotion activities.
- Parameters:
-
- oIsHidden
- [inout] The OLPNRLTeachDialogDisplayMode setting parameter value.
Legal values:
1 | NRL Teach dialog will be hidden |
0 | NRL Teach dialog will remain displayed |
- Returns:
- S_OK if the OLPNRLTeachDialogDisplayMode setting parameter value
is successfully retrieved, and E_FAIL otherwise
o GetNRLTeachDialogDisplayModeInfo
-
Retrieves information about the OLPNRLTeachDialogDisplayMode setting parameter.
Refer to
CATSysSettingController for a detailed description.
o GetRobotProgramDir
-
Retrieves the OLP Directory setting parameter value.
Role: The OLP Directory setting parameter stores the full
file path to directory where native robot language programs on upload should be stored.
- Parameters:
-
- oRobotProgramDir
- [inout] The OLP Directory setting parameter value
- Returns:
- S_OK if the OLP Directory setting parameter value
is successfully retrieved, and E_FAIL otherwise
o GetRobotProgramDirInfo
-
Retrieves information about the OLP Directory setting parameter.
Refer to
CATSysSettingController for a detailed description.
o GetUploader
-
Retrieves the OLP Parser setting parameter value.
Role: The OLP Parser setting parameter stores the name
of currently selected uploader, also known as the Java Parser.
- Parameters:
-
- oUploader
- [inout] The OLP Parser setting parameter value
- Returns:
- S_OK if the OLP Parser setting parameter value
is successfully retrieved, and E_FAIL otherwise
o GetUploaderDir
-
Retrieves the OLP Parser Directory setting parameter value.
Role: The OLP Parser Directory setting parameter stores the full
file path to directory where OLP uploaders, also known as Java Parsers, are stored.
- Parameters:
-
- oUpldDir
- [inout] The OLP Parser Directory setting parameter value
- Returns:
- S_OK if the OLP Parser Directory setting parameter value
is successfully retrieved, and E_FAIL otherwise
o GetUploaderDirInfo
-
Retrieves information about the OLP Parser Directory setting parameter.
Refer to
CATSysSettingController for a detailed description.
o GetUploaderInfo
-
Retrieves information about the OLP Parser setting parameter.
Refer to
CATSysSettingController for a detailed description.
o GetXMLDir
-
Retrieves the OLP XML Directory setting parameter value.
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.
- Parameters:
-
- oXMLDir
- [inout] The OLP XML Directory setting parameter value
- Returns:
- S_OK if the OLP XML Directory setting parameter value
is successfully retrieved, and E_FAIL otherwise
o GetXMLDirInfo
-
Retrieves information about the OLP XML Directory setting parameter.
Refer to
CATSysSettingController for a detailed description.
o GetXMLSchema
-
Retrieves the OLP XML Schema setting parameter value.
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.
- Parameters:
-
- oXMLSchema
- [inout] The OLP XML Schema setting parameter value
- Returns:
- S_OK if the OLP XML Schema setting parameter value
is successfully retrieved, and E_FAIL otherwise
o GetXMLSchemaInfo
-
Retrieves information about the OLP XML Schema setting parameter.
Refer to
CATSysSettingController for a detailed description.
o SetDownloader
-
Sets the OLP Translator setting parameter value.
- Parameters:
-
- iDownloader
- [in] The OLP Translator setting parameter value
- Returns:
- S_OK if the OLP Translator setting parameter value
is successfully set, and E_FAIL otherwise
o SetDownloaderDir
-
Sets the OLP Translator Directory setting parameter value.
- Parameters:
-
- iDnldDir
- [in] The OLP Translator Directory setting parameter value
- Returns:
- S_OK if the OLP Translator Directory setting parameter value
is successfully set, and E_FAIL otherwise
o SetDownloaderDirLock
public virtual HRESULT SetDownloaderDirLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the OLP Translator Directory setting parameter.
Refer to
CATSysSettingController for a detailed description.
o SetDownloaderLock
public virtual HRESULT SetDownloaderLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the OLP Translator setting parameter.
Refer to
CATSysSettingController for a detailed description.
o SetExistingTaskTreatment
public virtual HRESULT SetExistingTaskTreatment( | int& | iVerdict) = 0 |
-
Sets the OLP Existing Task Treatment On Upload setting parameter value.
Role: The OLP Existing Task Treatment On Upload setting parameter
value determines how will the existing robot tasks with identical names as the
tasks to be uploaded be treated during upload.
- Parameters:
-
- iVerdict
- [in] The OLP Existing Task Treatment On Upload setting parameter value.
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 |
- Returns:
- S_OK if the OLP Existing Task Treatment On Upload setting parameter value
is successfully set, and E_FAIL otherwise
o SetExistingTaskTreatmentLock
public virtual HRESULT SetExistingTaskTreatmentLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the OLP Existing Task Treatment On Upload setting parameter.
Refer to
CATSysSettingController for a detailed description.
o SetJavaClassPath
-
Sets the OLP Java Class Path setting parameter value.
- Parameters:
-
- iJavaClassPath
- [in] The OLP Java Class Path setting parameter value
- Returns:
- S_OK if the OLP Java Class Path setting parameter value
is successfully set, and E_FAIL otherwise
o SetJavaClassPathLock
public virtual HRESULT SetJavaClassPathLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the OLP Java Class Path setting parameter.
Refer to
CATSysSettingController for a detailed description.
o SetJavaExe
-
Sets the OLP Java Executable setting parameter value.
- Parameters:
-
- iJavaExe
- [in] The OLP Java Executable setting parameter value
- Returns:
- S_OK if the OLP Java Executable setting parameter value
is successfully set, and E_FAIL otherwise
o SetJavaExeLock
public virtual HRESULT SetJavaExeLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the OLP Java Executable setting parameter.
Refer to
CATSysSettingController for a detailed description.
o SetNRLDir
-
Sets the NRL Configuration File Directory setting parameter value.
- Parameters:
-
- iNRLDir
- [in] The NRL Configuration File Directory setting parameter value
- Returns:
- S_OK if the NRL Configuration File Directory setting parameter value
is successfully set, and E_FAIL otherwise
o SetNRLDirLock
public virtual HRESULT SetNRLDirLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the NRL Configuration File Directory setting parameter.
Refer to
CATSysSettingController for a detailed description.
o SetNRLTeachDialogDisplayMode
public virtual HRESULT SetNRLTeachDialogDisplayMode( | int& | iIsHidden) = 0 |
-
Sets the OLPNRLTeachDialogDisplayMode setting parameter value.
Role: OLPNRLTeachDialogDisplayMode setting parameter
value determines whether NRL Teach dialog will be displayed while creating and/or
V5 editing of RobotMotion activities.
- Parameters:
-
- oIsHidden
- [in] The OLPNRLTeachDialogDisplayMode setting parameter value.
Legal values:
1 | NRL Teach dialog will be hidden |
0 | NRL Teach dialog will remain displayed |
- Returns:
- S_OK if the OLPNRLTeachDialogDisplayMode setting parameter value
is successfully retrieved, and E_FAIL otherwise
o SetNRLTeachDialogDisplayModeLock
public virtual HRESULT SetNRLTeachDialogDisplayModeLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the OLPNRLTeachDialogDisplayMode setting parameter.
Refer to
CATSysSettingController for a detailed description.
o SetRobotProgramDir
-
Sets the OLP Directory setting parameter value.
- Parameters:
-
- iRobotProgramDir
- [in] The OLP Directory setting parameter value
- Returns:
- S_OK if the OLP Directory setting parameter value
is successfully set, and E_FAIL otherwise
o SetRobotProgramDirLock
public virtual HRESULT SetRobotProgramDirLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the OLP Directory setting parameter.
Refer to
CATSysSettingController for a detailed description.
o SetUploader
-
Sets the OLP Parser setting parameter value.
- Parameters:
-
- iUploader
- [in] The OLP Parser setting parameter value
- Returns:
- S_OK if the OLP Parser setting parameter value
is successfully set, and E_FAIL otherwise
o SetUploaderDir
-
Sets the OLP Parser Directory setting parameter value.
- Parameters:
-
- iUpldDir
- [in] The OLP Parser Directory setting parameter value
- Returns:
- S_OK if the OLP Parser Directory setting parameter value
is successfully set, and E_FAIL otherwise
o SetUploaderDirLock
public virtual HRESULT SetUploaderDirLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the OLP Parser Directory setting parameter.
Refer to
CATSysSettingController for a detailed description.
o SetUploaderLock
public virtual HRESULT SetUploaderLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the OLP Parser setting parameter.
Refer to
CATSysSettingController for a detailed description.
o SetXMLDir
-
Sets the OLP XML Directory setting parameter value.
- Parameters:
-
- iXMLDir
- [in] The OLP XML Directory setting parameter value
- Returns:
- S_OK if the OLP XML Directory setting parameter value
is successfully set, and E_FAIL otherwise
o SetXMLDirLock
public virtual HRESULT SetXMLDirLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the OLP XML Directory setting parameter.
Refer to
CATSysSettingController for a detailed description.
o SetXMLSchema
-
Sets the OLP XML Schema setting parameter value.
- Parameters:
-
- iXMLSchema
- [in] The OLP XML Schema setting parameter value
- Returns:
- S_OK if the OLP XML Schema setting parameter value
is successfully set, and E_FAIL otherwise
o SetXMLSchemaLock
public virtual HRESULT SetXMLSchemaLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the OLP XML Schema setting parameter.
Refer to
CATSysSettingController for a detailed description.
This object is included in the file: DNBIIgpOlpSettingAtt.h
If needed, your Imakefile.mk should include the module: DNBIgpOlpSettings