Report API¶

Custom report generators may use this API to retrieve detailed test report information.

ReportApi¶

class ReportApi¶

Instance var CAT_TESTCASE:: 1
Instance var CAT_PROJECT:: 2
Instance var CAT_TRACEANALYSIS:: 8

AnalysePath(path)¶

Analyses whether the given path is a subpath of the report or database directory. If it is then a string and a relative path are returned. Otherwise None and the original path are returned. In both cases the ‘\’ separator is replaced by ‘/’.

Parameters:

path : str¶: path to analyse

Returns:

Result of the analysis

Return type:

tuple[str, str]

GetArtifacts()¶

Returns all artifacts that are referenced by any package in the report.

Returns:: A list of all artifacts.
Return type:: list[Artifact]

GetConfiguration()¶

Do not use with project reports.

Returns:: Configuration set during Package execution
Return type:: Configuration

GetDbDir()¶

Returns:: Directory of the database file
Return type:: str

GetDbFile()¶

Returns:: Path to the database file
Return type:: str

GetInfo()¶

Get an Info object that holds some general information about the database.

Returns:: General information
Return type:: Info

GetMainPackage()¶

Do not use with project reports.

Returns:: The main Package of a report
Return type:: Package

GetMainProject()¶

Returns:: The root project of a report
Return type:: Project | None

GetPackage(reportItem)¶

Parameters:

reportItem¶: A ReportItem that represents a Package

Returns:

A created Package object for the given ReportItem.

Return type:

Package

GetPatchInfo()¶

Returns a list of patch IDs, which where applied to the ecu.test that created the report.

Returns:: List of the ID of applied patches
Return type:: list[str]

GetReportDir()¶

Returns:: Target directory of the generated files
Return type:: str

GetResultBgColor(resultName)¶

Get a string representing the background color used for the given result string in RGB notation.

Parameters:

resultName : str¶: string name of the result, e.g. “SUCCESS” or “FAILED”

Returns:

The background color

Return type:

str

GetResultColor(resultName)¶

Get a string representing the result color of the given result string in RGB notation.

Parameters:

resultName : str¶: string name of the result, e.g. “SUCCESS” or “FAILED”

Returns:

The result color

Return type:

str

GetResultTxtColor(resultName)¶

Get a string representing the text color used for the given result string in RGB notation.

Parameters:

resultName : str¶: string name of the result, e.g. “SUCCESS” or “FAILED”

Returns:

The text color

Return type:

str

GetRootActivity()¶

Activity of the first element. On a project report it is the project name, otherwise empty.

Returns:: Name of the root project or an empty string
Return type:: str

GetSetting(name)¶

Returns the value of the specified setting name of the templates config.xml

Parameters:

name : str¶: settings name

Returns:

The settings value, None if there is no setting for the given name

Return type:

str | None

GetSrcColor(srcCategory, srcType, srcSubType)¶

Get a string representing the background color used to represent the given type of source in RGB notation.

Parameters:

srcCategory : int¶

Category of the source, one of

CAT_TESTCASE
CAT_PROJECT
CAT_TRACEANALYSIS

srcType : str¶

String representing the type of the source, e.g. “READ” or “WRITE”

srcSubType : str¶

UUID of a specific utility

Returns:

The background color

Return type:

str

GetSrcStyle(srcCategory, srcType, srcSubType)¶

Parameters:

srcCategory : int¶

Category of the source, one of

CAT_TESTCASE
CAT_PROJECT
CAT_TRACEANALYSIS

srcType : str¶

String representing the type of the source, e.g. “READ” or “WRITE”

srcSubType : str¶

UUID of a specific utility

Returns:

List of strings representing the style of the source

Return type:

list[str]

GetTemplateDir()¶

Returns:: Directory of the template of this report
Return type:: str

HasConfiguration()¶

Do not use with project reports.

Returns:: True if a configuration was set during the Package execution, otherwise False
Return type:: bool

IsFiltered(component)¶

Checks whether the component is filtered.

Parameters:

component : str¶: component name (Testcase, TraceAnalysis or Project)

Returns:

True if the component is filtered else False

Return type:

bool

IsProjectReport()¶

Returns:: True if the report is the result of a project execution, otherwise False
Return type:: bool

IsSet(name, value)¶

Checks whether the setting name from the templates config.xml is set to value.

Parameters:

name : str¶: settings name
value : str¶: expected value

Returns:

True if the value of the given setting is equal to the given value, otherwise False

Return type:

bool

IterItems()¶

Returns an iterator with exactly two items. The first item is a Configuration. The second item is either a Project (for a project report) or a Package (for a package report).

Return type:: Iterator[Configuration | Project | Package]

MakeAbsPath(path)¶

Joins the database directory with the given path

Parameters:

path : str¶: path to join

Returns:

An absolute path

Return type:

str

SetSetting(name, value)¶

Sets a setting of the templates config.xml

Parameters:

name : str¶: settings name
value : str¶: settings value

GetPackageScmInfo(reportItem)¶

Deprecated since version 2024.1: use ReportItem.GetPackageScmInfo()

Parameters:

reportItem¶: A ReportItem that represents a Package

Returns:

Information about the SCM

Return type:

tuple[str, str, str] | None

IterUserComments(reportItemId, recursive=False)¶

Deprecated since version 2024.1: use Package.IterUserComments() or ReportItem.IterUserComments()

Yield all ReportItemComment of the ReportItem with the given reportItemId. If recursive is True, comments of all children are yielded too. This can improve performance of reading all report comments significantly.

Parameters:

reportItemId : int¶: ID of the ReportItem
recursive : bool¶: If True, also comments of children are included.

Type:

recursive: bool

Return type:

Iterator[ReportItemComment]

Artifact¶

class Artifact¶

Represents an artifact that is shown in the package’s report summary “Artifacts” tab.

GetContext()¶

Returns the context of the artifact, e.g. test step.

Returns:: context of the artifact
Return type:: str | None

GetFileHash()¶

Returns the MD5 hashsum of the artifact if available.

Returns:: md5 hashsum
Return type:: str | None

GetFileName()¶

Returns the file name of the artifact.

Returns:: artifact name
Return type:: str | None

GetFilePath()¶

Returns the path/url of the artifact.

Returns:: artifact path/url
Return type:: str | None

GetId()¶

Returns Id of the artifact.

Returns:: Id of the artifact
Return type:: int | None

GetMainPackageReportItemId()¶

Returns the Id of the corresponding main report item (the main package item Id).

Returns:: report item Id
Return type:: int | None

Attribute¶

class Attribute¶

Represents attributes of a project, package, or test case

GetId()¶

Returns:: The ID of the attribute
Return type:: int

GetName()¶

Returns:: The name of the attribute
Return type:: str

GetOrigin()¶

Returns:: The origin of the attribute
Return type:: str

GetReportItemId()¶

Returns:: The ID of the report item
Return type:: int

GetValue()¶

Returns:: The value of the attribute
Return type:: str

Configuration¶

class Configuration¶

The Configuration represents information about the used test bench configuration and test configuration.

GetTestBenchConfiguration()¶

Returns:: The tbc which is used in the configuration
Return type:: TestBenchConfiguration | None

GetTestConfiguration()¶

Returns:: The tcf which is used in the configuration
Return type:: TestConfiguration | None

HasTestBenchConfiguration()¶

Returns:: True if the configuration has a tbc, otherwise False
Return type:: bool

HasTestConfiguration()¶

Returns:: True if the configuration has a tcf, otherwise False
Return type:: bool

class TestBenchConfiguration¶

The TestBenchConfiguration represents information about a test bench configuration.

PLibraryId¶

Returns:: The library ID of the Package
Return type:: str or None

GetId()¶

Returns:: The ID of the tbc
Return type:: int

GetLibraryId()¶

Returns:: The library ID of the Package
Return type:: str or None

GetName()¶

Returns:: The name of the tbc
Return type:: str

GetPath()¶

Returns:: The path of the tbc
Return type:: str

GetTbcId()¶

Returns:: The ID of the tbc
Return type:: int

GetTools()¶

