LogicalNode class

SystemObject
  NetEti.GlobalsGenericTreeLogicalNode
    LogicalTaskTreeLogicalNode
      LogicalTaskTreeNodeParent
      LogicalTaskTreeSingleNode
      LogicalTaskTreeUndefinedLogicalNodeClass

public abstract class LogicalNode : GenericTree<LogicalNode>,
	 
	IVishnuNode, INotifyPropertiesChanged

Public MustInherit Class LogicalNode
	Inherits GenericTree(Of LogicalNode)
	
	Implements IVishnuNode, INotifyPropertiesChanged

public ref class LogicalNode abstract : public GenericTree<LogicalNode^>,
	 
	IVishnuNode, INotifyPropertiesChanged

[<AbstractClassAttribute>]
type LogicalNode = 
    class
        inherit GenericTree<LogicalNode>
        interface IVishnuNode
        interface INotifyPropertiesChanged
    end

	Name	Description of the
	LogicalNode(LogicalNode, JobList, TreeParameters)	Constructor for a snapshot dummy element.
	LogicalNode(String, LogicalNode, JobList, TreeParameters)	Constructor

Back to the top

	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.
	CanTreeStart	Indicates whether a (partial) tree can be started, i.e. that a node with children all its children can be started (recursively) or for an end node (checker) without children that can be started itself.
	Children	List of the children of a node. (Inherited from GenericTreeT)
	DebugMode	Additional test outputs can be made for True. Default: False.
	Id	The unique identifier of the node.
	IdInfo	The unique identifier of the node (identical to the property Id).
	IdPath	Path to the node reduced to a chain of Ids separated by '/'.
	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.
	IsActive	If true, the subtree/node is in an active (started) state.
	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.
	IsInSleepTime	Returns true if a rest period defined by the user is currently in progress. for Vishnu actors (checkers) is running.
	IsInSnapshot	With True, this LogicalNode is located within a snapshot.
	IsSnapshotDummy	With True, this node is only used for display and does not allow any other functions.
	LastExecutingTreeEvent	The last triggering TreeEvent (for TreeEvent-triggered nodes) or zero.
	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.
	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.
	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).
	LastResult	Result for this node.
	LastRun	Time of the last start of the node.
	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.
	Level	The hierarchy level of the node.
	LevelInfo	The hierarchy level of the node (identical to the property level).
	LockName	Optional name used for global locking. Is used if ThreadLocked is set.
	Logger	An optional logger that is activated for certain events is called or null.
	Logical	The logical state of a node; this is ultimately what the entire processing.
	LogicalState	The result state of the node: None, Start, Done, Fault, Timeout, UserAbort.
	Name	"Human-friendly" representation of the node.
	NameId	Combination of name and Id of the node.
	NameInfo	"Human-friendly" representation of the node.
	NextRun	Time of the next start of the node (if known) or DateTime.MinValue.
	NextRunInfo	Info text about the next start of the node (if known) or null.
	NodeType	The node type: None, NodeConnector, ValueModifier, JobConnector, Constant, Checker, NodeList, JobList, Snapshot.
	ParentView	The parent control in which this node is displayed.
	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.
	PathInfo	The path to the node (identical to the Path property).
	ReferencedNodeId	Id of an originally referenced node or null.
	ReferencedNodeName	Name of an originally referenced node or null.
	ReferencedNodePath	Path of an originally referenced node or null.
	SingleNodes	Number of SingleNodes (ultimately checkers) at the end of a (sub)tree.
	SingleNodesFinished	Percentage value for the proportion of terminated SingleNodes (ultimately checker) at the end of a (partial) tree.
	SleepTimeFrom	The start of a possible rest period.
	SleepTimeTo	The end of a possible rest period.
	StartCollapsed	With True, the job is displayed collapsed at startup if the UI supports this.
	State	The processing status of a node: None, Waiting, Working, Finished, Triggered, Ready (= Finished \| Triggered), CanStart (= None\|Ready), Busy (= Waiting \| Working).
	ThreadLocked	If True, each thread is locked via the class so that non-thread-safe checkers are serialized; Default: False;
	TreeParams	Additional parameters, some that apply to the entire tree validity and some node-specific parameters or zero.
	Trigger	An optional trigger that calls the job repeatedly or null (internally overrides BreakWithResult).
	TriggeredRunDelay	Delays the start of a node (and InitNodes). Can be used for loops in controlled jobs. Default: 0 (milliseconds).
	TypeInfo	The node type: None, NodeConnector, ValueModifier, Constant, Checker. NodeTypes
	UserControlPath	The path to the UserControl currently to be loaded dynamically.
	WorkersState	A collective status for all assigned workers.

