winIDEA SDK
isys::CConfigurationController Class Reference

Description

This class provides convenient access to the most popular options.

Methods of this class return instances of COptionController initialized with URL for specific winIDEA options, which can be used to get/set the options.

#include <CConfigurationController.h>

Inheritance diagram for isys::CConfigurationController:
isys::WrapperBase

Public Member Functions

SPOptionController ide_apps ()
 Returns COptionController for the applications configuration node. More...
 
SPOptionController ide_app (const std::string &rstrName="")
 Returns COptionController for the application configuration node with specified name. More...
 
SPOptionController ide_app_files (const std::string &rstrName)
 Returns COptionController for the application configuration files node with the specified name. More...
 
SPOptionController ide_SoCs ()
 Returns COptionController for the SoCs configuration node. More...
 
SPOptionController ide_SoC (const std::string &rstrName="")
 Returns COptionController for the SoC configuration node with the specified name. More...
 
SPOptionController ide_SoC_files (const std::string &rstrSoCUserName)
 Returns COptionController for the list of download files for the given SoC name. More...
 
SPOptionController ide_test ()
 Returns COptionController for the test configuration node. More...
 
SPOptionController ide_ws ()
 Returns COptionController for the workspace configuration node. More...
 
SPOptionController ide_opt ()
 Returns COptionController for the options configuration node. More...
 
SPOptionController doc (const std::string &rstrFile)
 Returns COptionController for the document configuration node with specified name. More...
 
SPOptionController doc_an_triggers (SPOptionController spDoc)
 Returns COptionController for the analyzer triggers configuration node. More...
 
SPOptionController doc_an_trig_processes (SPOptionController spTrigger)
 Returns COptionController for the analyzer trigger processes configuration node. More...
 
SPOptionController doc_an_trig_process_profiler_data (SPOptionController spProcess)
 Returns COptionController for the analyzer trigger process (data) configuration node. More...
 
SPOptionController doc_an_trig_process_profiler_code (SPOptionController spProcess)
 Returns COptionController for the analyzer trigger process (code) configuration node. More...
 
SPOptionController doc_an_trig_process_profiler_OS (SPOptionController spProcess)
 Returns COptionController for the analyzer trigger process (OS) configuration node. More...
 
SPOptionController plugin_config (const std::string &rstrPluginURL)
 Returns COptionController for the plugin configuration node. More...
 
SPOptionController prototype (const std::string &rstrPrototypeDomain)
 Returns COptionController for the prototype configuration node. More...
 

Member Function Documentation

◆ doc()

SPOptionController isys::CConfigurationController::doc ( const std::string &  rstrFile)

Returns COptionController for the document configuration node with specified name.

See COptionController.URL() to get the exact URL.

Parameters
rstrFiledocument file name
Returns
COptionController

Python example: test_doc.py

◆ doc_an_trig_process_profiler_code()

SPOptionController isys::CConfigurationController::doc_an_trig_process_profiler_code ( SPOptionController  spProcess)

Returns COptionController for the analyzer trigger process (code) configuration node.

See COptionController.URL() to get the exact URL.

Parameters
spProcessprocess COptionController obtained from doc_an_trig_processes
Returns
COptionController

Python example: test_doc_an_trig_process_profiler_code.py

◆ doc_an_trig_process_profiler_data()

SPOptionController isys::CConfigurationController::doc_an_trig_process_profiler_data ( SPOptionController  spProcess)

Returns COptionController for the analyzer trigger process (data) configuration node.

See COptionController.URL() to get the exact URL.

Parameters
spProcessprocess COptionController obtained from doc_an_trig_processes
Returns
COptionController

Python example: test_doc_an_trig_process_profiler_data.py

◆ doc_an_trig_process_profiler_OS()

SPOptionController isys::CConfigurationController::doc_an_trig_process_profiler_OS ( SPOptionController  spProcess)

Returns COptionController for the analyzer trigger process (OS) configuration node.

See COptionController.URL() to get the exact URL.

Parameters
spProcessprocess COptionController obtained from doc_an_trig_processes
Returns
COptionController