Returns:: A list of all tools used in the tbc
Return type:: list<TbcTool>

HasTools()¶

Returns:: True if the test bench configuration has any tools, otherwise False
Return type:: bool

IterTools()¶

Returns:: An iterator of all tools in the configuration
Return type:: Iterator[TbcTool]

class TestConfiguration¶

The Tcf represents information about a test configuration.

PLibraryId¶

Returns:: The library ID of the Package
Return type:: str or None

GetDataDir()¶

Returns:: The data directory stored in the test configuration or the user-specific default data directory if the test configuration does not define a data directory
Return type:: str

GetEditor()¶

Returns:: The editor of the TCF
Return type:: str

GetId()¶

Returns:: The ID of the TCF
Return type:: int

GetLibraryId()¶

Returns:: The library ID of the Package
Return type:: str or None

GetName()¶

Returns:: The name of the TCF
Return type:: str

GetPath()¶

Returns:: The path of the TCF
Return type:: str

GetPkgDir()¶

Returns:: The Package directory stored in the test configuration or the user-specific default Package directory if the test configuration does not define a Package directory
Return type:: str

GetTcfId()¶

Returns:: The ID of the TCF
Return type:: int

GetTeststand()¶

Returns:: The name of the computer the TCF was created with
Return type:: str

abstractmethod HasBusConfigurations()¶

Returns:: True if the configuration has any bus configuration, otherwise False
Return type:: bool

abstractmethod HasConstFiles()¶

Returns:: True if the configuration has any constant files, otherwise False
Return type:: bool

abstractmethod HasDiagConfigurations()¶

Returns:: True if the configuration has any Diag configuration, otherwise False
Return type:: bool

abstractmethod HasEcuConfigurations()¶

Returns:: True if the configuration has any ECU configuration, otherwise False
Return type:: bool

abstractmethod HasEfsConfigurations()¶

Returns:: True if the configuration has any electrical failure simulation configuration, otherwise False
Return type:: bool

abstractmethod HasFunctionConfigurations()¶

Returns:: True if the configuration has any function configuration, otherwise False
Return type:: bool

abstractmethod HasModelConfigurations()¶

Returns:: True if the configuration has any model configuration, otherwise False
Return type:: bool

abstractmethod IterBusConfigurations()¶

Returns:: An iterator of all bus configurations
Return type:: Iterator[TcfBus]

abstractmethod IterConstFiles()¶

Returns:: An iterator of all constant files in the configuration
Return type:: Iterator[str]

abstractmethod IterDiagConfigurations()¶

Returns:: An iterator of all Diag configurations
Return type:: Iterator[TcfDiagEntity]

abstractmethod IterEcuConfigurations()¶

Returns:: An iterator of all ECU configurations
Return type:: Iterator[TcfEcu]

abstractmethod IterEfsConfigurations()¶

Returns:: An iterator of all electrical failure simulation configurations
Return type:: Iterator[TcfEfs]

abstractmethod IterFunctionConfigurations()¶

Returns:: An iterator of all function configurations
Return type:: Iterator[TcfFct]

abstractmethod IterMappingFiles()¶

Returns:: An iterator of all mapping files in the configuration
Return type:: Iterator[str]

abstractmethod IterModelConfigurations()¶

Returns:: An iterator of all model configurations
Return type:: Iterator[TcfModel]

class TcfBus¶

The TcfBus represents information about a bus used within a test configuration.

GetDbPath()¶

Returns:: The path to the bus database
Return type:: str

GetFbxChn()¶

Returns:: The fibex channel
Return type:: str or None

GetId()¶

Returns:: The ID of the bus
Return type:: str

GetTcfBusId()¶

Returns:: The ID of the bus
Return type:: int

GetTcfId()¶

Returns:: The ID of the TCF
Return type:: int

class TcfEcu¶

The TcfEcu represents information about an ECU used within a test configuration.

PDiagHSFZSettings¶

Returns:: The HSFZ settings as string
Return type:: str or None

GetA2lFile()¶

Returns:: The path to the A2L file
Return type:: str or None

GetDebugHex()¶

Returns:: The path to the HEX file
Return type:: str or None

GetDiagDoIpSettings()¶

Returns:: The DoIp settings as string
Return type:: str or None

GetDiagDoSoAdSettings()¶

Returns:: The DoSoAd settings as string
Return type:: str or None

GetDiagFrTpSettings()¶

Returns:: The FrTp settings as string
Return type:: str or None

GetDiagHSFZSettings()¶

Returns:: The HSFZ settings as string
Return type:: str or None

GetDiagIsoTpSettings()¶

Returns:: The IsoTp settings as string
Return type:: str or None

GetDiagPort()¶

Returns:: The name of the DiagPort
Return type:: str or None

GetDiagUDSSettings()¶

Returns:: The UDS settings as string
Return type:: str or None

GetDiagnosticDb()¶

Returns:: The path to the diagnostic db
Return type:: str or None

GetElf()¶

Raises:: ~tt.Error
Returns:: The path to the Elf file
Return type:: str or None

GetElfs()¶

Returns:: A string of all paths to the Elf files seperated by ‘;’
Return type:: str or None

GetHexFile()¶

Returns:: The path to the HEX file
Return type:: str or None

GetId()¶

Returns:: The ID of the ECU
Return type:: str

GetLogDatabase()¶

Returns:: The path to the log database
Return type:: str or None

GetLogFilterFile()¶

Returns:: The path to the log filter file
Return type:: str or None

GetLogilink()¶

Returns:: The path to the Logilink file
Return type:: str or None

GetSgbd()¶

Returns:: The path to the SGBD file
Return type:: str or None

GetSgbdVersion()¶

Gets the SGBD version. If the SGBD is unspecified, a string containing “unknown” is returned.

Returns:: A string containing the SGBD version or “unknown”.
Return type:: str

GetTcfEcuId()¶

Returns:: The ID of the ECU
Return type:: str

GetTcfId()¶

Returns:: The ID of the TCF
Return type:: int

class TcfEfs¶

The TcfEfs represents information about an electrical failure simulation used within a test configuration.

GetDb()¶

Returns:: The path to the database
Return type:: str

GetId()¶

Returns:: The ID of the EFS
Return type:: str

GetTcfEfsId()¶

Returns:: The ID of the EFS
Return type:: str

GetTcfId()¶

Returns:: The ID of the TCF
Return type:: int

class TcfExecution¶

The TcfExecution represents information about the execution configuration of a test configuration.

GetSimulationMode()¶

Returns:: The simulation mode
Return type:: str

GetTcfId()¶

Returns:: The ID of the TCF
Return type:: int

GetWaitAfterTeststep()¶

Returns:: The wait time after a test step
Return type:: float

class TcfFct¶

The TcfFct represents information about a function used by a test configuration.

GetCatalog()¶

Returns:: The catalog
Return type:: str

GetId()¶

Returns:: The ID of the Fct
Return type:: str

GetTcfFctId()¶

Returns:: The ID of the Fct
Return type:: str

GetTcfId()¶

Returns:: The ID of the TCF
Return type:: int

class TcfModel¶

The TcfModel represents information about a model used within a test configuration.

GetId()¶

Returns:: The textual ID of the model
Return type:: str

GetModel()¶

Returns:: The path to the model
Return type:: str

GetTcfId()¶

Returns:: The numeric ID of the TCF
Return type:: int

GetTcfModelId()¶

Returns:: The textual ID of the model
Return type:: str

GetTimebase()¶

Returns:: True if Port is set as timebase, otherwise False
Return type:: bool

GetVersion()¶

Returns:: The version of the model
Return type:: str

class TbcTool¶

The TbcTool represents information about a tool used within a test bench configuration.

GetLocation()¶

Returns:: The location of the tool
Return type:: str

GetName()¶

Returns:: The name of the tool
Return type:: str

GetPatches()¶

Returns:: The patches of the tool
Return type:: str

GetStatus()¶

Returns:: The status of the tool
Return type:: str

GetTbcId()¶

Returns:: The ID of the TBC
Return type:: int

GetTbcToolId()¶

