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

CommandingServiceBase documentation

Browse Source
This commit is contained in:
Robin Müller 2020-01-13 00:14:14 +01:00
parent d2325e60b6
commit 1369e792b4
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
tmtcservices/CommandingServiceBase.h
View File

@ -195,7 +195,7 @@ protected:
* @param tcData Application Data of TC Packet * @param tcData Application Data of TC Packet
* @param tcDataLen * @param tcDataLen
* @param id MessageQueue ID is stored here * @param id MessageQueue ID is stored here
* @param objectId * @param objectId Object ID is extracted and stored here
* @return - @c RETURN_OK on success * @return - @c RETURN_OK on success
* - @c RETURN_FAILED * - @c RETURN_FAILED
* - @c CSB or implementation specific return codes * - @c CSB or implementation specific return codes
@ -206,15 +206,15 @@ protected:
/** /**
* After the Message Queue and Object ID are determined, * After the Message Queue and Object ID are determined,
* the command is prepared by using an implementation specific CommandMessage type which is sent to * the command is prepared by using an implementation specific CommandMessage type
* the target device. It contains all necessary information for the device to * which is sent to the target object.
* execute telecommands. * It contains all necessary information for the device to execute telecommands.
* @param message * @param message
* @param subservice * @param subservice
* @param tcData * @param tcData
* @param tcDataLen * @param tcDataLen
* @param state * @param state
* @param objectId * @param objectId Target object ID
* @return * @return
*/ */
virtual ReturnValue_t prepareCommand(CommandMessage *message, virtual ReturnValue_t prepareCommand(CommandMessage *message,
@ -226,11 +226,11 @@ 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 contains information about the command * @param reply[out] Command Message which contains information about the command
* @param previousCommand * @param previousCommand [out]
* @param state * @param state
* @param optionalNextCommand * @param optionalNextCommand
* @param objectId * @param objectId Source object ID
* @param isStep Flag value to mark steps of command execution * @param isStep Flag value to mark steps of command execution
* @return - @c RETURN_OK, @c EXECUTION_COMPLETE or @c NO_STEP_MESSAGE to generate TC verification success * @return - @c RETURN_OK, @c EXECUTION_COMPLETE or @c NO_STEP_MESSAGE to generate TC verification success
* - @c INVALID_REPLY can handle unrequested replies * - @c INVALID_REPLY can handle unrequested replies