eive/fsfw
eive/fsfw
15
1
Fork 0
forked from fsfw/fsfw
Code Issues Pull Requests Releases 1 Wiki Activity

doc update

Browse Source
This commit is contained in:
Robin Müller 2020-10-29 16:45:47 +01:00
parent 42e611899b
commit 3d2778fdf7
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
action/HasActionsIF.h
View File

@ -47,9 +47,10 @@ public:
virtual MessageQueueId_t getCommandQueue() const = 0; virtual MessageQueueId_t getCommandQueue() const = 0;
/** /**
* Execute or initialize the execution of a certain function. * Execute or initialize the execution of a certain function.
* When used in conjunction with the ActionHelper class, returning * Returning #EXECUTION_FINISHED or a failure code, nothing else needs to
* a return code which is not equal to RETURN_OK will trigger a step reply * be done. When needing more steps, return RETURN_OK and issue steps and
* with step 0. * completion manually.
* One "step failed" or completion report must be issued!
*/ */
virtual ReturnValue_t executeAction(ActionId_t actionId, virtual ReturnValue_t executeAction(ActionId_t actionId,
MessageQueueId_t commandedBy, const uint8_t* data, size_t size) = 0; MessageQueueId_t commandedBy, const uint8_t* data, size_t size) = 0;