Returns:: The ID of the tool
Return type:: str

GetVersion()¶

Returns:: The version of the tool
Return type:: str

Constant¶

class Constant¶

Represents a global constant.

GetDescription()¶

Returns:: The description of the global constant
Return type:: str

GetName()¶

Returns:: The name of the global constant
Return type:: str

GetOrigin()¶

Returns:: The origin of the global constant
Return type:: str

GetValue()¶

Returns:: The string representation of the value of the global constant
Return type:: str

Entities¶

class Entity¶

GetEntityId()¶

Returns:: The ID of the entity
Return type:: int

GetId()¶

Returns:: The ID of the entity
Return type:: int

GetName()¶

Returns:: The name of the entity
Return type:: str

GetReportItemId()¶

Returns:: The ID of the associated ReportItem
Return type:: int

GetType()¶

Returns the type name of the entity.

Returns:: The type name of the entity
Return type:: str

class ImageEntity¶

Represents an image.

GetData()¶

Returns:: Data bytes of the image. Can be None if the image is not embedded in the report and was not found!
Return type:: bytes or None

GetEntityId()¶

Returns:: The ID of the entity
Return type:: int

GetId()¶

Returns:: The ID of the entity
Return type:: int

GetImage()¶

Returns:: The image
Return type:: Image

GetName()¶

Returns:: The name of the entity
Return type:: str

GetReportItemId()¶

Returns:: The ID of the associated ReportItem
Return type:: int

GetType()¶

Returns the type name of the entity.

Returns:: The type name of the entity
Return type:: str

ToFile(path='.')¶

Saves the image to the given directory.

Parameters:

path : str¶: path to the directory in which the image should be saved

Raises:

ValueError – Image is not embedded in the report and was not found on file system.

Returns:

Path to the saved image

Return type:

str

class ImageExpectationEntity¶

Represents an image expectation.

GetActualImage()¶

Returns:: The actual image
Return type:: Image

GetEntityId()¶

Returns:: The ID of the entity
Return type:: int

GetExpectedImage()¶

Returns:: The expected image
Return type:: Image

GetId()¶

Returns:: The ID of the entity
Return type:: int

GetName()¶

Returns:: The name of the entity
Return type:: str

GetReportItemId()¶

Returns:: The ID of the associated ReportItem
Return type:: int

GetType()¶

Returns the type name of the entity.

Returns:: The type name of the entity
Return type:: str

class RecordingInfosEntity¶

The RecordingInfosEntity represents a table of recording infos (RecordingEntity).

GetCount()¶

Returns:: The number of entries
Return type:: int

GetEntityId()¶

Returns:: The ID of the entity
Return type:: int

GetId()¶

Returns:: The ID of the entity
Return type:: int

GetName()¶

Returns:: The name of the entity
Return type:: str

GetRecording(index)¶

Returns:: The referenced recording
Return type:: Recording

GetRecordingId(index)¶

Parameters:

index : int¶

Returns:

The ID of the recording at the given index

Return type:

int

GetReportItemId()¶

Returns:: The ID of the associated ReportItem
Return type:: int

GetStartTime(index)¶

Returns the first timestamp (of the original time axis) from which samples are read. Samples before this point will be skipped.

Parameters:

index : int¶

Returns:

The start time

Return type:

float

GetStopTime(index)¶

Returns the last timestamp (of the original time axis) up to which samples are read. Samples after this point will be skipped.

Parameters:

index : int¶

Returns:

The stop time

Return type:

float

GetSyncDeltaT(index)¶

Parameters:

index : int¶

Returns:

The time offset deltaT that is applied to the time axis. Defaults to None if no synchronization was executed.

Return type:

float or None

GetType()¶

Returns the type name of the entity.

Returns:: The type name of the entity
Return type:: str

class ProjectElementStatistic¶

Represents the project element statistic.

GetCountAndPercentageOfResultItem(item)¶

Gets the absolute count and percentage of Packages that have the specified result. If no Package has the given result, a tuple containing (0, 0.0) is returned.

Parameters:

item : str¶: The result for which the count and percentage shall be returned, e.g. tts.core.common.Constants.RESULT_ERROR

Returns:

Tuple consisting of the count and the percentage

Return type:

tuple[int, float]

GetCountOfResultItem(item)¶

Parameters:

item : str¶: The result for which the count shall be returned, e.g. tts.core.common.Constants.RESULT_ERROR

Returns:

The absolute count of Packages that have the specified result

Return type:

int

GetEntityId()¶

Returns:: The ID of the entity
Return type:: int

GetErrorCount()¶

Returns:: The count of all project elements with the result ‘ERROR’
Return type:: int

GetFailedCount()¶

Returns:: The count of all project elements with the result ‘FAILED’
Return type:: int

GetHeader()¶

Returns:: The header (first element of each column)
Return type:: list<str>

GetId()¶

Returns:: The ID of the entity
Return type:: int

GetInconCount()¶

Returns:: The count of all project elements with the result ‘INCONCLUSIVE’
Return type:: int

GetName()¶

Returns:: The name of the entity
Return type:: str

GetNoneCount()¶

Returns:: The count of all project elements with the result ‘NONE’
Return type:: int

GetNumberCols()¶

Returns:: The number of columns
Return type:: int

GetNumberRows()¶

Returns:: The number of rows
Return type:: int

GetPercentageOfResultItem(item)¶

Gets the percentage of Packages that have the specified result.

Parameters:

item : str¶: The result for which the precentage shall be returned, e.g. tts.core.common.Constants.RESULT_ERROR

Returns:

The percentage of Packages that have the specified result

Return type:

float

GetReportItemId()¶

Returns:: The ID of the associated ReportItem
Return type:: int

GetResult(row)¶

Parameters:

row : int¶: The index of the row

Returns:

The result of the given row

Return type:

str

GetResultCount(result)¶

Parameters:

result : str¶: The result string. One of ‘NONE’, ‘SUCCESS’,’INCONCLUSIVE’, ‘FAILED’ or ‘ERROR’, otherwise None.

Returns:

The count of all project elements with the specified result

Return type:

int

GetSuccessCount()¶

Returns:: The count of all project elements with the result ‘SUCCESS’
Return type:: int

GetTotalCount()¶

Returns:: The count of all project elements
Return type:: int

GetType()¶

Returns the type name of the entity.

Returns:: The type name of the entity
Return type:: str

GetValue(row, col)¶

Parameters:

row : int¶: The index of the row
col : int¶: The index of the column

Returns:

The string for the cell specified by row and column

Return type:

str or None

IterRowsWithResult()¶

Returns:: An iterator of all rows with a result
Return type:: generator<tuple<list<str>, str>>

class TableEntity¶

Represents a table.

GetCountAndPercentageOfResultItem(item)¶

Gets the absolute count and percentage of Packages that have the specified result. If no Package has the given result, a tuple containing (0, 0.0) is returned.

Parameters:

item : str¶: The result for which the count and percentage shall be returned, e.g. tts.core.common.Constants.RESULT_ERROR

Returns:

Tuple consisting of the count and the percentage

Return type:

tuple[int, float]

GetCountOfResultItem(item)¶

Parameters:

item : str¶: The result for which the count shall be returned, e.g. tts.core.common.Constants.RESULT_ERROR

Returns:

The absolute count of Packages that have the specified result

Return type:

int

GetEntityId()¶

Returns:: The ID of the entity
Return type:: int

GetHeader()¶

Returns:: The header (first element of each column)
Return type:: list<str>

GetId()¶

Returns:: The ID of the entity
Return type:: int

GetName()¶

Returns:: The name of the entity
Return type:: str

GetNumberCols()¶

Returns:: The number of columns
Return type:: int

GetNumberRows()¶

Returns:: The number of rows
Return type:: int

GetPercentageOfResultItem(item)¶

Gets the percentage of Packages that have the specified result.

Parameters:

item : str¶: The result for which the precentage shall be returned, e.g. tts.core.common.Constants.RESULT_ERROR

Returns:

The percentage of Packages that have the specified result

Return type:

float

GetReportItemId()¶

