RecordingInfo¶
- class RecordingInfo¶
Returned by
- 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:
- DeleteFormatDetails()¶
Deletes the format details of the existing recording.
- GetFormatDetailsString()¶
Returns the recording type specific format details as string.
- Returns:
The format details as string, None if there aren’t any format details
- Return type:
str
- GetPath()¶
Returns the path (or the first path if there is a list of paths) for the recording.
- Returns:
The path
- Return type:
str
- GetPathList()¶
Returns the list of paths of the recording as a sequence of multiple files.
- Returns:
The list of paths
- Return type:
list[str]
- GetRecordingName()¶
Returns the name of the recording.
- Returns:
The name
- Return type:
str
- GetRecordingNumber()¶
Returns the recording number.
- Returns:
The recording number
- Return type:
int
- GetRecordingType()¶
Returns the recording type as string.
- Returns:
The recording type, e.g. ‘CSV’, ‘MDF_VECTOR’
- Return type:
str
- GetStartTime()¶
Returns the first time stamp to be read in from the recording.
- Raises:
ApiError – Underlying data value can not be returned as float.
- Returns:
First time stamp to be read in from the recording
- Return type:
float
- GetStopTime()¶
Returns the last time stamp to be read in from the recording.
- Raises:
ApiError – Underlying data value can not be returned as float.
- Returns:
Last time stamp to be read in from the recording
- Return type:
float
- GetSyncDeltaT()¶
Get the time axis shift determined by the synchronization.
- Note:
Only use in the context of a analysis job.
- Returns:
Shift of time axis determined by the synchronization or None, when no synchronization information exists.
- Return type:
float
- SetFormatDetailsString(formatDetails)¶
Sets the format details of the existing recording. If the file of this recording info exists, it will be checked whether the format details string is supported.
- Parameters:
- formatDetails : str¶
Format details of the recording.
- SetSyncDeltaT(deltaT)¶
Set the time axis shift determined by the synchronization.
- Note:
Only use in the context of a analysis job. Synchronization is ignored when this information is set.
- Parameters:
- deltaT : float¶
Shift of time axis determined by the synchronization or None, when no synchronization information exists.