ilActivationEmitter Class Reference

PhpIncludeInspection More...

Inheritance diagram for ilActivationEmitter:

Collaboration diagram for ilActivationEmitter:

Public Member Functions
	__construct (ilNode $context)
	Default constructor. More...
	setTargetDetector (ilDetector $a_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 after activating the target node. More...
	getActivated ()
	setName ($name)
	getName ()

Protected Attributes
	$name

Private Attributes
	$target_detector
	$context
	$emitted

Detailed Description

PhpIncludeInspection

PhpIncludeInspection PhpIncludeInspection PhpIncludeInspection ilActivationEmitter is part of the petri net based workflow engine.

The activation emitter is an internal signals yeoman, doing nothing but activating the designated target node. While the simple emitter triggers an open detector, this emitter is used to activate inactive nodes. In a regular petri net, all nodes are active. The modelling of nodes, which may only transit when preconditions are met, offer a decent amount of planning. To offer a shortcut and to optimize load for the workflowcontroller, nodes default to being inactive. They, as well as their detectors, feature methods that are fired during activation/deactivation. The activation emitter sits in the slot of an emitter, due to the small interface involved a comfortable place, and signals not only to a node, but activates the target node before.

Author

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

Version

$Id$

/

Definition at line 32 of file class.ilActivationEmitter.php.

Constructor & Destructor Documentation

__construct()

ilActivationEmitter::__construct

(

ilNode

$context

)

Default constructor.

Parameters

ilNode

$context

Reference to the parent node.

Definition at line 59 of file class.ilActivationEmitter.php.

References $context.

        {
                $this->context = $context;
                $this->emitted = false;
        }

Member Function Documentation

emit()

ilActivationEmitter::emit

(

)

Executes this emitter after activating the target node.

Implements ilEmitter.

Definition at line 98 of file class.ilActivationEmitter.php.

References array.

        {
                $this->emitted = true;
                $target_node = $this->target_detector->getContext();
                $target_node->activate();
                $this->target_detector->trigger(array());
        }

getActivated()

ilActivationEmitter::getActivated

(

)

Returns

bool

Definition at line 109 of file class.ilActivationEmitter.php.

References $emitted.

        {
                return $this->emitted;
        }

getContext()

ilActivationEmitter::getContext

(

)

Returns a reference to the parent node of this emitter.

Returns

ilNode Reference to the parent node.

Implements ilWorkflowEngineElement.

Definition at line 90 of file class.ilActivationEmitter.php.

References $context.

        {
                return $this->context;
        }

getName()

ilActivationEmitter::getName

(

)

Returns

string

Implements ilWorkflowEngineElement.

Definition at line 125 of file class.ilActivationEmitter.php.

References $name.

        {
                return $this->name;
        }

getTargetDetector()

ilActivationEmitter::getTargetDetector

(

)

Gets the currently set target detector of this emitter.

Returns

ilDetector Reference to the target detector.

Definition at line 80 of file class.ilActivationEmitter.php.

References $target_detector.

        {
                return $this->target_detector;
        }

setName()

ilActivationEmitter::setName

(

$name

)

Parameters

string

$name

Implements ilWorkflowEngineElement.

Definition at line 117 of file class.ilActivationEmitter.php.

References $name.

        {
                $this->name = $name;
        }

setTargetDetector()

ilActivationEmitter::setTargetDetector

(

ilDetector

$a_target_detector

)

Sets the target detector for this emitter.

Parameters

ilDetector

$a_target_detector

Definition at line 70 of file class.ilActivationEmitter.php.

        {
                $this->target_detector = $a_target_detector;
        }

Field Documentation

$context

ilActivationEmitter::$context

private

Definition at line 46 of file class.ilActivationEmitter.php.

Referenced by __construct(), and getContext().

$emitted

ilActivationEmitter::$emitted

private

Definition at line 49 of file class.ilActivationEmitter.php.

Referenced by getActivated().

$name

ilActivationEmitter::$name

protected

Definition at line 52 of file class.ilActivationEmitter.php.

Referenced by getName(), and setName().

$target_detector

ilActivationEmitter::$target_detector

private

Definition at line 39 of file class.ilActivationEmitter.php.

Referenced by getTargetDetector().

---

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

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