findEvent

Query tsdata.event by name

Syntax

[event,ind] = findEvent(tse,tsename)

[event,ind] = findEvent(tse,tsename,n)

Description

[event,ind] = findEvent(tse,tsename) returns the first tsdata.event object event with the name tsename in an array of tsdata.event objects tse. The output argument ind is the index of tse corresponding to event.

[event,ind] = findEvent(tse,tsename,n) returns the nth tsdata.event object in the array tse and its index.

Examples

Find Event by Name

Create a vector containing two tsdata.event objects with the name MyEvent. Find the first event named MyEvent.

tse1 = tsdata.event('MyEvent',1);
tse2 = tsdata.event('MyEvent',2);
tse = [tse1 tse2];
[event1,ind1] = findEvent(tse,'MyEvent');
event1

    EventData: []
         Name: 'MyEvent'
         Time: 1
        Units: 'seconds'
    StartDate: ''

ind1

ind1 = 
1

Find the second event named MyEvent.

[event2,ind2] = findEvent(tse,'MyEvent',2);
event2

    EventData: []
         Name: 'MyEvent'
         Time: 2
        Units: 'seconds'
    StartDate: ''

ind2

ind2 = 
2

Input Arguments

tse — Input tsdata.event

array

Input tsdata.event, specified as an array.

tsename — tsdata.event name

character vector

tsdata.event name, specified as a character vector.

n — tsdata.event number

integer scalar

tsdata.event number, specified as an integer scalar.

Output Arguments

event — Output tsdata.event

scalar

Output tsdata.event, specified as a scalar.

ind — tsdata.event index

integer scalar

tsdata.event index, specified as an integer scalar.

Version History

Introduced before R2006a