Collapse All Expand All

C#

Clarion Library 6.1.1
Agent..::..Retract Method
Agent Class See Also Send Feedback

[This is preliminary documentation and is subject to change.]

Retracts the specified internal (ICommitable, functional) item from the specified container within the agent

Namespace: Clarion.Framework
Assembly: ClarionLibrary (in ClarionLibrary.dll) Version: 6.1.1.0 (6.1.1.0)

# Syntax

C#
    public void Retract(
    	ICommitable agentInternal,
    	Agent..::..InternalContainers container
    )

#### Parameters

agentInternal
  Type: Clarion.Framework.Core..::..ICommitable
  The internal (functional) item that is to be retracted

container
  Type: Clarion.Framework..::..Agent..::..InternalContainers
  The internal container in which the item is located

# Remarks

This method does the following:

- Removes the internal (functional) item from the specified internals container and places it back in the "initializing" container
- Makes the internal (functional) item mutable (i.e., editable)
- Unregisters any event handler delegates for the internal (functional) item

Note
While retracting an internal (ICommitable, functional) item does make it mutable (i.e., editable), there may also be serious downsides to retracting it (e.g., it may need to have its dWeights, etc., reinitialized upon being recommitted). You should ALWAYS consult the documentation of the internal item before deciding whether you want to retract it.

# Exceptions

Exception | Condition
--- | ---
System..::..ArgumentException | If the specified internal item is not of the correct type for the specified internal container or if it can not be found in the specified internal container

# See Also

Agent Class
Clarion.Framework Namespace