CSB doc correction

This commit is contained in:
Robin Müller 2019-10-28 12:48:41 +01:00
parent d79f072851
commit b51536c772
2 changed files with 9 additions and 3 deletions

View File

@ -21,6 +21,10 @@ public:
uint8_t messageDepth = 10, uint8_t parameterDomainBase = 0xF0); uint8_t messageDepth = 10, uint8_t parameterDomainBase = 0xF0);
virtual ~FailureIsolationBase(); virtual ~FailureIsolationBase();
virtual ReturnValue_t initialize(); virtual ReturnValue_t initialize();
/**
* This is called by the DHB in performOperation()
*/
void checkForFailures(); void checkForFailures();
MessageQueueId_t getEventReceptionQueue(); MessageQueueId_t getEventReceptionQueue();
virtual void triggerEvent(Event event, uint32_t parameter1 = 0, virtual void triggerEvent(Event event, uint32_t parameter1 = 0,

View File

@ -64,7 +64,7 @@ public:
virtual ~CommandingServiceBase(); virtual ~CommandingServiceBase();
/*** /***
* This is the periodic called function * This is the periodically called function.
* Handle request queue for external commands. * Handle request queue for external commands.
* Handle command Queue for internal commands. * Handle command Queue for internal commands.
* @param opCode is unused here at the moment * @param opCode is unused here at the moment
@ -226,13 +226,15 @@ protected:
* and the respective PUS Commanding Service once the execution has started. * and the respective PUS Commanding Service once the execution has started.
* The PUS Commanding Service receives replies from the target device and forwards them by calling this function. * The PUS Commanding Service receives replies from the target device and forwards them by calling this function.
* There are different translations of these replies to specify how the Command Service proceeds. * There are different translations of these replies to specify how the Command Service proceeds.
* @param reply Command Message which determines how CommandServiceBase proceeds * @param reply Command Message which contains information about the command
* @param previousCommand * @param previousCommand
* @param state * @param state
* @param optionalNextCommand * @param optionalNextCommand
* @param objectId * @param objectId
* @param isStep Flag value to mark steps of command execution * @param isStep Flag value to mark steps of command execution
* @return * @return - @c RETURN_OK, @c EXECUTION_COMPLETE or @c NO_STEP_MESSAGE to generate TC verification success
* - @c INVALID_REPLY can handle unrequested replies
* - Anything else triggers a TC verification failure
*/ */
virtual ReturnValue_t handleReply(const CommandMessage *reply, virtual ReturnValue_t handleReply(const CommandMessage *reply,
Command_t previousCommand, uint32_t *state, Command_t previousCommand, uint32_t *state,