TriggerBase class

Base class for specific triggers - must be derived. Triggers the 'triggerIt' event depending on the respective implementation. Implements the interface 'INodeTrigger' from 'Vishnu.Interchange.dll', via which the LogicalTaskTree of 'Vishnu' hooks into the event and activates the trigger can start and stop.

Inheritance hierarchy

SystemObject
Vishnu.InterchangeTriggerBase

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

Syntax

C++

Copy

public abstract class TriggerBase : INodeTrigger

Public MustInherit Class TriggerBase
	Implements INodeTrigger

public ref class TriggerBase abstract : INodeTrigger

[<AbstractClassAttribute>]
type TriggerBase = 
    class
        interface INodeTrigger
    end

The TriggerBase Type exposes the following members.

Constructors

	Name	Description of the
	TriggerBase	Standard constructor.

Back to the top

Properties

	Name	Description of the
	Info	Contains further information on the trigger. NextRun and NextRunInfo are implemented. To add further information, this property and/or the class TriggerInfo can be derived.
	TriggerName	The class derived from TriggerBase can set this name. It is then added later in OnTriggerFired in the TreeEvent.

Back to the top

Methods

	Name	Description of the
	EvaluateParametersOrFail	This routine is started by the "Start" routine before the trigger is started. Only the "\|UserRun" parameter is evaluated here and the "_isUserRun" variable is set accordingly. This routine must be overwritten to analyse the actual trigger parameters. If there are errors in the parameter evaluation, the routine "ThrowSyntaxException(string errorMessage)" can be called. can be called up.
	OnTriggerFired	This routine triggers the trigger event. This routine can be used to set the variables "_lastStart" and "_nextStart". can be overwritten.
	Start	Starts the trigger; the consumer should first have connected to triggerIt.
	Stop	Stops the trigger.
	ThrowSyntaxException	Is called if the transferred parameters were incorrect.

Back to the top

Fields

	Name	Description of the
	_info	Internal representation of the "Info" property.
	_isUserRun	Is automatically set to true if the owning node in the Vishnu tree is was started manually by the user. Can be used for the control of specific trigger behaviour can be used.
	_lastStart	Contains the time of the last trigger start or DateTime.MinValue.
	_nextStart	Contains the time of the next trigger start, if this occurs at all. is predictable, otherwise DateTime.MinValue.
	_syntaxInformation	Can be equipped with trigger-specific syntax information, is then output in the event of an error as part of an exception, default: null.

Back to the top

Remarks

Author: Erik Nagel 26.06.2021 Erik Nagel: created.

Reference

Vishnu.Interchange namespace