StopFcn

Callback function file to execute immediately after logging stops

Description

You configure StopFcn to execute a callback function file when logging has stopped. Logging stops when you issue a stop command, or when the RecordsAcquired value reaches RecordsToAcquire.

When a stop event occurs, the function specified in StopFcn is passed two parameters: Obj and EventInfo. Obj is the object associated with the event, and EventInfo is an event structure containing the fields Type and Data. The Type field is set to 'Stop'. The Data field contains a structure with the fields given below.

FIeld Name

Description

LocalEventTime

The time, as a MATLAB® date vector, that the event occurred.

GroupName

The group name.

RecordsAcquired

The number of records acquired in the current logging session at the time the event occurred.

Stop event information is stored in the EventLog property.

Characteristics

Access

Read/write

Applies to

dagroup

Data type

string, function handle, or cell array

Values

The default value is an empty matrix ([]).

See Also

Functions

stop

Properties

EventLog, RecordsAcquired, RecordsToAcquire

Was this topic helpful?