 | Node |
Function: Base class for nodes with children: NodeList and NodeConnector.
Inheritance hierarchySystemObject
NetEti.GlobalsGenericTreeLogicalNode
LogicalTaskTreeLogicalNode
LogicalTaskTreeNodeParent
LogicalTaskTreeNodeConnector
LogicalTaskTreeNodeList
NetEti.GlobalsGenericTreeLogicalNode
LogicalTaskTreeLogicalNode
LogicalTaskTreeNodeParent
LogicalTaskTreeNodeConnector
LogicalTaskTreeNodeList
Namespace: LogicalTaskTree
Assembly: LogicalTaskTree (in LogicalTaskTree.dll) Version: 1.0.0+df0404e911d6c38eaed3bb1bb1acfc482d417643
SyntaxThe NodeParent Type exposes the following members.
Constructors| Name | Description of the | |
|---|---|---|
 | NodeParent(LogicalNode, JobList, TreeParameters) | Constructor for a snapshot dummy element - forwards the processing to the "LogicalNode" base class. |
| NodeParent(String, LogicalNode, JobList, TreeParameters) | Constructor - passes the processing to the "LogicalNode" base class. |
Properties| Name | Description of the | |
|---|---|---|
 | BreakWithResult |
A subtree may already have a clear logical result,
before all the children have finished their processing.
If BreakWithResult=True, these are then cancelled if the
no triggers are active on the branch in question.
(Inherited from LogicalNode) |
| CanTreeStart |
Indicates whether a (partial) tree can be started, i.e. that a
node with children all its children can be started (recursively)
or in the case of an end node (checker) without children this can be started itself.
(Inherited from LogicalNode) |
| Children |
List of the children of a node.
(Inherited from GenericTreeT) |
| DebugMode |
Additional test outputs can be made for True.
Default: False.
(Inherited from LogicalNode) |
| HookedTo | Contains comma-separated TreeParams.Name and IdInfo of the nodes in whose Events this NodeParent has mounted or the text "NULL". |
| Id |
The unique identifier of the node.
(Inherited from LogicalNode) |
| IdInfo |
The unique identifier of the node (identical to the property Id).
(Inherited from LogicalNode) |
| IdPath |
Path to the node reduced to a chain of Ids separated by '/'.
(Inherited from LogicalNode) |
| 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 LogicalNode) |
| IsActive |
If true, the subtree/node is in an active (started) state.
(Inherited from LogicalNode) |
| 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 LogicalNode) |
| IsInSleepTime |
Returns true if a rest period defined by the user is currently in progress.
for Vishnu actors (checkers) is running.
(Inherited from LogicalNode) |
| IsInSnapshot |
With True, this LogicalNode is located within a snapshot.
(Inherited from LogicalNode) |
| IsSnapshotDummy |
With True, this node is only used for display and does not allow any other functions.
(Inherited from LogicalNode) |
| LastExecutingTreeEvent |
The last triggering TreeEvent (for TreeEvent-triggered nodes)
or zero.
(Inherited from LogicalNode) |
| LastLogical |
The last logical state of a node.
For accessing the states of child nodes without
re-initiate the determination of the statuses.
Reduces the processor load.
(Inherited from LogicalNode) |
| LastLogicalState |
The last result state of a node.
For accessing the states of child nodes without
re-initiate the determination of the statuses.
Reduces the processor load.
(Inherited from LogicalNode) |
| LastNotNullLogical |
Flag field for the last state of Logical that was not zero;
is required so that workers are only started when
the state of Logical has changed significantly and not every time,
when the checker is working (Logical = zero).
(Inherited from LogicalNode) |
| LastResult |
Result for this node.
(Inherited from LogicalNode) |
| LastRun |
Time of the last start of the node.
(Inherited from LogicalNode) |
 | LastSingleNodesFinished | The last number of completed end node children of a node. For accessing the states of child nodes without re-initiate the determination of the statuses. Reduces the processor load. |
