Class - XPSPL\signal\Complex

Added in v0.3.0

Complex signals are any signals that perform a calculation to determine signals to trigger, idle time or an idle function.

Methods

__construct

__construct()

Constructs a new complex signal.

This must be called from a child signal.

evaluate

evaluate([$signal = false])

Compares the event signal given aganist itself.

Parameters:string|integer – Signal to evaluate
Return type:boolean|string|array False on failure. True if matches. String or array indicate results to pass handlers

routine

routine([$history = false])

Runs the routine calculations which allows for a complex signal to analyze the event history or perform any other computable algorithm for determining when a signal should trigger, the processor should idle or the processor run the given function for a certain amount of time.

The goal of running routine calculations is to allow for complex event processing.

The return of this method is ignored.

Parameters:array – Event history
Return type:void

get_routine

get_routine()

Returns the routine object for this complex signal.

Return type:object XPSPLRoutine

event

event([$event = false])

Returns the event assigned to this signal.

Return type:object|null

signal_this

signal_this([$event = false[, $ttl = false]])

Method for adding this signal to signal itself within a routine.

Parameters:
  • boolean|object – Create or provide an event. Default = true
  • integer|null – TTL for the event.
Return type:

void

Last updated on 02/01/13 07:27am

Project Versions

Table Of Contents

Previous topic

Class - XPSPL\processor\signal\Base

Next topic

Class - XPSPL\processor\signal\Deprecated

This Page