ReteCore.Activation Class Reference

The Activation class represents a pending rule activation in a Rete-based rule engine. It encapsulates the information needed to execute a rule when its conditions are met, including the name of the rule, the action to perform, the token that triggered the activation, and the salience (priority) of the activation. Activations are typically created by terminal nodes in the Rete network and added to an agenda for later execution. When an activation is fired, it executes its associated action using the token that caused it to be activated. The salience value allows for prioritizing activations when multiple rules are activated simultaneously, with higher salience values being executed first. More...

Public Member Functions
	Activation (string name, Action< Token > action, Token match, int salience)
	Creates a new Activation instance with the specified rule name, action, token match, and salience. This constructor initializes the properties of the activation, allowing it to be added to an agenda for later execution when the conditions of the associated rule are satisfied. The rule name is used for identification and debugging purposes, while the action defines what will be executed when the activation fires. The token match contains the facts that triggered the activation, and the salience determines the priority of this activation relative to others in the agenda.
void	Fire ()
	Fires this activation by executing its associated action with the token that triggered it. This method is typically called by the agenda when processing pending activations, allowing the rule's action to be executed based on the matched facts contained in the token. The action can perform any operations defined by the rule, such as modifying facts, asserting new facts, or interacting with external systems, using the information available in the token.

Properties
string	RuleName [get]
	The name of the rule associated with this activation. This is used for identification and debugging purposes, allowing users to trace which rule is being activated when an activation is fired. The rule name can help in understanding the flow of rule execution and diagnosing issues in the rule engine by providing context about which rules are being triggered based on the matched facts in the token.
Action< Token >	Action [get]
	An action delegate that defines the operation to be performed when this activation is fired. The action takes a Token as a parameter, which contains the facts that triggered the activation. When the Fire method is called, this action will be executed with the associated token, allowing it to perform the necessary operations defined by the rule, such as modifying facts, asserting new facts, or interacting with external systems based on the matched conditions.
Token	Match [get]
	The token that triggered this activation. This token contains the facts that matched the conditions of the rule associated with this activation. When the activation is fired, this token will be passed to the action delegate, allowing it to access the relevant facts and perform the necessary operations defined by the rule. The token serves as a context for the activation, providing the information needed to execute the rule's action effectively.
int	Salience [get]
	A numeric value representing the priority of this activation relative to others in the agenda. Higher salience values indicate higher priority, meaning that activations with higher salience will be fired before those with lower salience when multiple activations are pending in the agenda. This allows for fine-grained control over the order of rule execution, ensuring that more important rules are executed first when there are competing activations.

Detailed Description

The Activation class represents a pending rule activation in a Rete-based rule engine. It encapsulates the information needed to execute a rule when its conditions are met, including the name of the rule, the action to perform, the token that triggered the activation, and the salience (priority) of the activation. Activations are typically created by terminal nodes in the Rete network and added to an agenda for later execution. When an activation is fired, it executes its associated action using the token that caused it to be activated. The salience value allows for prioritizing activations when multiple rules are activated simultaneously, with higher salience values being executed first.

Constructor & Destructor Documentation

Activation()

ReteCore.Activation.Activation	(	string	name,
		Action< Token >	action,
		Token	match,
		int	salience )

Creates a new Activation instance with the specified rule name, action, token match, and salience. This constructor initializes the properties of the activation, allowing it to be added to an agenda for later execution when the conditions of the associated rule are satisfied. The rule name is used for identification and debugging purposes, while the action defines what will be executed when the activation fires. The token match contains the facts that triggered the activation, and the salience determines the priority of this activation relative to others in the agenda.

Parameters

name	The name of the activation. Usually the rule name.
action	The action that executes when this activation fires.
match	The triggering Token containing the fact on which to act upon.
salience	A priority value relative to other activations.

---

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

• ReteCore/Activation.cs