| LastState |
The last processing state of a node.
For accessing the states of child nodes without
re-initiate the determination of the statuses.
Reduces the processor load.
(Inherited from LogicalNode) |
| Level |
The hierarchy level of the node.
(Inherited from LogicalNode) |
| LevelInfo |
The hierarchy level of the node (identical to the property level).
(Inherited from LogicalNode) |
| LockName |
Optional name used for global locking.
Is used if ThreadLocked is set.
(Inherited from LogicalNode) |
| Logger |
An optional logger that is activated for certain events
is called or null.
(Inherited from LogicalNode) |
| Logical |
The logical state of a node; this is ultimately what the
entire processing.
(Inherited from LogicalNode) |
| LogicalState |
The result state of the node:
None, Start, Done, Fault, Timeout, UserAbort.
(Inherited from LogicalNode) |
| Name |
"Human-friendly" representation of the node.
(Inherited from LogicalNode) |
| NameId |
Combination of name and Id of the node.
(Inherited from LogicalNode) |
| NameInfo |
"Human-friendly" representation of the node.
(Inherited from LogicalNode) |
| NextRun |
Time of the next start of the node (if known) or DateTime.MinValue.
(Inherited from LogicalNode) |
| NextRunInfo |
Info text about the next start of the node (if known) or null.
(Inherited from LogicalNode) |
| NodeType |
The node type:
None, NodeConnector, ValueModifier, JobConnector, Constant, Checker, NodeList, JobList, Snapshot.
(Inherited from LogicalNode) |
| ParentView |
The parent control in which this node is displayed.
(Inherited from LogicalNode) |
| Path |
The path to the node consisting of a chain of NameIds separated by '/':
NameId is Name + "(" + Id + ")" for nodes with Name != null,
only Id with name = null.
(Inherited from LogicalNode) |
| PathInfo |
The path to the node (identical to the Path property).
(Inherited from LogicalNode) |
| ReferencedNodeId |
Id of an originally referenced node or null.
(Inherited from LogicalNode) |
| ReferencedNodeName |
Name of an originally referenced node or null.
(Inherited from LogicalNode) |
| ReferencedNodePath |
Path of an originally referenced node or null.
(Inherited from LogicalNode) |
| SingleNodes |
Number of SingleNodes (ultimately checkers) at the end of a (sub)tree.
(Inherited from LogicalNode) |
| SingleNodesFinished |
Percentage value for the proportion of terminated SingleNodes
(ultimately checker) at the end of a (partial) tree.
(Inherited from LogicalNode) |
| SleepTimeFrom |
The start of a possible rest period.
(Inherited from LogicalNode) |
| SleepTimeTo |
The end of a possible rest period.
(Inherited from LogicalNode) |
| StartCollapsed |
With True, the job is displayed collapsed at startup if the UI supports this.
(Inherited from LogicalNode) |
| State |
The processing status of a node:
None, Waiting, Working, Finished, Triggered, Ready (= Finished | Triggered), CanStart (= None|Ready), Busy (= Waiting | Working).
(Inherited from LogicalNode) |
| ThreadLocked |
If True, each thread is locked via the class so that
non-thread-safe checkers are serialized;
Default: False;
(Inherited from LogicalNode) |
| TreeParams |
Additional parameters, some that apply to the entire tree
validity and some node-specific parameters
or zero.
(Inherited from LogicalNode) |
| Trigger |
An optional trigger that calls the job repeatedly
or null (internally overrides BreakWithResult).
(Inherited from LogicalNode) |
| TriggeredRunDelay |
Delays the start of a node (and InitNodes).
Can be used for loops in controlled jobs.
Default: 0 (milliseconds).
(Inherited from LogicalNode) |
| TypeInfo |
The node type:
None, NodeConnector, ValueModifier, Constant, Checker.
NodeTypes (Inherited from LogicalNode) |
| UserControlPath |
The path to the UserControl currently to be loaded dynamically.
(Inherited from LogicalNode) |
| WorkersState |
A collective status for all assigned workers.
(Inherited from LogicalNode) |
Methods| Name | Description of the | |
|---|---|---|
| Break |
If necessary, log out of the trigger,
Cancel the task via CancellationToken, set status.
(Inherited from LogicalNode) |
| CanControlledTreeStart |
Specifies whether a (sub)tree can be started in a JobController, i.e. that
the node and all its parents can be started (recursively).
(Inherited from LogicalNode) |
| Climb2Top |
Shimmies up through the tree (up to the root)
and calls up the action for each node.
(Inherited from GenericTreeT) |
 | DoRun |
