Inherits IDispatch.

Detailed Description

Record allows to access recorded frames

 
    interface IRecord : IDispatch
    {
        HRESULT CreateMsgIdFilter([in] IBus* iBus, [in] long nMsgID, [out, retval] IRecordFilter**);
        HRESULT CreateItemFilter([in] IDatabaseItem* pItem, [out, retval] IRecordFilter**);
        HRESULT CreateFilter([in] enum RecordEntryType enEntryType, [out, retval] IRecordFilter**);
        HRESULT CreateIterator([in] IRecordFilter* pFilter, [out, retval] IRecordIterator**);
        HRESULT RecordChangeEvents([out, retval] VARIANT_BOOL *pVal);
        HRESULT RecordChangeEvents([in] VARIANT_BOOL boNewVal);
        HRESULT Load([in] BSTR sFile);
        HRESULT Unload();
        HRESULT Save(BSTR sFile);
        HRESULT Autostart([out, retval] VARIANT_BOOL* boActive);
        HRESULT Autostart([in] VARIANT_BOOL boActive);
        HRESULT Start();
        HRESULT Stop();
        HRESULT CreateMarker();
        HRESULT CreateStringTypeFilter([in] BSTR sType, [out, retval] IRecordFilter**);
        HRESULT CreateRecordChannel([out, retval] IRecordChannel**);
        HRESULT WriteTrace([in] double timestamp, [in] long identifier, [in] VARIANT byteArray, [in] long length, [out, retval] VARIANT_BOOL*);
        HRESULT Restart();
        HRESULT ShowMethodInExplorer();
        HRESULT AnalyzeRecord(BSTR sourceFile, BSTR destinationFile, int outputType, int delta);
        HRESULT WriteEvents([out, retval] VARIANT_BOOL *pVal);
        HRESULT WriteEvents([in] VARIANT_BOOL boNewVal);
        HRESULT SaveFiltered(BSTR sFile, [in]IRecordIterator* pIterator);
        HRESULT SavePart([in]VARIANT_BOOL async, [in]BSTR sDirectory, [in]int seconds, [in]BSTR sFileName);
        HRESULT SaveRange([in]VARIANT_BOOL async, [in]BSTR sDirectory, [in]BSTR sFileName, [in]double fromTS, [in]double toTS);
    };
 

Definition at line 6205 of file cand_tlb.idl.

Member Function Documentation

◆ AnalyzeRecord()

HRESULT CanEasy::IRecord::AnalyzeRecord	(	BSTR	sourceFile,
		BSTR	destinationFile,
		int	outputType,
		int	delta
	)

Starts different analyze functions

Parameters

sourceFile	Record file (celog) to read
destinationFile	Output file to write
outputType	Analyse type 0 = CYLCETIME_CSV, 1 = MARKER_REC, 2 = VAR_REC, 3 = PROTOCOLS
delta	Delta percentage to detect timeouts

◆ CreateFilter()

HRESULT CanEasy::IRecord::CreateFilter	(	[in] enum RecordEntryType	enEntryType,
		[out, retval] IRecordFilter **
	)

Creates a filter for a record type

Parameters

enEntryType Record entry type you want to filter

Returns: Pointer to created filter

◆ CreateItemFilter()

HRESULT CanEasy::IRecord::CreateItemFilter	(	[in] IDatabaseItem *	pItem,
		[out, retval] IRecordFilter **
	)

Creates a filter for database items

Parameters

pItem DatabaseItem you want to filter

Returns: Pointer to created filter

◆ CreateIterator()

HRESULT CanEasy::IRecord::CreateIterator	(	[in] IRecordFilter *	pFilter,
		[out, retval] IRecordIterator **
	)

Creates an iterator

Parameters

pFilter Filter (for example created with CreateFilter)

Returns: Pointer to created iterator

◆ CreateMarker()

HRESULT CanEasy::IRecord::CreateMarker ( )

Inserts a marker record entry

◆ CreateMsgIdFilter()

