All Frameworks Class Hierarchy This Framework Indexes
KnowHow Interface CATIReportOptions
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIReportOptions
Interface dedicated to customizing the report of an expert check.
Role a report can be customized to let see only certain
t-uples or only certain checks, to be verbose or not, ... .
Method Index
- o
GetDescriptionLength()
- Gets the size of description (verbose or not).
- o
GetOutputFormat()
- Gets the output format (text, HTML, .
- o
GetReportPath()
- Gets the path where the report will be generated.
- o
GetShowResults()
- Gets the way the elements of the report are ordered.
- o
GetVisualizationType()
- Gets the visualization type.
- o
SetDescriptionLength(CATExpertReportEnum::DescriptionLengthEnum)
- Sets the size of description (verbose or not).
- o
SetOutputFormat(CATExpertReportEnum::OutputFormatEnum)
- Sets the output format (text, HTML, .
- o
SetReportPath(CATListOfCATUnicodeString&)
- Sets the path where the report will be generated.
- o
SetShowResults(CATExpertReportEnum::ShowResultsEnum)
- Sets the way the elements of the report are ordered.
- o
SetVisualizationType(CATExpertReportEnum::VisualizationTypeEnum)
- Sets the visualization type.
Methods
o GetDescriptionLength
| public virtual GetDescriptionLength( | ) |
-
Gets the size of description (verbose or not).
- Returns:
-
CATExpertReportEnum.DescriptionLengthEnum .
o GetOutputFormat
| public virtual GetOutputFormat( | ) |
-
Gets the output format (text, HTML, ...).
- Returns:
-
CATExpertReportEnum.OutputFormatEnum .
o GetReportPath
| public virtual GetReportPath( | ) |
-
Gets the path where the report will be generated.
- Returns:
- list with one string.
o GetShowResults
| public virtual GetShowResults( | ) |
-
Gets the way the elements of the report are ordered.
- Returns:
-
CATExpertReportEnum.ShowResultsEnum .
o GetVisualizationType
| public virtual GetVisualizationType( | ) |
-
Gets the visualization type.
- Returns:
-
CATExpertReportEnum.VisualizationTypeEnum .
o SetDescriptionLength
| public virtual SetDescriptionLength( | | iType) |
-
Sets the size of description (verbose or not).
- Parameters:
-
- iType
-
CATExpertReportEnum.DescriptionLengthEnum .
o SetOutputFormat
| public virtual SetOutputFormat( | | iType) |
-
Sets the output format (text, HTML, ...).
- Parameters:
-
- iType
-
CATExpertReportEnum.OutputFormatEnum .
o SetReportPath
| public virtual SetReportPath( | const | iListOfPath) |
-
Sets the path where the report will be generated.
- Parameters:
-
- iListOfPath
- list of strings (only the first one is useful).
o SetShowResults
| public virtual SetShowResults( | | iType) |
-
Sets the way the elements of the report are ordered.
- Parameters:
-
- iType
-
CATExpertReportEnum.ShowResultsEnum .
o SetVisualizationType
| public virtual SetVisualizationType( | | iType) |
-
Sets the visualization type.
- Parameters:
-
- iType
-
CATExpertReportEnum.VisualizationTypeEnum .
This object is included in the file: CATIReportOptions.h
If needed, your Imakefile.mk should include the module: CATKWERule