Returns:: The ID of the associated ReportItem
Return type:: int

GetResult(row)¶

Parameters:

row : int¶: The index of the row

Returns:

The result of the given row

Return type:

str

GetType()¶

Returns the type name of the entity.

Returns:: The type name of the entity
Return type:: str

GetValue(row, col)¶

Parameters:

row : int¶: The index of the row
col : int¶: The index of the column

Returns:

The string for the cell specified by row and column

Return type:

str or None

IterRowsWithResult()¶

Returns:: An iterator of all rows with a result
Return type:: generator<tuple<list<str>, str>>

class TextEntity¶

Represents a custom text.

GetEntityId()¶

Returns:: The ID of the entity
Return type:: int

GetId()¶

Returns:: The ID of the entity
Return type:: int

GetName()¶

Returns:: The name of the entity
Return type:: str

GetReportItemId()¶

Returns:: The ID of the associated ReportItem
Return type:: int

GetType()¶

Returns the type name of the entity.

Returns:: The type name of the entity
Return type:: str

GetValue()¶

Returns the string for the custom text.

Returns:: The string for the custom text
Return type:: str

class TraceArtifactEntity¶

The TraceArtifactEntity represents a table of recordings created by the trace analysis.

GetComment(index)¶

Parameters:

index : int¶

Returns:

Returns the comment of an artifact, if set.

Return type:

str or None

GetCount()¶

Returns:: The number of entries
Return type:: int

GetEntityId()¶

Returns:: The ID of the entity
Return type:: int

GetId()¶

Returns:: The ID of the entity
Return type:: int

GetName()¶

Returns:: The name of the entity
Return type:: str

GetRecording(index)¶

Parameters:

index : int¶

Returns:

The referenced recording

Return type:

Recording

GetRecordingId(index)¶

Parameters:

index : int¶

Returns:

The ID of the referenced recording

Return type:

int

GetReportItemId()¶

Returns:: The ID of the associated ReportItem
Return type:: int

GetSourceReportItem(index)¶

Parameters:

index : int¶

Returns:

The report item of the step that created the artifact. Can be None.

Return type:

ReportItem | None

GetSourceReportItemId(index)¶

Returns the report item ID of the trace step that created the artifact. None if no source is set. Better use GetSourceReportItem(index) directly.

Parameters:

index : int¶

Returns:

The report item ID of the trace step that created the artifact

Return type:

int or None

GetType()¶

Returns the type name of the entity.

Returns:: The type name of the entity
Return type:: str

IterItems()¶

Returns:: An iterator of all recordings returning a tuple containing recordingID, sourceReportItemID and comment
Return type:: generator<tuple<int, int, str>>

Image¶

class Image¶

Represents a ReportItem-Image.

GetBitmap()¶

Returns:: The bitmap
Return type:: wx.Bitmap

GetDepth()¶

Returns:: The color depth of the bitmap.
Return type:: int

GetHeight()¶

Returns:: The height of the image
Return type:: int

GetId()¶

Returns:: The ID of the image
Return type:: int

GetMaskColor()¶

Returns:: Mask-Color in CSS Hex e.g. #00FF00
Return type:: str

GetName()¶

Returns:: The name of the image
Return type:: str

GetSubTitle()¶

Returns:: The sub title of the image
Return type:: str

GetTitle()¶

Returns:: The title of the image
Return type:: str

GetWidth()¶

Returns:: The width of the mage
Return type:: int

Info¶

class Info¶

GetAppName()¶

Returns:: The name of the used application
Return type:: str

GetAppVersion()¶

Returns:: The version of the used application
Return type:: str

GetAuthor()¶

Returns:: The author of the info
Return type:: str

GetDbVersion()¶

Returns:: The version of the database
Return type:: int

GetDuration()¶

Returns:: The Duration of the info
Return type:: float

GetExecutionMode()¶

Returns:: The execution mode
Return type:: str

GetExecutionTime()¶

Returns:: The execution time
Return type:: datetime

GetId()¶

Returns:: The ID of the info
Return type:: int

GetInfoId()¶

Returns:: The ID of the info
Return type:: int

GetKeywordCatalog()¶

Returns:: The keyword catalog name or an empty string if no keyword catalog was present at test execution.
Return type:: str

GetProjectExecutionPath()¶

Returns the execution path in relation to the calling project if executed as separate subproject or the name of the project, if not executed separately.

Returns:: Path in the project execution stack
Return type:: str

GetResult()¶

Returns the result of the info

Returns:: The test result. One of - NONE - SUCCESS - INCONCLUSIVE - FAILED - ERROR
Return type:: str

GetSignature()¶

Returns:: The Signature of the info
Return type:: str

GetTeststand()¶

Returns:: Name of the computer the test was executed at
Return type:: str

GetTimeZoneUTCOffset()¶

Gets the UTC offset in seconds based on the time zone in which the test report was created. If the time zone is not specified in the report, None is returned.

Returns:: UTC offset in seconds or None
Return type:: int or None

GetTimeZoneUTCOffsetStr()¶

Gets a string which contains the UTC offset of the time zone in which the test report was created, e.g. “UTC +2:00”. If the time zone is not specified in the report, an empty string is returned.

Returns:: UTC offset as string or an empty string
Return type:: str

GetUUID()¶

Returns:: The UUID of the info
Return type:: UUID

MappingItem¶

class MappingItem¶

GetDescription()¶

Returns:: The description of the mapping item
Return type:: str

GetId()¶

Returns:: The ID of the mapping item
Return type:: int

GetMappingItemId()¶

Returns:: The ID of the mapping item
Return type:: int

GetName()¶

Returns:: The name of the mapping item
Return type:: str

GetOrigin()¶

Returns:: The origin of the mapping item
Return type:: str

GetParentId()¶

Returns:: The ID of the parent
Return type:: int

GetTarget()¶

Returns the path this mapping item is currently pointing at.

Returns:: Complete path to the destination test quantity
Return type:: str

GetType()¶

Returns:: Type of the mapping item
Return type:: str

GetUsedRaster()¶

Returns:: The used raster of the mapping item
Return type:: str

GetWantedRaster()¶

Returns:: The wanted raster of the mapping item
Return type:: str

IsForcedRaster()¶

Returns:: True if registration of the raster is enforced, otherwise False
Return type:: bool

IsGlobal()¶

Returns:: True if mapping item is global, otherwise False
Return type:: bool

Package¶

class AnalysisJobItem¶

GetMaxExecLevel()¶

Returns:: The maximum execution level
Return type:: int

GetOriginalResult()¶

Returns:: The original result verdict of the analysis job
Return type:: str

GetResult()¶

Returns:: The result verdict of the analysis job
Return type:: str

GetStimulationPackage()¶

This call is only valid for analysis jobs derived from analysis packages. For parameterized stimulations, the resulting Package object characterizes a particular parameter set.

Returns:: The invoked stimulation Package
Return type:: Package

GetTraceAnalysis()¶

Returns:: The ReportItem instance of the trace analysis. If the trace analysis has not been executed, None is returned.
Return type:: ReportItem

HasData()¶

Returns:: True when analysis job item has data, otherwise False
Return type:: bool

HasParams()¶

Returns:: Indicates whether the analysis job has input parameters
Return type:: bool

HasReturnValues()¶

Returns:: Indicates whether the analysis job has return values
Return type:: bool

IterParameterVariables()¶

Returns:: An iterator for the parameters. Each parameter is represented as a PackageParameterVariable instance. Their origin is always None.
Return type:: generator<PackageParameterVariable>

IterReturnVariables(stage='final')¶

Returns:: An iterator for all return variables. Each variable is represented as a PackageReturnVariable instance.
Return type:: generator<PackageReturnVariable>

IterTraceItems(excludeRefTa=False)¶

Returns:

An iterator for all trace items

Parameters:

excludeRefTa=False¶: If true, exclude items inside referenced trace analyses.

Return type:

generator<ReportItem>

IterUserComments(recursive=False)¶

Yield all ReportItemComment of the ReportItem. If recursive is True, comments of all children are yielded as well. This can improve performance of reading all report comments significantly.