The actual, node type-specific processing;
must be overwritten.
(Inherited from LogicalNode) |
| Equals |
Compares the content of this LogicalNode according to logical aspects
with the content of a transferred LogicalNode.
(Inherited from LogicalNode) |
| FindEventTriggers |
Searches for relevant triggers for an event.
(Inherited from LogicalNode) |
| FindNodeById |
A derivative of LogicalNode can use this to create its own thread
cause it to be cancelled.
(Inherited from LogicalNode) |
| FreeChildAt | Releases the event links with the child node at the index index and then calls Dispose for the child node if necessary. |
| GetEnvironment |
Returns the ConcurrentDictionary Environment as simple Dictionary Results.
Use the internal routine GetResultsFromResultList().
(Inherited from LogicalNode) |
| GetHashCode |
Generates a hash code for this LogicalNode.
(Inherited from LogicalNode) |
| GetlastEventSourceIfIsTreeEventTriggered |
Updates the values for TreeEvent-triggered nodes
of the node before continuing to work with them.
Is important in situations in which either the knot is the
triggering TreeEvent has missed (at program start)
or another TreeEvent was faster and led to a
reaction, which leads to the current values of the node
is required (JobSnapshotTrigger).
(Inherited from LogicalNode) |
| GetResults |
Returns the ConcurrentDictionary ResultList as a simple Dictionary Results.
Use the internal routine GetResultsFromResultList().
(Inherited from LogicalNode) |
| GetTopRootJobList |
Returns the topmost Root-JobList valid for the node.
(Inherited from LogicalNode) |
| InitFromNode |
Sets certain properties to the values of the transferred LogicalNode "source".
(Inherited from LogicalNode) |
| InitNode |
Resets the node to the start settings.
(Inherited from LogicalNode) |
| Invalidate |
Deletes internal caches so that everything is re-evaluated.
(Inherited from LogicalNode) |
| MarkThreadAsInvalidIfActive |
Adds thread to the list of invalid threads,
if the thread is still active.
(Inherited from LogicalNode) |
| OnLastNotNullLogicalChanged |
Triggers the NodeLastNotNullLogicalChanged event.
(Inherited from LogicalNode) |
| OnNodeBreaked |
Triggers the NodeBreaked event.
(Inherited from LogicalNode) |
| OnNodeProgressChanged |
Triggers the NodeProgressChanged event.
(Inherited from LogicalNode) |
| OnNodeProgressFinished |
Triggers the NodeProgressFinished event.
(Inherited from LogicalNode) |
| OnNodeProgressStarted |
Triggers the NodeStarted event.
(Inherited from LogicalNode) |
| OnNodeWorkersStateChanged |
Triggers the NodeWorkersStateChanged event.
(Inherited from LogicalNode) |
| ProcessTreeEvent |
Triggers further processing for the current TreeEvent (trigger, logger).
(Inherited from LogicalNode) |
| RaiseNodeLastNotNullLogicalChangedWithTreeEvent |
Triggers the TreeEvent "AnyLastNotNullLogicalHasChanged" and calls "OnNodeLastNotNullLogicalChanged".
(Inherited from LogicalNode) |
| RaiseNodeLogicalChanged |
Encapsulates the call of the non-inheritable NodeLogicalChanged event for
for the derived classes NodeList and JobList.
This routine ultimately forwards the event to the UI via NodeLogicalChanged.
(Inherited from LogicalNode) |
| Refresh |
Ensures immediate re-evaluation of all cashed statuses.
(Inherited from LogicalNode) |
| RegisterTriggeredNodes |
Registers all triggered nodes of a subtree with their triggers.
(Inherited from LogicalNode) |
| ReleaseChildAt | Releases the event links with the child node at the index index. |
| Reload |
Is called up when the subtree is to be reloaded.
(Inherited from LogicalNode) |
| ResetAllTreeEventTriggeringNodes |
Resets all nodes in the subtree on which others depend via TreeEvent.
(Inherited from LogicalNode) |
| ResetAllTreeNodes |
Resets all nodes in the entire tree.
(Inherited from LogicalNode) |
| ResetPartTreeNodes |
Resets all nodes in the subtree from branch.
(Inherited from LogicalNode) |
| Run |
Checks whether a node can be started and then starts the node, its trigger,
or both (via StartNodeOrTrigger).
(Inherited from LogicalNode) |
| SetChildAt | Saves the child node at the transferred index and attaches itself to the events of the child node. |
| SetTreeCollapsed |
Sets the StartCollapsed property for an entire (sub)tree.
(Inherited from LogicalNode) |
| SetWorkersState |
Sets a common (combined) NodeWorkerState 'WorkersState'
for all NodeWorkers.
Returns NodeWorkersState.
(Inherited from LogicalNode) |
| SubNodeExceptionCleared | Is triggered if an exception has been deleted in a child. Cascades the resolution of a previous exception up to the root node. Parent nodes with multiple children (NodeList) in turn generate an ExceptionCleared event only if no child node is still holding an exception. |
| SubNodeExceptionRaised | Is triggered if an exception has occurred in a child. Cascades the exception up to the root node without cancelling processing. |
| SubNodeLastNotNullLogicalChanged | Is triggered if the logical state "LastNotNullLogical" of a child has changed. This event is decisive for a possible change in the logical state of the parent node. Can be triggered by SingleNodes and ParentNodes through to the root node. The original trigger is always a SingleNode. May cascade upwards in the tree to the root node. |
| SubNodeLogicalChanged | Is triggered if the current logical result of the child node has changed. Is triggered by a SingleNode. Continues in the tree only up to the direct parent node. |
| SubNodeProgressChanged | Is activated when the processing progress changes. of the referenced original node has changed. Continues in the tree only up to the direct parent node. |
| SubNodeProgressFinished | Is triggered when processing of the child node is complete. May cascade in the tree up to the root node. Parent nodes with multiple children (NodeList) in turn generate a NodeProgressFinished event only when the processing of all child nodes has been completed. |
| SubNodeProgressStarted | Is triggered when processing of the child node has been started. May cascade upwards in the tree to the root node. Parent nodes with multiple children (NodeList) in turn generate a NodeProgressStarted event only if this is the first (and so far only) child whose processing has been started. |
| SubNodeResultChanged | Is triggered if the result of a child node has changed. Cascades upwards in the tree to the root node. |
| SubNodeStateChanged | Is activated when the processing status of a child has changed. Is triggered by a SingleNode. Continues in the tree only up to the direct parent node. |
| ThreadUpdateLastLogical |
Sets threadsafe LastLogical.
(Inherited from LogicalNode) |
| ThreadUpdateLastLogicalState |
Sets threadsafe LastLogicalState.
(Overwrites LogicalNodeThreadUpdateLastLogicalState(NodeLogicalState)) |
| ThreadUpdateLastSingleNodesFinished | Sets threadsafe LastSingleNodesFinished. |
| ThreadUpdateLastState |
Sets threadsafe LastState.
(Inherited from LogicalNode) |
| ToString |
Overridden ToString() method.
(Inherited from LogicalNode) |
| Traverse(ActionInt32, T) |
Goes recursively through the tree and calls the action for each node.
(Inherited from GenericTreeT) |
| Traverse(FuncInt32, T, Object, Object) |
Goes recursively through the tree and calls the action for each node.
(Inherited from GenericTreeT) |
| Traverse(Int32, ActionInt32, T) |
Recursive auxiliary routine for the public routine 'Traverse'.
(Inherited from GenericTreeT) |
| Traverse(Int32, FuncInt32, T, Object, Object, Object) |
Recursive auxiliary routine for the public routine 'Traverse'.
(Inherited from GenericTreeT) |
| UnMarkThreadAsInvalid |
Removes thread from the list of invalid threads.
(Inherited from LogicalNode) |
| UnregisterTriggeredNode |
Sets the subtree to non-startable.
(Inherited from LogicalNode) |
| UserBreak |
Is called up if the subtree has been deliberately stopped by the user.
(Inherited from LogicalNode) |
| UserRun |
Starts the processing of this node after a start
by the user. Gives the information that the start
by the user in the TreeEvent to Run.
(Inherited from LogicalNode) |
Events| Name | Description of the | |
|---|---|---|
 | ExceptionCleared |