HRESULT CanEasy::IRecord::CreateMsgIdFilter	(	[in] IBus *	iBus,
		[in] long	nMsgID,
		[out, retval] IRecordFilter **
	)

Creates a filter for messages

Parameters

iBus	Pointer to bus to filter
nMsgID	Message identifier to filter

Returns: Pointer to created filter

◆ CreateRecordChannel()

HRESULT CanEasy::IRecord::CreateRecordChannel ( [out, retval] IRecordChannel ** )

Creates a new record channel.

A record channel allows writing own data into the CanEasy record. It must be created before the simulation is started.

◆ CreateStringTypeFilter()

HRESULT CanEasy::IRecord::CreateStringTypeFilter	(	[in] BSTR	sType,
		[out, retval] IRecordFilter **
	)

Creates a filter by string type of the record entry

Parameters

sType String type of record entry (see xmllog)

Returns: Pointer to created record filter

◆ Load()

HRESULT CanEasy::IRecord::Load ( [in] BSTR sFile )

Loads a record (not possible while simulation is running)

Parameters

sFile File to load

◆ Restart()

HRESULT CanEasy::IRecord::Restart ( )

Restarts the record. Creates a new record folder

◆ Save()

HRESULT CanEasy::IRecord::Save ( BSTR sFile )

Save the record into a new file

Parameters

sFile File to save to

◆ SaveFiltered()

HRESULT CanEasy::IRecord::SaveFiltered	(	BSTR	sFile,
		[in] IRecordIterator *	pIterator
	)

Saves a new record using the passed iterator as filter

Parameters

sFile	File to save to
pIterator	Iterator to process the record

◆ SavePart()

HRESULT CanEasy::IRecord::SavePart	(	[in] VARIANT_BOOL	async,
		[in] BSTR	sDirectory,
		[in] int	seconds,
		[in] BSTR	sFileName
	)

Saves last seconds from the record

Parameters

async	If True function will return directly. If False it will wait till save finished.
sDirectory	Directory to save recording
seconds	Define how many seconds from the ends have to be stored
sFileName	File name without directory

◆ SaveRange()

HRESULT CanEasy::IRecord::SaveRange	(	[in] VARIANT_BOOL	async,
		[in] BSTR	sDirectory,
		[in] BSTR	sFileName,
		[in] double	fromTS,
		[in] double	toTS
	)

Saves the record between two timestamps

Parameters

async	If True function will return directly. If False it will wait till save finished.
sDirectory	Directory to save recording
sFileName	File name without directory
fromTS	Timestamp from which exports starts [in seconds]
toTS	Timestamp when exports stops [in seconds]

◆ ShowMethodInExplorer()

HRESULT CanEasy::IRecord::ShowMethodInExplorer ( )

Opens the record path in the Windows Explorer

◆ Start()

HRESULT CanEasy::IRecord::Start ( )

Start the recording

◆ Stop()

HRESULT CanEasy::IRecord::Stop ( )

Stops the recording

◆ Unload()

HRESULT CanEasy::IRecord::Unload ( )

Unloads a record

◆ WriteTrace()

HRESULT CanEasy::IRecord::WriteTrace	(	[in] double	timestamp,
		[in] long	identifier,
		[in] VARIANT	byteArray,
		[in] long	length,
		[out, retval] VARIANT_BOOL *
	)

Writes a trace record entry into the record

Parameters

timestamp	Timestamp in hours
identifier	Unique ID (see attribute Identifier)
byteArray	Trace data to write
length	Byte length of trace data

Returns: True on success

Property Documentation

◆ Autostart

VARIANT_BOOL CanEasy::IRecord::Autostart

getset

Activates/Deactivates the autostart.

If autostart is active the record is started together with the simulation

◆ RecordChangeEvents

VARIANT_BOOL CanEasy::IRecord::RecordChangeEvents

getset

Activates/Deactivates record change events

◆ WriteEvents

VARIANT_BOOL CanEasy::IRecord::WriteEvents

getset

Activates/Deactivate events called on writing into the record