ifw-sup  3.0.0-pre3
Public Member Functions | List of all members
sup::subsim::common::ActionsSetup Class Reference

#include <actionsSetup.hpp>

Inheritance diagram for sup::subsim::common::ActionsSetup:

Public Member Functions

 ActionsSetup ()
 
void Start (scxml4cpp::Context *c)
 
void Stop (scxml4cpp::Context *c)
 
void Done (scxml4cpp::Context *c)
 
void Error (scxml4cpp::Context *c)
 
void Timeout (scxml4cpp::Context *c)
 
 ActionsSetup (const ActionsSetup &)=delete
 Disable copy constructor. More...
 
ActionsSetupoperator= (const ActionsSetup &)=delete
 Disable assignment operator. More...
 

Detailed Description

Class grouping the actions related to the Setup event.

Constructor & Destructor Documentation

◆ ActionsSetup() [1/2]

sup::subsim::common::ActionsSetup::ActionsSetup ( )

Constructor.

Parameters
[in]iosReference to the event loop.
[in]smState machine reference
[in]data_ctxData shared within the application among actions and activities.

◆ ActionsSetup() [2/2]

sup::subsim::common::ActionsSetup::ActionsSetup ( const ActionsSetup )
delete

Disable copy constructor.

Member Function Documentation

◆ Done()

void sup::subsim::common::ActionsSetup::Done ( scxml4cpp::Context *  c)

Implementation of the Done callback. This method implements the actions when the Setup event was finalized.

Parameters
[in]cLast event received.

◆ Error()

void sup::subsim::common::ActionsSetup::Error ( scxml4cpp::Context *  c)

Implementation of the Error callback. This method implements the actions when the Setup event was finalized with an error.

Parameters
[in]cLast event received.

◆ operator=()

ActionsSetup& sup::subsim::common::ActionsSetup::operator= ( const ActionsSetup )
delete

Disable assignment operator.

◆ Start()

void sup::subsim::common::ActionsSetup::Start ( scxml4cpp::Context *  c)

Implementation of the Start callback.

Parameters
[in]cLast event received which should be a Start event (the Start event is triggered by a ReqSetup request).

◆ Stop()

void sup::subsim::common::ActionsSetup::Stop ( scxml4cpp::Context *  c)

Implementation of the Stop callback. This callback:

  • replies back for the originator of the ReqStop request.
Parameters
[in]cLast event received which should be a Stop event (the Stop event is triggered by a ReqStop request).

◆ Timeout()

void sup::subsim::common::ActionsSetup::Timeout ( scxml4cpp::Context *  c)

Implementation of the Timeout callback. This method implements the actions when the Setup event was finalized unexpectly.

Parameters
[in]cLast event received.

The documentation for this class was generated from the following files: