some documentation, question about HasParametersIF,

variable in ParameterHelper intialized (compiler warning)
This commit is contained in:
Robin Müller 2019-12-05 12:21:06 +01:00
parent 9c3a9323b7
commit 950a48078c
4 changed files with 21 additions and 24 deletions

View File

@ -5,10 +5,10 @@
#include <framework/returnvalues/HasReturnvaluesIF.h>
/**
* Documentation: Dissertation Baetz p.138
*
* This is an interface to decouple device communication from
* @brief This is an interface to decouple device communication from
* the device handler to allow reuse of these components.
* @details
* Documentation: Dissertation Baetz p.138
* It works with the assumption that received data
* is polled by a component. There are four generic steps of device communication:
*

View File

@ -331,9 +331,10 @@ protected:
uint32_t parameter = 0);
/**
*
* @param parameter2 additional parameter
* Send reply to a command, differentiate between raw command
* and normal command.
* @param status
* @param parameter
*/
void replyToCommand(ReturnValue_t status, uint32_t parameter = 0);
@ -532,10 +533,9 @@ protected:
size_t commandDataLen) = 0;
/**
* fill the #deviceCommandMap
*
* @brief fill the #deviceCommandMap
* called by the initialize() of the base class
*
* @details
* This is used to let the base class know which replies are expected.
* There are different scenarios regarding this:
* - "Normal" commands. These are commands, that trigger a direct reply from the device. In this case, the id of the command should be added to the command map
@ -766,7 +766,7 @@ protected:
/**
* Used to retrieve logical address
* @return
* @return logicalAddress
*/
virtual uint32_t getLogicalAddress();
Mode_t getBaseMode(Mode_t transitionMode);
@ -863,12 +863,8 @@ protected:
ActionHelper actionHelper;
private:
/**
* State a cookie is in.
*
@ -957,11 +953,6 @@ private:
void buildRawDeviceCommand(CommandMessage* message);
void buildInternalCommand(void);
// /**
// * Send a reply with the current mode and submode.
// */
// void announceMode(void);
/**
* Decrement the counter for the timout of replies.
*
@ -1066,6 +1057,11 @@ private:
*/
ReturnValue_t switchCookieChannel(object_id_t newChannelId);
/**
* Handle device handler messages (e.g. commands sent by PUS Service 2)
* @param message
* @return
*/
ReturnValue_t handleDeviceHandlerMessage(CommandMessage *message);

View File

@ -46,6 +46,7 @@ public:
* @param startAtIndex
* @return
*/
// shouldnt startAtIndex be uint8?
virtual ReturnValue_t getParameter(uint8_t domainId, uint16_t parameterId,
ParameterWrapper *parameterWrapper,
const ParameterWrapper *newValues, uint16_t startAtIndex) = 0;

View File

@ -3,7 +3,7 @@
#include <framework/parameters/ParameterMessage.h>
ParameterHelper::ParameterHelper(ReceivesParameterMessagesIF* owner) :
owner(owner), storage(NULL) {
owner(owner), ownerQueueId(0), storage(NULL){
}