ValueModifierT Class

Filters the ReturnObject of an INodeChecker by type and, if applicable, format string.

Inheritance hierarchy

SystemObject
  LogicalTaskTreeNodeShellBase
    LogicalTaskTreeNodeCheckerBase
      LogicalTaskTreeValueModifierT

Namespace: LogicalTaskTree
Assembly: LogicalTaskTree (in LogicalTaskTree.dll) Version: 1.0.0+df0404e911d6c38eaed3bb1bb1acfc482d417643

Syntax

C++

Copy

public class ValueModifier<T> : NodeCheckerBase

Public Class ValueModifier(Of T)
	
	Inherits NodeCheckerBase

generic<type name T>
public ref class ValueModifier : public NodeCheckerBase

type ValueModifier<'T> = 
    class
        inherit NodeCheckerBase
    end

Type parameters

T: Concrete type of the instance (Boolean, Int16, Int32, Int64, DateTime, Object).

The ValueModifierT Type exposes the following members.

Constructors

	Name	Description of the
	ValueModifierT(NodeCheckerBase)	Constructor - takes over the assigned NodeCheckerBase.
	ValueModifierT(String)	Constructor - takes the name of an already defined NodeCheckerBase.
	ValueModifierT(String, NodeCheckerBase)	Constructor - takes over a format string or the path of an external IValueModifier dll and the assigned NodeCheckerBase.
	ValueModifierT(String, String)	Constructor - takes over a format string or the path of an external IValueModifier dll and the name of an already defined NodeCheckerBase.

Back to the top

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)
	CheckerBaseReferenceName	Reference to an executing NodeCheckerBase.
	CheckerLogger	An optional logger that is called by the node or zero. Is provided by the IJobProvider during instantiation. (Inherited from NodeCheckerBase)
	CheckerTrigger	An optional trigger that calls the job repeatedly or null (internally sets BreakWithResult to false). Is provided by the IJobProvider during instantiation. (Overwrites NodeCheckerBaseCheckerTrigger)
	FormatString	Formatting string.
	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)
	NodeCheckerBase	Executing Checker or ValueModifier.
	ReferencedNodeName	Name of an originally referenced node or null. (Inherited from NodeCheckerBase)
	ReturnObject	The modified ReturnObject of the assigned INodeChecker. (Overwrites NodeCheckerBaseReturnObject)
	SlavePathName	Path to the external ValueModifier.
	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)

Back to the top

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)
	GetCheckerReference	Returns the name of the checker that is to be assigned to this ValueConverter. (Overwrites NodeCheckerBaseGetCheckerReference)
	ModifyValue	Converts a value to the value specified for this ValueModifier valid format. (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)

Back to the top

Events

	Name	Description of the
	NodeProgressChanged	Is called up if the processing progress of the checker has changed. (Inherited from NodeCheckerBase)

Back to the top

Notes

File: ValueModifier.cs Author: Erik Nagel 27.05.2013 Erik Nagel: created

Reference

LogicalTaskTree namespace