Parameters:

recursive : bool¶: If True, also comments of children are included.

Type:

recursive: bool

Return type:

Iterator[ReportItemComment]

class Mapping¶

Represents a mapping item.

GetDescription()¶

Returns:: The description of the mapping item
Return type:: str

GetId()¶

Returns:: The ID of the mapping item
Return type:: int

GetMappingItemId()¶

Returns:: The ID of the mapping item
Return type:: int

GetName()¶

Returns:: The name of the mapping item
Return type:: str

GetOrigin()¶

Returns:: The origin of the mapping item
Return type:: str

GetParentId()¶

Returns:: The ID of the parent
Return type:: int

GetTarget()¶

Returns the path this mapping item is currently pointing at.

Returns:: Complete path to the destination test quantity
Return type:: str

GetType()¶

Returns:: Type of the mapping item
Return type:: str

GetUsedRaster()¶

Returns:: The used raster of the mapping item
Return type:: str

GetWantedRaster()¶

Returns:: The wanted raster of the mapping item
Return type:: str

HasSubMappings()¶

Returns:: Indicates weather the mapping has sub mappings
Return type:: bool

IsForcedRaster()¶

Returns:: True if registration of the raster is enforced, otherwise False
Return type:: bool

IsGlobal()¶

Returns:: True if mapping item is global, otherwise False
Return type:: bool

IterSubMappings()¶

Returns:: An iterator for all sub mappings
Return type:: generator<Mapping>

class Mappings¶

Represents package mappings.

IterMappings()¶

Returns:: An iterator for all mappings used by the package
Return type:: generator<Mapping>

class Package¶

This class represents a Package that was executed individually or called directly from a Project.

GetAbortCode()¶

Returns:: The abort code of the Package
Return type:: str

GetAbortComment()¶

Returns:: The abort comment of the Package
Return type:: str

GetAdditionalInfo()¶

Returns:: The additional info of the Package, if set
Return type:: str | None

GetArtifacts()¶

Returns all referenced artifacts.

Returns:: A list of all referenced artifacts.
Return type:: list[Artifact]

GetCallError()¶

Returns:: The call error of the Package
Return type:: str

GetComment()¶

Returns:: Comment of the Package
Return type:: str

GetDescription()¶

Returns:: The description of the Package
Return type:: str

GetDuration()¶

Returns:: The duration of the Package
Return type:: str or None

GetElementName()¶

Returns:: The name of the project component
Return type:: str

GetGlobalConstantsDefinedOnStart()¶

Returns:: The values that the global constants had at the start of the Package execution
Return type:: list[Constant]

GetHash()¶

Returns:: The hash of the Package
Return type:: str or None

GetId()¶

Returns:: The ID of the Package
Return type:: int or None

GetIsTestcase()¶

Returns the state of the test case flag.

Returns:: True if test case flag is enabled, otherwise False
Return type:: bool

GetLibraryId()¶

Returns:: The library ID of the Package
Return type:: str or None

GetLinkedTestManagementIds()¶

Returns:: The test management IDs which are contained in the revaluation comments
Return type:: list[str]

GetMappings()¶

Returns:: The mappings of the Package
Return type:: Mappings

GetName()¶

Returns:: The name of the Package.
Return type:: str

GetOriginalResult()¶

Returns:: The original result verdict of the report item
Return type:: str

GetParameterDescription(name)¶

Parameters:

name : str¶: Name of the parameter

Returns:

The description of the specified parameter

Return type:

str

GetParameterInitialValue(name)¶

Parameters:

name : str¶: Name of the parameter

Returns:

The initial value of the specified parameter.

Return type:

str

GetParameterNames()¶

Returns:: The names of all parameters
Return type:: list[str]

GetParameterOrigin(name)¶

Parameters:

name : str¶: Name of the parameter

Returns:

The origin of the parameter

Rytpe:

str

Return type:

str | None

GetParameterValue(name)¶

Parameters:

name : str¶: Name of the parameter

Returns:

The value of the specified parameter as string representation

Return type:

str

GetPath()¶

Returns:: The path of the Package
Return type:: str

GetPkgId()¶

Returns:: The ID of the Package
Return type:: int or None

GetRecordings()¶

Returns:: The recordings of the Package
Return type:: Recordings

GetReportItemId()¶

Returns:: The ID of the report item
Return type:: int

GetResult()¶

Returns:: The result of the project component
Return type:: str

GetReturnDescription(name)¶

Returns:: The description of the specified return
Return type:: str | None

GetReturnInitialValue(name)¶

Returns:: The initial value of the specified return
Return type:: str

GetReturnNames()¶

Returns:: The names of all returns of the current Package
Return type:: list[str]

GetReturnValue(name)¶

Returns:: The value of the specified return
Return type:: str

GetRevalComments()¶

Returns:: The revaluation comments of the current Package
Return type:: list<RevaluationComment>

GetRevalCommentsString()¶

Gets the revaluation comments of the current Package. The comments are combined to a single string with the pattern “Creator: Comment -> Revaluated result”. If no revaluation comments exists, an empty string is returned.

Returns:: A string representing the combined revaluation comments
Return type:: str

GetRevision()¶

Returns:: The revision of the Package
Return type:: str

GetSCMBranch()¶

Returns:: The SCM Branch of the Package
Return type:: str or None

GetSCMStatus()¶

Returns:: The SCM status of the Package
Return type:: str or None

GetSCMUrl()¶

Returns:: The SCM URL of the Package
Return type:: str or None

GetStimulationPackage(returnParamSets=True)¶

This call is only valid for analysis packages and returns the stimulation Package.

Note:

For older reports (before 2022.2) this method may return None if no trace analysis was executed.

Parameters:

returnParamSets : bool¶

Specifies, how to deal with stimulation parameter sets. If True, the parameter set that has been used to stimulate the execution of the analysis Package is returned.

If False, the stimulation Package itself is returned, which is of type ParameterizedPackage for parameterized stimulations.

Returns:

The stimulation Package. The default return value will be of type Package. If returnParamSets is False, it is possibly also of type ParameterizedPackage.

Return type:

Package or ParameterizedPackage

GetSubReportPath()¶

Returns the path to the trf subreport of the package.

Returns:: The path to the trf sub report or None if there is no sub report
Return type:: str

GetTestCase(excludeSubPackages=True)¶

Parameters:

excludeSubPackages : bool¶

Returns:

The test case of the Package

Return type:

TestCase

GetTestScriptId()¶

Returns:: The test script ID, if set
Return type:: str | None

GetTestmanagementId()¶

Returns:: The test management ID of the Package
Return type:: str or None

GetTime()¶

Returns:: The time of the Package
Return type:: datetime.datetime | None

GetTraceAnalyses()¶

Returns:: The trace analyses
Return type:: TraceAnalyses

GetUserReportData()¶

Returns:: The user defined report data. The data consists of name and a tuple consisting of value and description.
Return type:: dict[str, tuple[str, str]]

GetVersion()¶

Returns:: The version of the Package
Return type:: str

HasAnalysisJobs(excludeSubPackages=True)¶

Returns:: Indicates whether the Package has analysis jobs
Return type:: bool

HasAttributes()¶

Returns:: True if Package has any attributes, otherwise False
Return type:: bool

HasMappings()¶

Returns:: Indicates whether the Package has mappings
Return type:: bool

HasParams()¶

Returns:: True if Package has any parameters, otherwise False
Return type:: bool

HasRecordings()¶

Returns:: Indicates whether the Package has recordings
Return type:: bool

HasReturnValues()¶

Returns:: True if Package has any return values, otherwise False
Return type:: bool

HasRevalComments()¶

Returns:: Indicates whether the current Package has revaluation comments
Return type:: bool

HasTestCase()¶

Returns:: Indicates whether the Package has a test case
Return type:: bool

HasTraceAnalyses()¶

Returns:: Indicates whether the Package has trace analyses
Return type:: bool

IsAnalysisPackage()¶

Returns:: True if Package is an analysis Package, otherwise False
Return type:: bool

IsSkipped()¶