Is called when an exception is cleared.
(Inherited from LogicalNode) |
| ExceptionRaised |
Is called if an exception has occurred.
(Inherited from LogicalNode) |
| NodeLastNotNullLogicalChanged |
Called when the logical result of a node has changed
and is not equal to zero.
(Inherited from LogicalNode) |
| NodeLogicalChanged |
Is called when the logical result of a node has changed.
(Inherited from LogicalNode) |
| NodeProgressChanged |
Is called up when the processing progress of a node has changed.
(Inherited from LogicalNode) |
| NodeProgressFinished |
Is called when the processing of a node has been completed (regardless of the result).
(Inherited from LogicalNode) |
| NodeProgressStarted |
Is called up when a node has been started.
(Inherited from LogicalNode) |
| NodeResultChanged |
Is called up when the result of a node has changed.
Serves to optimise the calculation of the logical state of the superordinate
restart the node.
(Inherited from LogicalNode) |
| NodeStateChanged |
Is called up when the processing status of a node has changed.
(Inherited from LogicalNode) |
| NodeWorkersStateChanged |
Called when the overall status of the node assigned to the
assigned worker has changed.
(Inherited from LogicalNode) |
| PropertiesChanged |
This event from IVishnuNode.INotifyPropertiesChanged can be subscribed to by LogicalNodeViewmodel.
This receives a string list with property names via the transferred PropertiesChangedEventArgs
and can in turn inform the UI via INotifyProperyChanged.
(Inherited from LogicalNode) |
Fields| Name | Description of the | |
|---|---|---|
 | _lastRun |
