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

Update 'tmtcservices/CommandingServiceBase.h'

Browse Source 
Added a few comments
This commit is contained in:
Steffen Gaisser 2020-02-11 15:38:12 +01:00
parent 11861c0dbc
commit 3f2f76b8cf
1 changed files with 15 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
tmtcservices/CommandingServiceBase.h
View File

@ -106,8 +106,9 @@ public:
protected: protected:
/** /**
* Check the target subservice * Check the target subservice
* @param subservice * @param subservice[in]
* @return * @return -@c RETURN_OK on success
* -@c INVALID_SUBSERVICE if service is not known
*/ */
virtual ReturnValue_t isValidSubservice(uint8_t subservice) = 0; virtual ReturnValue_t isValidSubservice(uint8_t subservice) = 0;
@ -132,13 +133,15 @@ protected:
* the command is prepared by using an implementation specific CommandMessage type * the command is prepared by using an implementation specific CommandMessage type
* which is sent to the target object. * which is sent to the target object.
* It contains all necessary information for the device to execute telecommands. * It contains all necessary information for the device to execute telecommands.
* @param message * @param message[out] message to be sent to the object
* @param subservice * @param subservice[in] Subservice of the current communication
* @param tcData * @param tcData Additional data of the command
* @param tcDataLen * @param tcDataLen Length of the additional data
* @param state * @param state[out] Setable state of the communication
* @param objectId Target object ID * @param objectId Target object ID
* @return * @return - @c RETURN_OK on success
* - @c EXECUTION_COMPLETE if exectuin is finished
* - any other return code will be part of (1,4) start failure
*/ */
virtual ReturnValue_t prepareCommand(CommandMessage *message, virtual ReturnValue_t prepareCommand(CommandMessage *message,
uint8_t subservice, const uint8_t *tcData, uint32_t tcDataLen, uint8_t subservice, const uint8_t *tcData, uint32_t tcDataLen,
@ -149,10 +152,10 @@ 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[out] Command Message which contains information about the command * @param reply Command Message which contains information about the command
* @param previousCommand [out] * @param previousCommand Command_t of last command
* @param state * @param state state of the communication
* @param optionalNextCommand * @param optionalNextCommand[out] An optional next command which can be set in this function
* @param objectId Source object ID * @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