added basic documentation

This commit is contained in:
Robin Müller 2020-10-18 17:32:10 +02:00
parent 8e49806057
commit 88a89d6797

View File

@ -20,6 +20,19 @@ public:
ParameterId_t id); ParameterId_t id);
static void setParameterDumpReply(CommandMessage* message, static void setParameterDumpReply(CommandMessage* message,
ParameterId_t id, store_address_t storageID); ParameterId_t id, store_address_t storageID);
/**
* Command to set a load parameter message. The CCSDS / ECSS type in
* form of a PTC and a PFC is expected. See ECSS-E-ST-70-41C15 p.428
* for all types or the Type class in globalfunctions.
* @param message
* @param id
* @param storeId
* @param ptc
* @param pfc
* @param row
* @param column
*/
static void setParameterLoadCommand(CommandMessage* message, static void setParameterLoadCommand(CommandMessage* message,
ParameterId_t id, store_address_t storeId, uint8_t ptc, ParameterId_t id, store_address_t storeId, uint8_t ptc,
uint8_t pfc, uint8_t row, uint8_t column); uint8_t pfc, uint8_t row, uint8_t column);