Module Goal

Core -- Base class that models processes to achieve goals.


GOAL models processes that have an objective with a defined achievement. Derived classes implement the ways how the achievements can be realized.


Author: Sven Van de Velde (FlightControl)


Global(s)

GOAL

GOAL class, extends Fsm#FSM

GOAL models processes that have an objective with a defined achievement.

Type GOAL

GOAL:Achieved()

Achieved Trigger for GOAL

GOAL.AchievedScheduler
GOAL.ArchievedScheduler
GOAL:CheckAchieved(From, Event, To)
GOAL.FsmStateAchieved
GOAL.FsmStateOff
GOAL.FsmStateOn
GOAL:IsAchieved()

IsAchieved Trigger for GOAL

GOAL:New()

GOAL Constructor.

GOAL:OnAfterAchieved(From, Event, To)

Achieved Handler OnAfter for GOAL

GOAL:OnAfterIsAchieved(From, Event, To)

IsAchieved Handler OnAfter for GOAL

GOAL:OnAfterStart(From, Event, To)

Start Handler OnAfter for GOAL

GOAL:OnAfterStop(From, Event, To)

Stop Handler OnAfter for GOAL

GOAL:OnBeforeAchieved(From, Event, To)

Achieved Handler OnBefore for GOAL

GOAL:OnBeforeIsAchieved(From, Event, To)

IsAchieved Handler OnBefore for GOAL

GOAL:OnBeforeStart(From, Event, To)

Start Handler OnBefore for GOAL

GOAL:OnBeforeStop(From, Event, To)

Stop Handler OnBefore for GOAL

GOAL:OnEnterAchieved(From, Event, To)

Achieved State Handler OnEnter for GOAL

GOAL:OnEnterOff(From, Event, To)

Off State Handler OnEnter for GOAL

GOAL:OnEnterOn(From, Event, To)

On State Handler OnEnter for GOAL

GOAL:OnLeaveAchieved(From, Event, To)

Achieved State Handler OnLeave for GOAL

GOAL:OnLeaveOff(From, Event, To)

Off State Handler OnLeave for GOAL

GOAL:OnLeaveOn(From, Event, To)

On State Handler OnLeave for GOAL

GOAL:Start()

Start Trigger for GOAL

GOAL.States
GOAL:Stop()

Stop Trigger for GOAL

GOAL:__Achieved(Delay)

Achieved Asynchronous Trigger for GOAL

GOAL:__IsAchieved(Delay)

IsAchieved Asynchronous Trigger for GOAL

GOAL:__Start(Delay)

Start Asynchronous Trigger for GOAL

GOAL:__Stop(Delay)

Stop Asynchronous Trigger for GOAL

GOAL:onafterOff(From, Event, To)
GOAL:onafterOn(From, Event, To)

Global(s)

#GOAL GOAL

GOAL class, extends Fsm#FSM

GOAL models processes that have an objective with a defined achievement.

Derived classes implement the ways how the achievements can be realized.

1. GOAL constructor

  • GOAL.New(): Creates a new GOAL object.

2. GOAL is a finite state machine (FSM).

2.1 GOAL States

  • Off: The goal is not timely measured.
  • On: The goal is timely being measured.
  • Achieved: The objective is achieved.

2.2 GOAL Events

Type Goal

Type GOAL

Field(s)

GOAL:Achieved()

Achieved Trigger for GOAL

GOAL.AchievedScheduler
GOAL.ArchievedScheduler
GOAL:CheckAchieved(From, Event, To)

Parameters

  • From :

  • Event :

  • To :

#string GOAL.FsmStateAchieved
#string GOAL.FsmStateOff
#string GOAL.FsmStateOn
GOAL:IsAchieved()

IsAchieved Trigger for GOAL

GOAL:New()

GOAL Constructor.

Return value

#GOAL:

GOAL:OnAfterAchieved(From, Event, To)

Achieved Handler OnAfter for GOAL

Parameters

  • #string From :

  • #string Event :

  • #string To :

GOAL:OnAfterIsAchieved(From, Event, To)

IsAchieved Handler OnAfter for GOAL

Parameters

  • #string From :

  • #string Event :

  • #string To :

GOAL:OnAfterStart(From, Event, To)

Start Handler OnAfter for GOAL

Parameters

  • #string From :

  • #string Event :

  • #string To :

GOAL:OnAfterStop(From, Event, To)

Stop Handler OnAfter for GOAL

Parameters

  • #string From :

  • #string Event :

  • #string To :

GOAL:OnBeforeAchieved(From, Event, To)

Achieved Handler OnBefore for GOAL

Parameters

  • #string From :

  • #string Event :

  • #string To :

Return value

#boolean:

GOAL:OnBeforeIsAchieved(From, Event, To)

IsAchieved Handler OnBefore for GOAL

Parameters

  • #string From :

  • #string Event :

  • #string To :

Return value

#boolean:

GOAL:OnBeforeStart(From, Event, To)

Start Handler OnBefore for GOAL

Parameters

  • #string From :

  • #string Event :

  • #string To :

Return value

#boolean:

GOAL:OnBeforeStop(From, Event, To)

Stop Handler OnBefore for GOAL

Parameters

  • #string From :

  • #string Event :

  • #string To :

Return value

#boolean:

GOAL:OnEnterAchieved(From, Event, To)

Achieved State Handler OnEnter for GOAL

Parameters

  • #string From :

  • #string Event :

  • #string To :

GOAL:OnEnterOff(From, Event, To)

Off State Handler OnEnter for GOAL

Parameters

  • #string From :

  • #string Event :

  • #string To :

GOAL:OnEnterOn(From, Event, To)

On State Handler OnEnter for GOAL

Parameters

  • #string From :

  • #string Event :

  • #string To :

GOAL:OnLeaveAchieved(From, Event, To)

Achieved State Handler OnLeave for GOAL

Parameters

  • #string From :

  • #string Event :

  • #string To :

Return value

#boolean:

GOAL:OnLeaveOff(From, Event, To)

Off State Handler OnLeave for GOAL

Parameters

  • #string From :

  • #string Event :

  • #string To :

Return value

#boolean:

GOAL:OnLeaveOn(From, Event, To)

On State Handler OnLeave for GOAL

Parameters

  • #string From :

  • #string Event :

  • #string To :

Return value

#boolean:

GOAL:Start()

Start Trigger for GOAL

GOAL.States
GOAL:Stop()

Stop Trigger for GOAL

GOAL:__Achieved(Delay)

Achieved Asynchronous Trigger for GOAL

Parameter

  • #number Delay :

GOAL:__IsAchieved(Delay)

IsAchieved Asynchronous Trigger for GOAL

Parameter

  • #number Delay :

GOAL:__Start(Delay)

Start Asynchronous Trigger for GOAL

Parameter

  • #number Delay :

GOAL:__Stop(Delay)

Stop Asynchronous Trigger for GOAL

Parameter

  • #number Delay :

GOAL:onafterOff(From, Event, To)

Parameters

  • From :

  • Event :

  • To :

GOAL:onafterOn(From, Event, To)

Parameters

  • From :

  • Event :

  • To :