ReportRecording

class ReportRecording
PATH_ABS

The constant used to specify that the recording path is stored as absolute path.

Returns:

The constant

Return type:

int

PATH_REL_REPORT

The constant used to specify that the recording path is stored relative to the report database.

Returns:

The constant

Return type:

int

PATH_REL_WORKSPACE

The constant used to specify that the recording path is stored relative to the workspace used for the test.

Returns:

The constant

Return type:

int

SOURCE_FLAG_AUTOGENERATED

The bit flag used to indicate that the recording was automatically generated (e.g. by a trace analysis).

Returns:

The constant

Return type:

int

SOURCE_FLAG_STIMULATION

The bit flag used to indicate that the recording is originated from a stimulation package.

Returns:

The constant

Return type:

int

SOURCE_MANUAL

The constant used to specify that the recording was manually added.

Returns:

The constant

Return type:

int

SOURCE_RECORDING

The constant used to specify that the recording was recorded during the test.

Returns:

The constant

Return type:

int

SOURCE_TRACEANALYSIS

The constant used to specify that the recording was added by a trace analysis.

Returns:

The constant

Return type:

int

SOURCE_TRACEMERGE

The constant used to specify that the recording was added by a trace merge.

Returns:

The constant

Return type:

int

Clone()

Call this method if you want to use API-objects in multiple contexts, e.g. if you want to insert a specific test step in multiple blocks.

Returns:

A copy of this object

Return type:

ReportRecording

GetAbsolutePath()

Convenience method to get the absolute path to the recording file. Depending on the path type a base directory will be determined to make an absolute path:

Returns:

The absolute path

Return type:

str

GetMeasurementListFile()

Returns the measurement list file associated with this recording, if any.

Returns:

The measurement list file or an empty string if no file is associated.

Return type:

str

GetNameAndFormatDetails()

Returns the recording name and the format details (if set).

Returns:

The recording name and the format details as text of the form “<name> (<formatdetails>)” if format details are set else of the form “<name>”.

Return type:

str

GetNumber()

Returns the recording number.

Returns:

The recording number

Return type:

int

GetNumberOfMeasurementListFileSignals()

Returns the number of recorded signals defined in the measurement list file associated with this recording.

Returns:

The number of signals or 0 if no measurement list file is associated.

Return type:

int

GetOrigin()

Returns the origin, a text representation of ReportRecording.GetSource().

Returns:

The origin

Return type:

str

GetPath()

Returns the path to the recording file. The path can be absolute or relative. The path type can be read by calling GetPathType().

Returns:

The path

Return type:

str

GetPathType()

Returns how the path is to the recording is stored in the report.

Returns:

Can return the following constants:

Return type:

int

GetRecordingGroupName()

Returns the name of the recording group.

Returns:

The recording group name

Return type:

str

GetSignalGroupName()

Returns the name of the signal group.

Returns:

The signal group name

Return type:

str

GetSource()

Returns the source of the recording.

Returns:

Can return the following constants:

In combination with the flags:

Return type:

int

GetSyncDeltaT()

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

Returns:

The time offset deltaT. Will be None, if no synchronization was executed, but will default to 0.0 if this recording is reported by a trace analysis.

Return type:

float

GetType()

Returns the type of the recording, e.g. “CSV”.

Returns:

The type identifier

Return type:

str