ilSimpleEmitter Class Reference

@noinspection PhpIncludeInspection More...

Inheritance diagram for ilSimpleEmitter:

Collaboration diagram for ilSimpleEmitter:

Public Member Functions
	__construct (ilNode $context)
	Default constructor. More...
	setTargetDetector (ilDetector $target_detector)
	Sets the target detector for this emitter. More...
	getTargetDetector ()
	Gets the currently set target detector of this emitter. More...
	getContext ()
	Returns a reference to the parent node of this emitter. More...
	emit ()
	Executes this emitter. More...
	setName ($name)
	getName ()
	emit ()
	getContext ()
	This method returns the context of the element. More...
	setName ($name)
	getName ()

Protected Attributes
	$name

Private Attributes
	$target_detector
	$context

Detailed Description

@noinspection PhpIncludeInspection

@noinspection PhpIncludeInspection @noinspection PhpIncludeInspection @noinspection PhpIncludeInspection ilSimpleEmitter is part of the petri net based workflow engine.

The simple emitter is the internal signals yeoman, doing nothing but triggering the designated simple detector.

Author

Maximilian Becker mbeck.nosp@m.er@d.nosp@m.ataba.nosp@m.y.de

Version

$Id$

/

Definition at line 24 of file class.ilSimpleEmitter.php.

Constructor & Destructor Documentation

__construct()

ilSimpleEmitter::__construct

(

ilNode

$context

)

Default constructor.

Parameters

ilNode

$context

Reference to the parent node.

Definition at line 48 of file class.ilSimpleEmitter.php.

        {
                $this->context = $context;
        }

References $context.

Member Function Documentation

emit()

ilSimpleEmitter::emit

(

)

Executes this emitter.

Implements ilEmitter.

Definition at line 86 of file class.ilSimpleEmitter.php.

        {
                $this->target_detector->trigger(array());
        }

getContext()

ilSimpleEmitter::getContext

(

)

Returns a reference to the parent node of this emitter.

Returns

ilNode Reference to the parent node.

Implements ilWorkflowEngineElement.

Definition at line 78 of file class.ilSimpleEmitter.php.

        {
                return $this->context;
        }

References $context.

getName()

ilSimpleEmitter::getName

(

)

Returns

string

Implements ilWorkflowEngineElement.

Definition at line 102 of file class.ilSimpleEmitter.php.

        {
                return $this->name;
        }

References $name.

getTargetDetector()

ilSimpleEmitter::getTargetDetector

(

)

Gets the currently set target detector of this emitter.

Returns

ilDetector Reference to the target detector.

Definition at line 68 of file class.ilSimpleEmitter.php.

        {
                return $this->target_detector;
        }

References $target_detector.

setName()

ilSimpleEmitter::setName

(

$name

)

Parameters

string

$name

Implements ilWorkflowEngineElement.

Definition at line 94 of file class.ilSimpleEmitter.php.

        {
                $this->name = $name;
        }

References $name.

setTargetDetector()

ilSimpleEmitter::setTargetDetector

(

ilDetector

$target_detector

)

Sets the target detector for this emitter.

Parameters

ilDetector

$target_detector

Definition at line 58 of file class.ilSimpleEmitter.php.

        {
                $this->target_detector = $target_detector;
        }

References $target_detector.

Field Documentation

$context

ilSimpleEmitter::$context

private

Definition at line 38 of file class.ilSimpleEmitter.php.

Referenced by __construct(), and getContext().

$name

string ilSimpleEmitter::$name

protected

Definition at line 41 of file class.ilSimpleEmitter.php.

Referenced by getName(), and setName().

$target_detector

ilSimpleEmitter::$target_detector

private

Definition at line 31 of file class.ilSimpleEmitter.php.

Referenced by getTargetDetector(), and setTargetDetector().

---

The documentation for this class was generated from the following file:

• Services/WorkflowEngine/classes/emitters/class.ilSimpleEmitter.php