Returns:: Indicates whether the current Package was skipped by the user, e.g. by filtering or commenting out.
Return type:: bool

IsStimulationPackage()¶

Returns:: True if Package is a stimulation Package, otherwise False
Return type:: bool

IterAnalysisJobs(excludeSubPackages=True)¶

Parameters:

excludeSubPackages : bool¶: True when subPackages should be excluded, otherwise False

Returns:

An Iterator for the analysis jobs

Return type:

Iterator[AnalysisJobItem]

IterAttributes()¶

Returns:: An Iterator for the attributes
Return type:: Iterator[Attribute]

IterParameterVariables()¶

Returns:: An iterator for the parameters
Return type:: Iterator[PackageParameterVariable]

IterReturnVariables()¶

Gets an iterator for the return variables. Each variable is represented by a PackageReturnVariable instance containing the value the variable had after the execution of the test case and all analysis jobs. If the variable is written by multiple analysis jobs with different values, the value is set to ‘Inconsistent’.

Return type:: Iterator[PackageReturnVariable]

IterReturnVariablesAfterTest()¶

Return type:: Iterator[PackageReturnVariable]

IterUserComments(recursive=False)¶

Yield all ReportItemComment of the ReportItem. If recursive is True, comments of all children are yielded as well. This can improve performance of reading all report comments significantly.

Parameters:

recursive : bool¶: If True, also comments of children are included.

Type:

recursive: bool

Return type:

Iterator[ReportItemComment]

GetComponentName()¶

Deprecated since version 2024.1: Use GetElementName().

Returns:: The name of the project component
Return type:: str

class ParallelPackage¶

GetAbortCode()¶

Returns:: The abort code of the Package
Return type:: str

GetAbortComment()¶

Returns:: The abort comment of the Package
Return type:: str

GetAdditionalInfo()¶

Returns:: The additional info of the Package, if set
Return type:: str | None

GetCallError()¶

Returns:: The call error of the Package
Return type:: str

GetComment()¶

Returns:: Comment of the Package
Return type:: str

GetDescription()¶

Returns:: The description of the Package
Return type:: str

GetDuration()¶

Returns:: The duration of the Package
Return type:: str or None

GetElementName()¶

Returns:: The name of the project component
Return type:: str

GetGlobalConstantsDefinedOnStart()¶

Returns:: The values that the global constants had at the start of the Package execution
Return type:: list[Constant]

GetHash()¶

Returns:: The hash of the Package
Return type:: str or None

GetId()¶

Returns:: The ID of the Package
Return type:: int or None

GetIsTestcase()¶

Returns the state of the test case flag.

Returns:: True if test case flag is enabled, otherwise False
Return type:: bool

GetLibraryId()¶

Returns:: The library ID of the Package
Return type:: str or None

GetLinkedTestManagementIds()¶

Returns:: The test management IDs which are contained in the revaluation comments
Return type:: list[str]

GetMappings()¶

Returns:: The mappings of the Package
Return type:: Mappings

GetName()¶

Returns:: The name of the Package.
Return type:: str

GetOriginalResult()¶

Returns:: The original result verdict of the report item
Return type:: str

GetParameterDescription(name)¶

Parameters:

name : str¶: Name of the parameter

Returns:

The description of the specified parameter

Return type:

str

GetParameterInitialValue(name)¶

Parameters:

name : str¶: Name of the parameter

Returns:

The initial value of the specified parameter.

Return type:

str

GetParameterNames()¶

Returns:: The names of all parameters
Return type:: list[str]

GetParameterOrigin(name)¶

Parameters:

name : str¶: Name of the parameter

Returns:

The origin of the parameter

Rytpe:

str

Return type:

str | None

GetParameterValue(name)¶

Parameters:

name : str¶: Name of the parameter

Returns:

The value of the specified parameter as string representation

Return type:

str

GetPath()¶

Returns:: The path of the Package
Return type:: str

GetPkgId()¶

Returns:: The ID of the Package
Return type:: int or None

GetRecordings()¶

Returns:: The recordings of the Package
Return type:: Recordings

GetReportItemId()¶

Returns:: The ID of the report item
Return type:: int

GetResult()¶

Returns:: The result of the project component
Return type:: str

GetReturnDescription(name)¶

Returns:: The description of the specified return
Return type:: str | None

GetReturnInitialValue(name)¶

Returns:: The initial value of the specified return
Return type:: str

GetReturnNames()¶

Returns:: The names of all returns of the current Package
Return type:: list[str]

GetReturnValue(name)¶

Returns:: The value of the specified return
Return type:: str

GetRevalComments()¶

Returns:: The revaluation comments of the current Package
Return type:: list<RevaluationComment>

GetRevalCommentsString()¶

Returns:: A string representing the combined revaluation comments
Return type:: str

GetRevision()¶

Returns:: The revision of the Package
Return type:: str

GetSCMBranch()¶

Returns:: The SCM Branch of the Package
Return type:: str or None

GetSCMStatus()¶

Returns:: The SCM status of the Package
Return type:: str or None

GetSCMUrl()¶

Returns:: The SCM URL of the Package
Return type:: str or None

GetStimulationPackage(returnParamSets=True)¶

This call is only valid for analysis packages and returns the stimulation Package.

Note:

For older reports (before 2022.2) this method may return None if no trace analysis was executed.

Parameters:

returnParamSets : bool¶

Specifies, how to deal with stimulation parameter sets. If True, the parameter set that has been used to stimulate the execution of the analysis Package is returned.

If False, the stimulation Package itself is returned, which is of type ParameterizedPackage for parameterized stimulations.

Returns:

The stimulation Package. The default return value will be of type Package. If returnParamSets is False, it is possibly also of type ParameterizedPackage.

Return type:

Package or ParameterizedPackage

GetTestCase(excludeSubPackages=True)¶

Parameters:

excludeSubPackages : bool¶

Returns:

The test case of the Package

Return type:

TestCase

GetTestScriptId()¶

Returns:: The test script ID, if set
Return type:: str | None

GetTestmanagementId()¶

Returns:: The test management ID of the Package
Return type:: str or None

GetTime()¶

Returns:: The time of the Package
Return type:: datetime.datetime | None

GetTraceAnalyses()¶

Returns:: The trace analyses
Return type:: TraceAnalyses

GetUserReportData()¶

Returns:: The user defined report data. The data consists of name and a tuple consisting of value and description.
Return type:: dict[str, tuple[str, str]]

GetVersion()¶

Returns:: The version of the Package
Return type:: str

HasAnalysisJobs(excludeSubPackages=True)¶

Returns:: Indicates whether the Package has analysis jobs
Return type:: bool

HasAttributes()¶

Returns:: True if Package has any attributes, otherwise False
Return type:: bool

HasMappings()¶

Returns:: Indicates whether the Package has mappings
Return type:: bool

HasParams()¶

Returns:: True if Package has any parameters, otherwise False
Return type:: bool

HasRecordings()¶

Returns:: Indicates whether the Package has recordings
Return type:: bool

HasReturnValues()¶

Returns:: True if Package has any return values, otherwise False
Return type:: bool

HasRevalComments()¶

Returns:: Indicates whether the current Package has revaluation comments
Return type:: bool

HasTestCase()¶

Returns:: Indicates whether the Package has a test case
Return type:: bool

HasTraceAnalyses()¶

Returns:: Indicates whether the Package has trace analyses
Return type:: bool

IsAnalysisPackage()¶

Returns:: True if Package is an analysis Package, otherwise False
Return type:: bool

IsSkipped()¶

Returns:: Indicates whether the current Package was skipped by the user, e.g. by filtering or commenting out.
Return type:: bool

IsStimulationPackage()¶

Returns:: True if Package is a stimulation Package, otherwise False
Return type:: bool

IterAnalysisJobs(excludeSubPackages=True)¶

Parameters:

excludeSubPackages : bool¶: True when subPackages should be excluded, otherwise False

Returns:

An Iterator for the analysis jobs

Return type:

Iterator[AnalysisJobItem]

IterAttributes()¶

Returns:: An Iterator for the attributes
Return type:: Iterator[Attribute]

