|
winIDEA SDK
|
This class contains information about type of contents and format of the file, which will contain exported coverage data.
#include <CCoverageController2.h>
Inherits std::enable_shared_from_this< CCoverageExportConfig >.
Public Member Functions | |
| CCoverageExportConfig () | |
| Constructs object with default settings, as described with each method. More... | |
| std::string | getComment () const |
| Returns comment. More... | |
| std::string | getDescription () const |
| Returns human description of measurement. More... | |
| std::string | getFileName () const |
| Returns coverage file name. | |
| std::string | getFormatVariant () const |
| Returns variant of the selected format to use for export. | |
| std::string | getFunctionsFilter () const |
| Returns filter for functions. | |
| std::string | getHardware () const |
| Returns description of hardware used for measurement. More... | |
| std::string | getModulesFilter () const |
| Returns filter for modules. | |
| std::string | getSoftware () const |
| Returns description of software used for measurement. More... | |
| std::string | getTestId () const |
| Returns test ID. More... | |
| bool | isExportAsm () const |
| Returns true, if assembler info in source line order should be exported. More... | |
| bool | isExportFunctionAsm () const |
| Returns true, if assembler info in address order should be exported. More... | |
| bool | isExportFunctionLines () const |
| Returns true, if function lines should be exported. | |
| bool | isExportFunctions () const |
| Returns true, if functions should be exported. | |
| bool | isExportModuleLines () const |
| Returns true, if lines in modules (source files) should be exported. | |
| bool | isExportModules () const |
| Returns true, if modules (source files) should be exported. | |
| bool | isExportRange () const |
| Returns true, if range info should be exported. | |
| bool | isExportSources () const |
| Returns true, if complete source files should be exported. | |
| bool | isLaunchViewer () const |
| Returns true, if viewer should be launched after export. | |
| CCoverageExportConfigSPtr | setComment (const std::string &comment) |
| Sets comment. More... | |
| CCoverageExportConfigSPtr | setDescription (const std::string &desc) |
| Sets human description of measurement. More... | |
| CCoverageExportConfigSPtr | setExportAsm (bool isExportAsm) |
If set to true, assembler coverage information is exported (default: false). More... | |
| CCoverageExportConfigSPtr | setExportFunctionAsm (bool isExportFunctionAsm) |
If set to true, assembler coverage information for function is exported (default: false). More... | |
| CCoverageExportConfigSPtr | setExportFunctionLines (bool isExportFunctionLines) |
If set to true, coverage of lines in functions is exported (default: false). | |
| CCoverageExportConfigSPtr | setExportFunctions (bool isExportFunctions) |
If set to true, function coverage is exported (default: true). | |
| CCoverageExportConfigSPtr | setExportModuleLines (bool isExportModuleLines) |
If set to true, coverage lines info in modules (source files) is exported (default: false). | |
| CCoverageExportConfigSPtr | setExportModules (bool isExportModules) |
If set to true, coverage of modules (source files) is exported (default: true). | |
| CCoverageExportConfigSPtr | setExportRanges (bool isExportRanges) |
If set to true, range coverage information is exported (default: false). | |
| CCoverageExportConfigSPtr | setExportSources (bool isExportSources) |
If set to true, complete source files with coverage info are exported (including lines without generated object code) (default: false). | |
| CCoverageExportConfigSPtr | setFileName (const std::string &fileName) |
| Sets the name of the exported file or folder name for HTML export. More... | |
| CCoverageExportConfigSPtr | setFormatter (CCoverageFormatBaseSPtr &formatter) |
| Sets formatter object, which configures export file format. More... | |
| CCoverageExportConfigSPtr | setFormatVariant (const std::string &formatVariant) |
| Sets variant of the export format. More... | |
| CCoverageExportConfigSPtr | setFunctionsFilter (const std::string &functionsFilter) |
| Defines wildcard expression for functions to be exported, for example: init_*. | |
| CCoverageExportConfigSPtr | setHardware (const std::string &hw) |
| Sets description of hardware used for measurement. More... | |
| CCoverageExportConfigSPtr | setLaunchViewer (bool isLaunchViewer) |
If set to true, launches the system default viewer for the specified document type after export, for example notepad for text documents (default: false). | |
| CCoverageExportConfigSPtr | setModulesFilter (const std::string &modulesFilter) |
| Defines wildcard expression for modules to be exported, for example: eval*.c. | |
| CCoverageExportConfigSPtr | setSoftware (const std::string &sw) |
| Sets description of software used for measurement. More... | |
| CCoverageExportConfigSPtr | setTestId (const std::string &testId) |
| Sets test ID. More... | |
| std::string | toString () |
| Returns contents of this object in human readable form. | |
| isys::CCoverageExportConfig::CCoverageExportConfig | ( | ) |
Constructs object with default settings, as described with each method.
Python example: test_coverage_all_code.py
| std::string isys::CCoverageExportConfig::getComment | ( | ) | const |
Returns comment.
This method returns empty string or string set by setComment(), not value from the document.
| std::string isys::CCoverageExportConfig::getDescription | ( | ) | const |
Returns human description of measurement.
This method returns empty string or string set by setDescription(), not value from the document.
| std::string isys::CCoverageExportConfig::getHardware | ( | ) | const |
Returns description of hardware used for measurement.
This method returns empty string or string set by setHardware(), not value from the document.
| std::string isys::CCoverageExportConfig::getSoftware | ( | ) | const |
Returns description of software used for measurement.
This method returns empty string or string set by setSoftware(), not value from the document.
| std::string isys::CCoverageExportConfig::getTestId | ( | ) | const |
Returns test ID.
This method returns empty string or string set by setTestId(), not value from the document.
| bool isys::CCoverageExportConfig::isExportAsm | ( | ) | const |
Returns true, if assembler info in source line order should be exported.
| bool isys::CCoverageExportConfig::isExportFunctionAsm | ( | ) | const |
Returns true, if assembler info in address order should be exported.
| CCoverageExportConfigSPtr isys::CCoverageExportConfig::setComment | ( | const std::string & | comment | ) |
Sets comment.
This information is written to exported file. If this method is not called, existing value in the document is preserved.
| CCoverageExportConfigSPtr isys::CCoverageExportConfig::setDescription | ( | const std::string & | desc | ) |
Sets human description of measurement.
This information is written to exported file. If this method is not called, existing value in the document is preserved.
| CCoverageExportConfigSPtr isys::CCoverageExportConfig::setExportAsm | ( | bool | isExportAsm | ) |
If set to true, assembler coverage information is exported (default: false).
Assembler information is given in source line order (some source lines may generate code at several address blocks ('for' loop, for example).
| CCoverageExportConfigSPtr isys::CCoverageExportConfig::setExportFunctionAsm | ( | bool | isExportFunctionAsm | ) |
If set to true, assembler coverage information for function is exported (default: false).
Assembler information is given in address order.
| CCoverageExportConfigSPtr isys::CCoverageExportConfig::setFileName | ( | const std::string & | fileName | ) |
Sets the name of the exported file or folder name for HTML export.
If this method is not called, or fileName is empty string, then the existing export file name in winIDEA is used.
| CCoverageExportConfigSPtr isys::CCoverageExportConfig::setFormatter | ( | CCoverageFormatBaseSPtr & | formatter | ) |
Sets formatter object, which configures export file format.
If this method is not called, XML formatter with default settings is used.
Example:
formatter = ic.CCoverageXMLExportFormat()
exportCfg.setFormatter(formatter)
| CCoverageExportConfigSPtr isys::CCoverageExportConfig::setFormatVariant | ( | const std::string & | formatVariant | ) |
Sets variant of the export format.
Usually there is only one variant, which can be selected with string 'default'. See coverage Export dialog if other variants exist.
| CCoverageExportConfigSPtr isys::CCoverageExportConfig::setHardware | ( | const std::string & | hw | ) |
Sets description of hardware used for measurement.
This information is written to exported file. If this method is not called, existing value in the document is preserved.
| CCoverageExportConfigSPtr isys::CCoverageExportConfig::setSoftware | ( | const std::string & | sw | ) |
Sets description of software used for measurement.
This information is written to exported file. If this method is not called, existing value in the document is preserved.
| CCoverageExportConfigSPtr isys::CCoverageExportConfig::setTestId | ( | const std::string & | testId | ) |
Sets test ID.
This information is written to exported file. If this method is not called, existing value in the document is preserved.