Back to the top

	Name	Description of the
	AllowSnapshots	Allows snapshots.
	Break	If necessary, log out of the trigger, Cancel the task via CancellationToken, set status.
	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).
	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.
	Equals	Compares the content of this LogicalNode according to logical aspects with the content of a transferred LogicalNode. (Overwrites ObjectEquals(Object))
	FindEventTriggers	Searches for relevant triggers for an event.
	FindNodeById	A derivative of LogicalNode can use this to create its own thread cause it to be cancelled.
	GetEnvironment	Returns the ConcurrentDictionary Environment as simple Dictionary Results. Use the internal routine GetResultsFromResultList().
	GetHashCode	Generates a hash code for this LogicalNode. (Overwrites ObjectGetHashCode)
	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).
	GetResults	Returns the ConcurrentDictionary ResultList as a simple Dictionary Results. Use the internal routine GetResultsFromResultList().
	GetTopRootJobList	Returns the topmost Root-JobList valid for the node.
	InitFromNode	Sets certain properties to the values of the transferred LogicalNode "source".
	InitNode	Resets the node to the start settings.
	Invalidate	Deletes internal caches so that everything is re-evaluated.
	LogWithDistinctTime	Write a message with a short sleeptime before and after to ensure prompt processes can be visualised later in the log in chronological order.
	MarkThreadAsInvalidIfActive	Adds thread to the list of invalid threads, if the thread is still active.
	OnLastNotNullLogicalChanged	Triggers the NodeLastNotNullLogicalChanged event.
	OnNodeBreaked	Triggers the NodeBreaked event.
	OnNodeProgressChanged	Triggers the NodeProgressChanged event.
	OnNodeProgressFinished	Triggers the NodeProgressFinished event.
	OnNodeProgressStarted	Triggers the NodeStarted event.
	OnNodeWorkersStateChanged	Triggers the NodeWorkersStateChanged event.
	PauseTree	Stops processing in the tree.
	ProcessTreeEvent	Triggers further processing for the current TreeEvent (trigger, logger).
	ProhibitSnapshots	Prevents snapshots.
	RaiseNodeLastNotNullLogicalChangedWithTreeEvent	Triggers the TreeEvent "AnyLastNotNullLogicalHasChanged" and calls "OnNodeLastNotNullLogicalChanged".
	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.
	Refresh	Ensures immediate re-evaluation of all cashed statuses.
	RegisterTriggeredNodes	Registers all triggered nodes of a subtree with their triggers.
	Reload	Is called up when the subtree is to be reloaded.
	ResetAllTreeEventTriggeringNodes	Resets all nodes in the subtree on which others depend via TreeEvent.
	ResetAllTreeNodes	Resets all nodes in the entire tree.
	ResetPartTreeNodes	Resets all nodes in the subtree from branch.
	ResumeTree	Allows a paused tree to continue running.
	Run	Checks whether a node can be started and then starts the node, its trigger, or both (via StartNodeOrTrigger).
	SetTreeCollapsed	Sets the StartCollapsed property for an entire (sub)tree.
	SetWorkersState	Sets a common (combined) NodeWorkerState 'WorkersState' for all NodeWorkers. Returns NodeWorkersState.
	SleepIfNecessary	Inserts System.Sleeps to relieve the system. Is more finely adjustable than fixed sleeps in nested inner loops.
	ThreadUpdateLastLogical	Sets threadsafe LastLogical.
	ThreadUpdateLastLogicalState	Sets threadsafe LastLogicalState.
	ThreadUpdateLastState	Sets threadsafe LastState.
	ToString	Overridden ToString() method. (Overwrites ObjectToString)
	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.
	UnregisterTriggeredNode	Sets the subtree to non-startable.
	UserBreak	Is called up if the subtree has been deliberately stopped by the user.
	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.

Back to the top

	Name	Description of the
	AllNodesStateChanged	Is called up when the processing status of a node has changed.
	ExceptionCleared	Is called when an exception is cleared.
	ExceptionRaised	Is called if an exception has occurred.
	NodeLastNotNullLogicalChanged	Called when the logical result of a node has changed and is not equal to zero.
	NodeLogicalChanged	Is called when the logical result of a node has changed.
	NodeProgressChanged	Is called up when the processing progress of a node has changed.
	NodeProgressFinished	Is called when the processing of a node has been completed (regardless of the result).
	NodeProgressStarted	Is called up when a node has been started.
	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.
	NodeStateChanged	Is called up when the processing status of a node has changed.
	NodeWorkersStateChanged	Called when the overall status of the node assigned to the assigned worker has changed.
	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.

Back to the top

	Name	Description of the
	_lastRun	Time of the last start of the node (internal field).
	_nextRunInfo	Info text about the next start of the node (if known) or null (internal field).
	_parentViewLocker	Used to block thread-safe access to ParentView.
	AppSettings	Application settings.
	CancellationToken	The CancellationTokenSource can be used to set this token to cancellation, which in this node leads to the call of the cancelNotification routine.
	ExceptionLocker	Used to temporarily block exceptions.
	IsRunRequired	True: the node should be started.
	IsSnapshotProhibited	Returns true if no snapshots are currently permitted.
	IsTaskActiveOrScheduled	True: the node is currently active or controlled by a timer.
	IsTreeFlushing	Returns true if processing in the tree is currently to be stopped but logical changes that have already been created can still be distributed.
	IsTreePaused	Returns true if processing in the tree has just been stopped.
	LastExceptions	Exception that occurred during the last run or null;
	LastLogicalLocker	Used to temporarily block LastLogical.
	LastLogicalStateLocker	Used to temporarily lock LastLogicalState.
	LastStateLocker	Used to temporarily block LastState.
	Mother	The owner of the node. (Inherited from GenericTreeT)
	ResultLocker	Used to temporarily block results.
	RootJobList	Next higher JobList for this node or the node itself, if it is a JobList.
	SubLastNotNullLogicalLocker	Used to temporarily block LastLogical.
	TreeRootJobList	Top JobList.

Back to the top

File: LogicalNode.cs Author: Erik Nagel 01.12.2012 Erik Nagel: created 06.08.2016 Erik Nagel: IVishnuNode implemented.

Reference

LogicalTaskTree namespace