IterParameterVariables()¶

Returns:: An iterator for the parameters
Return type:: Iterator[PackageParameterVariable]

IterReturnVariables()¶

Return type:: Iterator[PackageReturnVariable]

IterReturnVariablesAfterTest()¶

Return type:: Iterator[PackageReturnVariable]

IterUserComments(recursive=False)¶

Yield all ReportItemComment of the ReportItem. If recursive is True, comments of all children are yielded as well. This can improve performance of reading all report comments significantly.

Parameters:

recursive : bool¶: If True, also comments of children are included.

Type:

recursive: bool

Return type:

Iterator[ReportItemComment]

GetComponentName()¶

Deprecated since version 2024.1: Use GetElementName().

Returns:: The name of the project component
Return type:: str

class Recording¶

Represents a recording.

GetMeasurementListFile()¶

Returns:: The measurement list file name
Return type:: str

GetNumberOfMeasurementListFileSignals()¶

Returns:: The number of signals in the measurement file that have been recorded
Return type:: int

GetOrigin()¶

Returns the origin, a text representation of the source field.

Returns:: The origin
Return type:: str

GetSignalGroupName()¶

Returns:: The signal group name
Return type:: str

GetSource()¶

The source bits. One of the constants SOURCE_RECORDING, SOURCE_TRACEANALYSIS, SOURCE_MANUAL, or SOURCE_TRACEMERGE in combination with the flags SOURCE_FLAG_STIMULATION, SOURCE_FLAG_AUTOGENERATED

Return type:: int

GetSyncDeltaT()¶

Returns the deltaT, calculated by the synchronization, that is applied to the time axis.

Return type:: str

IterMappings()¶

Returns:: Iterator of mappings
Return type:: generator<Mapping>

IterSignals()¶

Returns:: Iterator of signal names
Return type:: generator<str>

class Recordings¶

Represents recordings.

IterRecordings()¶

Returns:: An iterator for all recordnings
Return type:: generator<Recording>

class TestCase¶

GetMaxExecLevel()¶

Returns:: Maximum execution level
Return type:: int

GetResult()¶

Returns:: The string for the result of the test case.
Return type:: str

HasData()¶

Returns:: True when test case has data, otherwise False
Return type:: bool

IterTestSteps()¶

Returns:: The recursive iterator over report items of the test steps
Return type:: generator<ReportItem>

class TraceAnalyses¶

GetMaxExecLevel()¶

Returns:: The maximum execution level
Return type:: int

HasData()¶

Returns:: True when trace analyses have data, otherwise False
Return type:: bool

IterTraceItems(excludeRefTa=False)¶

Returns:

An iterator for all trace items

Parameters:

excludeRefTa=False¶: If true, exclude items inside referenced trace analyses.

Return type:

generator<ReportItem>

ProjectElements¶

class ConfigChange¶

Represents a configuration change report item.

GetAdditionalInfo()¶

Returns:: The additional info of the ReportItem
Return type:: str

GetComment()¶

Returns:: The comment of the ReportItem
Return type:: str

GetDuration()¶

Returns:: The duration of the project component
Return type:: str

GetElementName()¶

Returns:: The name of the project component
Return type:: str

GetName()¶

Returns:: The name of the project component
Return type:: str

GetOriginalResult()¶

Returns:: The original result of the project component
Return type:: str

GetReportItemId()¶

Returns:: The ID of the report item
Return type:: int

GetResult()¶

Returns:: The result of the project component
Return type:: str

GetSrcType()¶

Returns the type of the ReportItem, e.g.

‘PACKAGE’
‘PROJECT’
‘CALCULATION’
‘TRACE-ANALYSIS’
‘EPISODE’
‘TRACESTEP’
‘TRIGGERBLOCK’
‘PLOTITEM’

Returns:: The type of the ReportItem
Return type:: str

GetStatistic()¶

Returns:: The statistic of the ReportItem
Return type:: ProjectElementStatistic

GetTestBenchConfiguration()¶

Returns:: The tbc which is used in the configuration
Return type:: TestBenchConfiguration | None

GetTestConfiguration()¶

Returns:: The tcf which is used in the configuration
Return type:: TestConfiguration | None

GetTime()¶

Returns:: The time of the ReportItem
Return type:: datetime.datetime

HasTestBenchConfiguration()¶

Returns:: True if the configuration has a tbc, otherwise False
Return type:: bool

HasTestConfiguration()¶

Returns:: True if the configuration has a tcf, otherwise False
Return type:: bool

IsSkipped()¶

Returns:: True if the current ReportItem has not been executed by user definition (for example by filtering or commenting out).
Return type:: bool

IterItems(ignoreProjectViewFilter=False)¶

Returns:: The Project or its elements of type ProjectElement or Package.
Return type:: Project or ProjectElement or Package

IterUserComments(recursive=False)¶

Yield all ReportItemComment of the ReportItem. If recursive is True, comments of all children are yielded as well. This can improve performance of reading all report comments significantly.

Parameters:

recursive : bool¶: If True, also comments of children are included.

Type:

recursive: bool

Return type:

Iterator[ReportItemComment]

class Project¶

Represents a Project report item.

PLibraryId¶

Returns:: The library ID of the Package
Return type:: str or None

GetAdditionalInfo()¶

Returns:: The additional info of the ReportItem
Return type:: str

GetComment()¶

Returns:: The comment of the project element
Return type:: str

GetDuration()¶

Returns:: The duration of the project component
Return type:: str

GetElementName()¶

Returns:: The name of the project component
Return type:: str

GetLibraryId()¶

Returns:: The library ID of the Package
Return type:: str or None

GetName()¶

Returns:: The name of the project
Return type:: str

GetOriginalResult()¶

Returns:: The original result of the project component
Return type:: str

GetPrjCompName()¶

Returns:: The name of the project element
Return type:: str

GetPrjId()¶

Returns:: The project ID
Return type:: int or None

GetReportItemId()¶

Returns:: The ID of the report item
Return type:: int

GetResult()¶

Returns:: The result of the project component
Return type:: str

GetSrcType()¶

Returns the type of the ReportItem, e.g.

‘PACKAGE’
‘PROJECT’
‘CALCULATION’
‘TRACE-ANALYSIS’
‘EPISODE’
‘TRACESTEP’
‘TRIGGERBLOCK’
‘PLOTITEM’

Returns:: The type of the ReportItem
Return type:: str

GetStatistic()¶

Returns:: The statistic of the ReportItem
Return type:: ProjectElementStatistic

GetTestManagementId()¶

Returns:: The test management ID
Return type:: str

GetTime()¶

Returns:: The time of the ReportItem
Return type:: datetime.datetime

HasAttributes()¶

Returns:: True when the project has attributes, otherwise False
Return type:: bool

IsSkipped()¶

Returns:: True if the current ReportItem has not been executed by user definition (for example by filtering or commenting out).
Return type:: bool

IterAttributes()¶

Returns:: Iterator for the attributes of the project
Return type:: Iterator[Attribute]

IterItems(ignoreProjectViewFilter=False)¶

Returns:: The Project or its elements of type ProjectElement or Package.
Return type:: Project or ProjectElement or Package

IterUserComments(recursive=False)¶

Yield all ReportItemComment of the ReportItem. If recursive is True, comments of all children are yielded as well. This can improve performance of reading all report comments significantly.

Parameters:

recursive : bool¶: If True, also comments of children are included.

Type:

recursive: bool

Return type:

Iterator[ReportItemComment]

class ProjectElement¶

GetAdditionalInfo()¶

Returns:: The additional info of the ReportItem
Return type:: str

GetComment()¶

Returns:: The comment of the ReportItem
Return type:: str

GetDuration()¶

Returns:: The duration of the project component
Return type:: str

GetElementName()¶

Returns:: The name of the project component
Return type:: str

GetName()¶

Returns:: The name of the project component
Return type:: str

GetOriginalResult()¶

Returns:: The original result of the project component
Return type:: str

GetReportItemId()¶

Returns:: The ID of the report item
Return type:: int

