 | Checker |
Encapsulates the call of an external work routine,
which is loaded dynamically as a Dll plug-in.
Inheritance hierarchySystemObject
LogicalTaskTreeNodeShellBase
LogicalTaskTreeNodeCheckerBase
LogicalTaskTreeCheckerShell
LogicalTaskTreeNodeShellBase
LogicalTaskTreeNodeCheckerBase
LogicalTaskTreeCheckerShell
Namespace: LogicalTaskTree
Assembly: LogicalTaskTree (in LogicalTaskTree.dll) Version: 1.0.0+df0404e911d6c38eaed3bb1bb1acfc482d417643
SyntaxThe CheckerShell Type exposes the following members.
Constructors| Name | Description of the | |
|---|---|---|
 | CheckerShell(String) | Constructor |
| CheckerShell(String, LoggerShell) | Constructor |
| CheckerShell(String, TriggerShell) | Constructor. |
| CheckerShell(String, Boolean) | Constructor |
| CheckerShell(String, LoggerShell, Boolean) | Constructor |
| CheckerShell(String, TriggerShell, Boolean) | Constructor |
| CheckerShell(String, Object, Object) | Constructor |
| CheckerShell(String, Object, Object, LoggerShell) | Constructor |
| CheckerShell(String, Object, Object, TriggerShell) | Constructor |
| CheckerShell(String, Object, Object, Boolean) | Constructor |
| CheckerShell(String, Object, Object, LoggerShell, Boolean) | Constructor |
| CheckerShell(String, Object, Object, TriggerShell, Boolean) | Constructor |
| CheckerShell(String, Object, Object, TriggerShell, LoggerShell, Boolean) | Constructor |
Properties| Name | Description of the | |
|---|---|---|
 | CanRunDll |
Dll with the instance of ICanRun. If available, CanRun is started before every
of a node is called. If CanRun returns false, the start is cancelled.
In CanRun, the parameters transferred via ref can also be
be modified.
(Inherited from NodeShellBase) |
 | CanRunDllPath |
Path to an optional dll that provides an ICanRun instance.
If available, before each run of the associated checker or worker
CanRun is called. If CanRun returns false, the start is cancelled.
The parameters transferred can also be modified in CanRun.
(Inherited from NodeShellBase) |
| CheckerLogger |
An optional logger that is called by the node
or zero.
Is provided by the IJobProvider during instantiation.
(Inherited from NodeCheckerBase) |
| CheckerParameters | Specific call parameters for the checker dll or null. |
| CheckerTrigger |
An optional trigger that calls the job repeatedly
or null (internally sets BreakWithResult to false).
Is provided by the IJobProvider during instantiation.
(Inherited from NodeCheckerBase) |
| InitNodes |
If True, all nodes in the tree are reset when this node is started.
Can be used for loops in controlled jobs.
Default: false.
(Inherited from NodeCheckerBase) |
| IsGlobal |
If true, this node is created as a reference node if anywhere in the tree
(not only in the current job) the name of the node has already been found.
If false, the system only searches for nodes with the same name in the current job.
Default: false.
(Inherited from NodeCheckerBase) |
| IsInvalid |
With True, after successful global locking
no further start attempt is made and the locking
cancelled.
(Inherited from NodeCheckerBase) |
| LastReturned |
The last result returned.
(Inherited from NodeCheckerBase) |
| OriginalCheckerParameters | Unchanged call parameters for the checker dll or null. In contrast to the CheckerParameters, the OriginalCheckerParameters can be can no longer be subsequently changed using ReplaceWildcardsNPathes. Since ReplaceWildcardsNPathes may also use paths that were created by the caching of the first can be different depending on the timing, such changeable Parameter not suitable for equalisation comparisons. |
| ReferencedNodeName |
Name of an originally referenced node or null.
(Inherited from NodeCheckerBase) |
| ReturnObject |
Return object of the checker, can be null.
(Inherited from NodeCheckerBase) |
| SlavePathName | Path to the dll of the external checker routine. |
| TriggeredRunDelay |
Delays the start of a node (and InitNodes).
Can be used for loops in controlled jobs.
Default: 0 (milliseconds).
(Inherited from NodeCheckerBase) |
| UserControlPath |
The path to the UserControl currently to be loaded dynamically.
(Overwrites NodeCheckerBaseUserControlPath) |
Methods| Name | Description of the | |
|---|---|---|
| CanRun |
Is used by Vishnu before each run of a Checker, Worker or before
Start a trigger is called up.
Returns true if the run/start can be executed.
(Inherited from NodeShellBase) |
| Dispose | Public method for cleaning up. |
 | Dispose(Boolean) | Clean up here: calls Dispose() for all user elements that are disposable..; |
| Finalise |
Finaliser: is called by the GarbageCollector.
(Overwrites ObjectFinalise) |
| GetCheckerReference |
Returns the name of the checker that is to be assigned to a ValueConverter.
(Inherited from NodeCheckerBase) |
| ModifyValue |
Converts a value into a given format.
Must be overwritten, therefore without function here
(reflects the input value back) is implemented.
(Overwrites NodeCheckerBaseModifyValue(Object)) |
| Run |
This is where the (normally external) work process is carried out (or observed).
(Overwrites NodeCheckerBaseRun(Object, TreeParameters, TreeEvent)) |
| SetChecker |
Takes over the checker for ValueConverters.
(Inherited from NodeCheckerBase) |
| SubNodeProgressChanged |
Is activated if the processing progress of the checker has changed.
(Inherited from NodeCheckerBase) |
Events| Name | Description of the | |
|---|---|---|
 | NodeProgressChanged |
Is called up if the processing progress of the checker has changed.
(Inherited from NodeCheckerBase) |
Remarks
File: CheckerShell.cs
Author: Erik Nagel
01.03.2013 Erik Nagel: created
See also