Python example: test_doc_an_trig_process_profiler_os.py

◆ doc_an_trig_processes()

SPOptionController isys::CConfigurationController::doc_an_trig_processes ( SPOptionController  spTrigger)

Returns COptionController for the analyzer trigger processes configuration node.

See COptionController.URL() to get the exact URL.

Parameters
spTriggertrigger COptionController obtained from doc_an_triggers
Returns
COptionController

Python example: test_doc_an_trig_process.py

◆ doc_an_triggers()

SPOptionController isys::CConfigurationController::doc_an_triggers ( SPOptionController  spDoc)

Returns COptionController for the analyzer triggers configuration node.

See COptionController.URL() to get the exact URL.

Parameters
spDocdocument COptionController returned from doc
Returns
COptionController

Python example: test_doc_an_trig.py

◆ ide_app()

SPOptionController isys::CConfigurationController::ide_app ( const std::string &  rstrName = "")

Returns COptionController for the application configuration node with specified name.

See COptionController.URL() to get the exact URL.

Parameters
rstrNameapplication name
Returns
COptionController

Python example: test_ide_app.py

◆ ide_app_files()

SPOptionController isys::CConfigurationController::ide_app_files ( const std::string &  rstrName)

Returns COptionController for the application configuration files node with the specified name.

See COptionController.URL() to get the exact URL.

Parameters
rstrNameapplication name
Returns
COptionController

Python example: test_ide_app_files.py

◆ ide_apps()

SPOptionController isys::CConfigurationController::ide_apps ( )

Returns COptionController for the applications configuration node.

See COptionController.URL() to get the exact URL.

Returns
COptionController

Python example: test_ide_apps.py

◆ ide_opt()

SPOptionController isys::CConfigurationController::ide_opt ( )

Returns COptionController for the options configuration node.

See COptionController.URL() to get the exact URL.

Returns
COptionController

Python example: test_ide_opt.py

◆ ide_SoC()

SPOptionController isys::CConfigurationController::ide_SoC ( const std::string &  rstrName = "")

Returns COptionController for the SoC configuration node with the specified name.

See COptionController.URL() to get the exact URL.

Parameters
rstrNameSoC name
Returns
COptionController

Python example: test_ide_soc.py

◆ ide_SoC_files()

SPOptionController isys::CConfigurationController::ide_SoC_files ( const std::string &  rstrSoCUserName)

Returns COptionController for the list of download files for the given SoC name.

Use COptionController.URL() of the returned object to get URL, which can be used in winIDEA Display Options dialog to find available settings.

Parameters
rstrSoCUserNameSoC name. Search for SoCs and option UserName in winIDEA Display options dialog to see available SoC names.
Returns
COptionController

Python example: test_ide_soc_files.py

◆ ide_SoCs()

SPOptionController isys::CConfigurationController::ide_SoCs ( )

Returns COptionController for the SoCs configuration node.

See COptionController.URL() to get the exact URL.

Returns
COptionController

Python example: test_ide_socs.py

◆ ide_test()

SPOptionController isys::CConfigurationController::ide_test ( )

Returns COptionController for the test configuration node.

See COptionController.URL() to get the exact URL.

Returns
COptionController

Python example: test_ide_test.py

◆ ide_ws()

SPOptionController isys::CConfigurationController::ide_ws ( )

Returns COptionController for the workspace configuration node.

See COptionController.URL() to get the exact URL.

Returns
COptionController

Python example: test_ide_ws.py

◆ plugin_config()

SPOptionController isys::CConfigurationController::plugin_config ( const std::string &  rstrPluginURL)

Returns COptionController for the plugin configuration node.

See COptionController.URL() to get the exact URL.

Returns
COptionController

Python example: test_plugin_config.py

◆ prototype()

SPOptionController isys::CConfigurationController::prototype ( const std::string &  rstrPrototypeDomain)

Returns COptionController for the prototype configuration node.

See COptionController.URL() to get the exact URL.

Parameters
rstrPrototypeDomain- the prototype domain, e.g. "SFR"
Returns
COptionController