GetResult()¶

Returns:: The result of the project component
Return type:: str

GetSrcType()¶

Returns the type of the ReportItem, e.g.

‘PACKAGE’
‘PROJECT’
‘CALCULATION’
‘TRACE-ANALYSIS’
‘EPISODE’
‘TRACESTEP’
‘TRIGGERBLOCK’
‘PLOTITEM’

Returns:: The type of the ReportItem
Return type:: str

GetStatistic()¶

Returns:: The statistic of the ReportItem
Return type:: ProjectElementStatistic

GetTime()¶

Returns:: The time of the ReportItem
Return type:: datetime.datetime

IsSkipped()¶

Returns:: True if the current ReportItem has not been executed by user definition (for example by filtering or commenting out).
Return type:: bool

IterItems(ignoreProjectViewFilter=False)¶

Returns:: The Project or its elements of type ProjectElement or Package.
Return type:: Project or ProjectElement or Package

IterUserComments(recursive=False)¶

Yield all ReportItemComment of the ReportItem. If recursive is True, comments of all children are yielded as well. This can improve performance of reading all report comments significantly.

Parameters:

recursive : bool¶: If True, also comments of children are included.

Type:

recursive: bool

Return type:

Iterator[ReportItemComment]

ReportItems¶

class ReportItem¶

A report item represents the execution results of one test step. It contains information like test step number, time of execution, type of test step and custom fields. Furthermore additional information on a test step can be stored in so called entity elements being attached to the respective report item (e.g. TableEntity or TextEntity).

Class var CAT_TESTCASE:: 1
Class var CAT_PROJECT:: 2
Class var CAT_TRACEANALYSIS:: 3

GetAbortCode()¶

Returns:: The abort code of the report item
Return type:: str

GetAbortComment()¶

Returns:: The abort comment of the report item
Return type:: str

GetAbsoluteTimestamp()¶

Returns:: The value of the timestamp field
Return type:: float or None

GetAdditionalInfo()¶

Returns:: The string for the additional info field
Return type:: str

GetComment()¶

Returns:: The string for the comment field
Return type:: str

GetDuration()¶

Returns:: The value of the duration field
Return type:: float | None

GetElementaryResult()¶

Returns:: True if the result is elementary, otherwise False
Return type:: bool

GetExecLevel()¶

Returns:: The execution level
Return type:: int

GetId()¶

Returns:: The ID of the report item
Return type:: int

GetImageKey()¶

Returns:: The image key
Return type:: int

GetInfo()¶

Depending on the category of the report item the info field corresponds to the following columns in the test report:

CAT_TESTCASE: the value of the Value column.
CAT_PROJECT: the value of the Value column.
CAT_TRACEANALYSIS: the value of the Parameter column.

Returns:: The string for the info field
Return type:: str

GetLabel()¶

Corresponds to the Action/Name column in the test report.

Returns:: The string for the label field
Return type:: str

GetLinkedTestManagementIds()¶

Returns:: The test management IDs which are contained in the revaluation comments
Return type:: list<str>

GetLoopCycle()¶

Returns:: The loop cycle
Return type:: str or None

GetName()¶

ReportItems of category CAT_TRACEANALYSIS use the name field to store the signal binding informations. It corresponds to the Generic signals column in the test report. For ReportItems of other categories use GetLabel() for a briefer representation.

Returns:: The string for the name field
Return type:: str

GetOriginalResult()¶

Returns:: String of the original result field
Return type:: str

GetParentId()¶

Returns:: The ID of the parent report item
Return type:: int

GetPos()¶

Returns:: The position in the report
Return type:: int

GetRelativeRealtime()¶

Returns:: The value of the relative_realtime field
Return type:: float or None

GetRelativeTimestamp()¶

Returns:: The value of the timestamp_relative field
Return type:: float or None

GetReportItemId()¶

Returns:: The ID of the report item
Return type:: int

GetResult()¶

Returns:: The string for the result field
Return type:: str or None

GetRevalComments()¶

Returns:: The revaluation comments of the current report item
Return type:: list< RevaluationComment >

GetRevalCommentsString()¶

Gets the revaluation comments of the current report item. The comments are combined to a single string with the pattern “Creator: Comment -> Revaluated result”. If no revaluation comments exists, an empty string is returned.

Returns:: A string representing the combined revaluation comments
Return type:: str

GetSrc()¶

Returns:: The name of the source report item
Return type:: str or None

GetSrcCategory()¶

Returns:

The category of the source, one of

CAT_TESTCASE
CAT_PROJECT
CAT_TRACEANALYSIS

Return type:

int or None

GetSrcIndex()¶

Returns:: The string for the index field
Return type:: str

GetSrcSubType()¶

Returns:: UUID of a specific Utility
Return type:: str or None

GetSrcType()¶

Returns the type of the ReportItem, e.g.

‘PACKAGE’
‘PROJECT’
‘CALCULATION’
‘TRACE-ANALYSIS’
‘EPISODE’
‘TRACESTEP’
‘TRIGGERBLOCK’
‘PLOTITEM’

Returns:: The type of the ReportItem
Return type:: str or None

GetTargetValue()¶

Corresponds to the Expected value column in the test report.

Returns:: The string for the target value field
Return type:: str

GetUndocumentedChild()¶

Returns:: True if the item has undocumented children, otherwise False
Return type:: bool

HasRevalComments()¶

Returns:: True when the current report item has revaluation comments, otherwise False
Return type:: bool

IsSkipped()¶

Returns:: True when the report item was skipped by the user, e.g. by filtering or commenting out, otherwise False
Return type:: bool

GetActivity()¶

Deprecated since version 6.4: Name and Activity are to be replaced by Label

Returns:: The string for the activity field
Return type:: str

class ReportItemAnalysisInfo¶

GetImplementedAnalysisLabel()¶

Returns:: The analysis label that is implemented by the analysis package
Return type:: str | None

GetReportItemId()¶

Returns:: The report item id to which the information belongs to
Return type:: int

GetStimParamReportItemId()¶

Returns:: The report item id of the specific parameter set of the stimulation package if there is one.
Return type:: int | None

GetStimReportItemId()¶

Returns:: The report item id of the stimulation package
Return type:: int | None

IsRequested()¶

Returns:: Indicates whether the analysis label was requested by the stimulation package
Return type:: bool

class ReportItemComment¶

GetAuthor()¶

Returns:: The author of the comment
Return type:: str

GetId()¶

Returns:: The ID of the comment
Return type:: int | None

GetOverriddenResult()¶

Returns:: The overridden result
Return type:: str | None

GetReportItemId()¶

Returns:: The ID of the report item
Return type:: int

GetText()¶

Returns:: The comment text
Return type:: str

GetTimestamp()¶

Returns:: The timestamp or the absolute timestamp
Return type:: float

class RevaluationComment¶

GetAuthor()¶

Returns:: The author of the revaluation comment
Return type:: str

GetResult()¶

Returns:: The revaluated result or None
Return type:: str or None

GetText()¶

Returns:: Text of the revaluation comment
Return type:: str

GetTime()¶

Returns:: Creation date and time of the revaluation comment
Return type:: float

Variables¶

class PackageParameterVariable¶

The Variable represents a test case parameter variable used in a Package.

GetDescription()¶

Returns:: The description of the variable
Return type:: str

GetName()¶

Returns:: The name of the variable
Return type:: str

GetOrigin()¶

Returns:: A text representing the origin of the parameter
Return type:: str

GetValue()¶

Returns:: The value of the variable as string representation
Return type:: str

class PackageReturnVariable¶

The Variable represents a return variable used in a Package.

GetDescription()¶

Returns:: The description of the variable
Return type:: str

GetName()¶

Returns:: The name of the variable
Return type:: str

GetValue()¶

Returns:: The value of the variable as string representation
Return type:: str

class PackageVariable¶

Represents a test case variable used in a Package.

GetDescription()¶

Returns:: The description of the variable
Return type:: str

GetName()¶

Returns:: The name of the variable
Return type:: str

GetValue()¶

Returns:: The value of the variable as string representation
Return type:: str