Extensions.Measure.IsDeviceEvent

From emotive
Jump to navigation Jump to search

Classification

Name IsDeviceEvent
Short Description Checks whether the event originated from a DeviceEventSource term or not.
Class Term
Extension OTX Measure extension
Group Event related terms
Exceptions -
Checker Rules -
Standard Compliant Yes

OTL Syntax

BooleanTerm Measure.IsDeviceEvent(EventValue event);

Description

The IsDeviceEvent term will return true if and only if the Event originates from a DeviceEventSource term.

Return Value

The Term returns the value, see table below.

Icons Note.png In OTX, Terms are categorized according to its return data type!
Data Type Description
Boolean This value is TRUE if and only if the event originated from a DeviceEventSource term.

Properties

Name Data Type Class Default Cardinality Description
Event Event Value - [1] Represents the Event whose type will be tested.

OTL Examples

/// Signatures

package Measure.DeviceSignature DeviceSignature1
{
	Measure.DeviceServiceSignature Add(in Integer a, out Measure.Measurement Measurement);
}

/// Global Declarations

public procedure main()
{
	/// Local Declarations

	Measure.Measurement Measurement1;
	Integer a1 = 10;
	EventHandling.EventSource EventSource1;
	EventHandling.Event Event1;
	Boolean Boolean1 = false;

	/// Flow

	EventSource1 = Measure.DeviceEventSource(DeviceSignature1);

	parallel
	{
		lane
		{
			Measure.ExecuteDeviceService(DeviceSignature1, Add, {a = a1, Measurement = Measurement1}, false, false);
		}
		lane
		{
			EventHandling.WaitForEvent({EventSource1}, Event1);
		}
	}
	Boolean1 = Measure.IsDeviceEvent(Event1);
}

See also

DeviceEventSource
GetDeviceServiceNameFromEvent