Time of the last start of the node (internal field).
(Inherited from LogicalNode) |
| _nextRunInfo |
Info text about the next start of the node (if known) or null (internal field).
(Inherited from LogicalNode) |
| _parentViewLocker |
Used to block thread-safe access to ParentView.
(Inherited from LogicalNode) |
| AppSettings |
Application settings.
(Inherited from LogicalNode) |
| CancellationToken |
The CancellationTokenSource can be used to set this token to
cancellation, which in this node leads to the call
of the cancelNotification routine.
(Inherited from LogicalNode) |
| ExceptionLocker |
Used to temporarily block exceptions.
(Inherited from LogicalNode) |
| IsRunRequired |
True: the node should be started.
(Inherited from LogicalNode) |
| IsTaskActiveOrScheduled |
True: the node is currently active or controlled by a timer.
(Inherited from LogicalNode) |
 | LastExceptions |
Exception that occurred during the last run or null;
(Inherited from LogicalNode) |
| LastLogicalLocker |
Used to temporarily block LastLogical.
(Inherited from LogicalNode) |
| LastLogicalStateLocker |
Used to temporarily lock LastLogicalState.
(Inherited from LogicalNode) |
| LastSingleNodesFinishedLocker | Used to temporarily block LastSingleNodesFinished. |
| LastStateLocker |
Used to temporarily block LastState.
(Inherited from LogicalNode) |
| Mother |
The owner of the node.
(Inherited from GenericTreeT) |
| ResultLocker |
Used to temporarily block results.
(Inherited from LogicalNode) |
| RootJobList |
Next higher JobList for this node or the node itself,
if it is a JobList.
(Inherited from LogicalNode) |
| SubLastNotNullLogicalLocker |
Used to temporarily block LastLogical.
(Inherited from LogicalNode) |
| SubNodeStateChangedLocker | Used to temporarily lock for resetting (invalidating) different for the determination of the current status of the ParentNode important Counter. |
| ThreadRefreshParentNodeLocker | Used to temporarily lock for resetting (invalidating) different for the determination of the current status of the ParentNode important Counter. |
| TreeRootJobList |
Top JobList.
(Inherited from LogicalNode) |
Remarks
File: NodeParent.cs
Author: Erik Nagel
03.06.2018 Erik Nagel: created
See also