introduced command message base and

command message IF

housekeeping/HousekeepingMessage.cpp

@@ -1,18 +1,7 @@
 #include <framework/housekeeping/HousekeepingMessage.h>
 
-HousekeepingMessage::HousekeepingMessage() {
+HousekeepingMessage::HousekeepingMessage(MessageQueueMessage *message):
+		CommandMessageBase	(message) {}
 
-}
+HousekeepingMessage::~HousekeepingMessage() {}
 
-void HousekeepingMessage::setHkReportMessage() {
-}
-
-
-//void HousekeepingMessage::setAddHkReportStructMessage(CommandMessage *message,
-//		set_t setId, store_address_t packet) {
-//	message->setCommand(ADD_HK_REPORT_STRUCT);
-//	message->setParameter(setId);
-//	message->setParameter2(packet.raw);
-//}
-
-//void Housekeeping

housekeeping/HousekeepingMessage.h

@@ -1,6 +1,8 @@
 #ifndef FRAMEWORK_HK_HOUSEKEEPINGMESSAGE_H_
 #define FRAMEWORK_HK_HOUSEKEEPINGMESSAGE_H_
-#include <framework/ipc/CommandMessage.h>
+#include <framework/ipc/CommandMessageBase.h>
+#include <framework/ipc/FwMessageTypes.h>
+#include <framework/objectmanager/SystemObjectIF.h>
 #include <framework/storagemanager/StorageManagerIF.h>
 #include <limits>
 
@@ -23,15 +25,14 @@ union sid_t {
 };
 
 
-class HousekeepingMessage: public MessageQueueMessage {
+class HousekeepingMessage : public CommandMessageBase {
 public:
 	/**
 	 * No instances of a message shall be created, instead
 	 * a CommandMessage instance is manipulated.
 	 */
-	HousekeepingMessage();
+	HousekeepingMessage(MessageQueueMessage* message);
-//	HousekeepingMessage(const HousekeepingMessage&) = delete;
+	virtual ~HousekeepingMessage();
-//	HousekeepingMessage operator=(const HousekeepingMessage &) = delete;
 
 	static constexpr uint8_t MESSAGE_ID = messagetypes::HOUSEKEEPING;
 	static constexpr Command_t ADD_HK_REPORT_STRUCT =
@@ -78,8 +79,6 @@ public:
 	static constexpr Command_t MODIFY_DIAGNOSTICS_REPORT_COLLECTION_INTERVAL =
 			MAKE_COMMAND_ID(32);
 
-//	static void setAddHkReportStructMessage(CommandMessage* message,
-//			DevisetId, store_address_t packet);
 	static void setHkReportMessage();
 };
 

ipc/CommandMessage.cpp

@@ -1,6 +1,7 @@
+#include <framework/ipc/CommandMessage.h>
+
 #include <framework/devicehandlers/DeviceHandlerMessage.h>
 #include <framework/health/HealthMessage.h>
-#include <framework/ipc/CommandMessage.h>
 #include <framework/memory/MemoryMessage.h>
 #include <framework/modes/ModeMessage.h>
 #include <framework/monitoring/MonitoringMessage.h>
@@ -8,82 +9,86 @@
 #include <framework/tmstorage/TmStoreMessage.h>
 #include <framework/parameters/ParameterMessage.h>
 
-namespace messagetypes {
-// Implemented in config.
-void clearMissionMessage(CommandMessage* message);
-}
-
-
 CommandMessage::CommandMessage(MessageQueueMessage* receiverMessage):
-			internalMessage(receiverMessage) {
+			CommandMessageBase(receiverMessage) {
 	if(receiverMessage == nullptr) {
 		sif::error << "CommandMessage::CommandMessage: Don't pass a nullptr"
 				" as the message queue message, pass the address of an actual"
 				" message!" << std::endl;
 	}
-	internalMessage->messageSize = COMMAND_MESSAGE_SIZE;
+	internalMessage->setMessageSize(COMMAND_MESSAGE_SIZE);
 	setCommand(CMD_NONE);
 }
 
 CommandMessage::CommandMessage(MessageQueueMessage* messageToSet,
 		Command_t command, uint32_t parameter1, uint32_t parameter2):
-				internalMessage(messageToSet) {
+				CommandMessageBase(messageToSet) {
 	if(messageToSet == nullptr) {
 		sif::error << "CommandMessage::CommandMessage: Don't pass a nullptr"
 				" as the message queue message, pass the address of an actual"
 				" message!" << std::endl;
 	}
-	internalMessage->messageSize = COMMAND_MESSAGE_SIZE;
+	internalMessage->setMessageSize(COMMAND_MESSAGE_SIZE);
 	setCommand(command);
 	setParameter(parameter1);
 	setParameter2(parameter2);
 }
 
-Command_t CommandMessage::getCommand() const {
-	Command_t command;
-	memcpy(&command, internalMessage->getData(), sizeof(Command_t));
-	return command;
-}
-
-uint8_t CommandMessage::getMessageType() const {
-	return getCommand() >> 8 & 0xff;
-}
-
-void CommandMessage::setCommand(Command_t command) {
-	memcpy(internalMessage->getData(), &command, sizeof(command));
-}
-
 uint32_t CommandMessage::getParameter() const {
 	uint32_t parameter1;
-	memcpy(&parameter1, internalMessage->getData() + sizeof(Command_t),
+	memcpy(&parameter1, CommandMessageBase::getData(), sizeof(parameter1));
-			sizeof(parameter1));
 	return parameter1;
 }
 
 void CommandMessage::setParameter(uint32_t parameter1) {
-	memcpy(internalMessage->getData() + sizeof(Command_t),
+	memcpy(CommandMessageBase::getData(), &parameter1, sizeof(parameter1));
-			&parameter1, sizeof(parameter1));
 }
 
 uint32_t CommandMessage::getParameter2() const {
 	uint32_t parameter2;
-	memcpy(&parameter2, internalMessage->getData() + sizeof(Command_t)
+	memcpy(&parameter2, CommandMessageBase::getData() + sizeof(uint32_t),
-			+ sizeof(uint32_t), sizeof(parameter2));
+			sizeof(parameter2));
 	return parameter2;
 }
 
 void CommandMessage::setParameter2(uint32_t parameter2) {
-	memcpy(internalMessage-> getData() + sizeof(Command_t) + sizeof(uint32_t),
+	memcpy(CommandMessageBase::getData()  + sizeof(uint32_t), &parameter2,
-			&parameter2, sizeof(parameter2));
+			sizeof(parameter2));
 }
 
+size_t CommandMessage::getMinimumMessageSize() const {
+	return COMMAND_MESSAGE_SIZE;
+}
+
+size_t CommandMessage::getMaximumMessageSize() const {
+	return MessageQueueMessage::MAX_MESSAGE_SIZE;
+}
+
+bool CommandMessage::isClearedCommandMessage() {
+	return getCommand() == CMD_NONE;
+}
+
+void CommandMessage::setToUnknownCommand() {
+	Command_t initialCommand = getCommand();
+	clearCommandMessage();
+	setReplyRejected(UNKNOWN_COMMAND, initialCommand);
+}
+
+void CommandMessage::setReplyRejected(ReturnValue_t reason,
+		Command_t initialCommand) {
+	setCommand(REPLY_REJECTED);
+	setParameter(reason);
+	setParameter2(initialCommand);
+}
+
+
 void CommandMessage::clear() {
 	clearCommandMessage();
 }
 
 void CommandMessage::clearCommandMessage() {
-	switch(getMessageType()){
+	switch(this->getMessageType()){
-	case messagetypes::MODE_COMMAND:
+	case  messagetypes::MODE_COMMAND:
 		ModeMessage::clear(this);
 		break;
 	case messagetypes::HEALTH_COMMAND:
@@ -115,56 +120,3 @@ void CommandMessage::clearCommandMessage() {
 		break;
 	}
 }
-
-bool CommandMessage::isClearedCommandMessage() {
-	return getCommand() == CMD_NONE;
-}
-
-size_t CommandMessage::getMinimumMessageSize() const {
-	return COMMAND_MESSAGE_SIZE;
-}
-
-void CommandMessage::setToUnknownCommand() {
-	Command_t initialCommand = getCommand();
-	clearCommandMessage();
-	setReplyRejected(UNKNOWN_COMMAND, initialCommand);
-}
-
-void CommandMessage::setReplyRejected(ReturnValue_t reason,
-		Command_t initialCommand) {
-	setCommand(REPLY_REJECTED);
-	setParameter(reason);
-	setParameter2(initialCommand);
-}
-
-MessageQueueId_t CommandMessage::getSender() const {
-	return internalMessage->getSender();
-}
-
-uint8_t* CommandMessage::getBuffer() {
-	return internalMessage->getBuffer();
-}
-
-void CommandMessage::setSender(MessageQueueId_t setId) {
-	internalMessage->setSender(setId);
-}
-
-const uint8_t* CommandMessage::getBuffer() const {
-	return internalMessage->getBuffer();
-}
-
-uint8_t* CommandMessage::getData() {
-	return internalMessage->getData();
-}
-
-const uint8_t* CommandMessage::getData() const {
-	return internalMessage->getData();
-}
-
-size_t CommandMessage::getMessageSize() const {
-	return COMMAND_MESSAGE_SIZE;
-}
-
-size_t CommandMessage::getMaximumMessageSize() const {
-	return MessageQueueMessage::MAX_MESSAGE_SIZE;
-}

ipc/CommandMessage.h

@@ -1,33 +1,35 @@
 #ifndef FRAMEWORK_IPC_COMMANDMESSAGE_H_
 #define FRAMEWORK_IPC_COMMANDMESSAGE_H_
 
+#include <framework/ipc/CommandMessageBase.h>
 #include <framework/ipc/MessageQueueMessage.h>
 #include <framework/ipc/FwMessageTypes.h>
-#include <config/ipc/MissionMessageTypes.h>
 
-
+namespace messagetypes {
-
+// Implemented in config.
-#define MAKE_COMMAND_ID( number )	((MESSAGE_ID << 8) + (number))
+void clearMissionMessage(CommandMessageIF* message);
-typedef uint16_t Command_t;
+}
 
 /**
- * @brief 	Used to pass command messages between tasks. Primary message type
+ * @brief 	Default command message used to pass command messages between tasks.
- * 			for IPC. Contains sender, 2-byte command field, and 2 4-byte
+ * 			Primary message type for IPC. Contains sender, 2-byte command ID
- * 			parameters.
+ * 			field, and 2 4-byte parameters.
  * @details
  * It operates on an external memory which is contained inside a
- * MessageQueueMessage by taking its address.
+ * class implementing MessageQueueMessageIF by taking its address.
  * This allows for a more flexible designs of message implementations.
  * The pointer can be passed to different message implementations without
  * the need of unnecessary copying.
+ *
+ * The command message is based of the generic MessageQueueMessage which
+ * currently has an internal message size of 28 bytes.
  * @author	Bastian Baetz
  */
-class CommandMessage: public MessageQueueMessageIF {
+class CommandMessage: public CommandMessageBase {
 public:
 	static const uint8_t INTERFACE_ID = CLASS_ID::COMMAND_MESSAGE;
 	static const ReturnValue_t UNKNOWN_COMMAND = MAKE_RETURN_CODE(0x01);
 
-
 	static const uint8_t MESSAGE_ID = messagetypes::COMMAND;
 	//! Used internally, will be ignored
 	static const Command_t CMD_NONE = MAKE_COMMAND_ID( 0 );
@@ -66,39 +68,11 @@ public:
 	 */
 	virtual ~CommandMessage() {}
 
-	/**
+	/** MessageQueueMessageIF functions used for minimum size check. */
-	 * Read the DeviceHandlerCommand_t that is stored in the message,
-	 * usually used after receiving.
-	 *
-	 * @return the Command stored in the Message
-	 */
-	Command_t getCommand() const;
-
-	/*
-	 * MessageQueueMessageIF functions, which generally just call the
-	 * respective functions of the internal message
-	 */
-	uint8_t * getBuffer() override;
-	const uint8_t * getBuffer() const override;
-	void setSender(MessageQueueId_t setId) override;
-	MessageQueueId_t getSender() const override;
-	uint8_t * getData() override;
-	const uint8_t* getData() const override;
 	size_t getMinimumMessageSize() const override;
-	size_t getMessageSize() const override;
+	/** MessageQueueMessageIF functions used for maximum size check. */
 	size_t getMaximumMessageSize() const override;
 
-	/**
-	 * Extract message ID, which is the first byte of the command ID.
-	 * @return
-	 */
-	uint8_t getMessageType() const;
-	/**
-	 * Set the command type of the message
-	 * @param the Command to be sent
-	 */
-	void setCommand(Command_t command);
-
 	/**
 	 * Get the first parameter of the message
 	 * @return the first Parameter of the message
@@ -123,19 +97,17 @@ public:
 	 */
 	void setParameter2(uint32_t parameter2);
 
+	void clear() override;
 
 	/**
-	 * Set the command to CMD_NONE and try to find
+	 * Set the command to CMD_NONE and try to find the correct class to handle
-	 * the correct class to handle a more detailed
+	 * a more detailed clear.
-	 * clear.
+	 * Also, calls a mission-specific clearMissionMessage function to separate
-	 * Also, calls a mission-specific clearMissionMessage
+	 * between framework and mission messages. Not optimal, may be replaced by
-	 * function to separate between framework and mission
+	 * totally different auto-delete solution (e.g. smart pointers).
-	 * messages. Not optimal, may be replaced by totally
-	 * different auto-delete solution (e.g. smart pointers).
 	 *
 	 */
 	void clearCommandMessage();
-	void clear() override;
 
 	/**
 	 * check if a message was cleared
@@ -151,15 +123,6 @@ public:
 	void setToUnknownCommand();
 	void setReplyRejected(ReturnValue_t reason,
 			Command_t initialCommand = CMD_NONE);
-
-private:
-	/**
-	 * @brief 	Pointer to the message containing the data.
-	 * @details
-	 * The command message does not actually own the memory containing a
-	 * message, it just oprates on it via a pointer to a message queue message.
-	 */
-	MessageQueueMessage* internalMessage;
 };
 
 

ipc/CommandMessageBase.cpp

@@ -0,0 +1,55 @@
+#include <framework/ipc/CommandMessageBase.h>
+#include <cstring>
+
+CommandMessageBase::CommandMessageBase(MessageQueueMessageIF *message):
+		internalMessage(message) {
+}
+
+Command_t CommandMessageBase::getCommand() const {
+	Command_t command;
+	std::memcpy(&command, internalMessage->getData(), sizeof(Command_t));
+	return command;
+}
+
+void CommandMessageBase::setCommand(Command_t command) {
+	std::memcpy(internalMessage->getData(), &command, sizeof(command));
+}
+
+uint8_t CommandMessageBase::getMessageType() const {
+	// first byte of command ID.
+	return getCommand() >> 8 & 0xff;
+}
+
+MessageQueueId_t CommandMessageBase::getSender() const {
+	return internalMessage->getSender();
+}
+
+uint8_t* CommandMessageBase::getBuffer() {
+	return internalMessage->getBuffer();
+}
+
+void CommandMessageBase::setSender(MessageQueueId_t setId) {
+	internalMessage->setSender(setId);
+}
+
+const uint8_t* CommandMessageBase::getBuffer() const {
+	return internalMessage->getBuffer();
+}
+
+// Header includes command ID.
+uint8_t* CommandMessageBase::getData() {
+	return internalMessage->getData() + sizeof(Command_t);
+}
+
+// Header includes command ID.
+const uint8_t* CommandMessageBase::getData() const {
+	return internalMessage->getData() + sizeof(Command_t);
+}
+
+void CommandMessageBase::setMessageSize(size_t messageSize) {
+	internalMessage->setMessageSize(messageSize);
+}
+
+size_t CommandMessageBase::getMessageSize() const {
+	return internalMessage->getMessageSize();
+}

ipc/CommandMessageBase.h

@@ -0,0 +1,73 @@
+#ifndef FRAMEWORK_IPC_COMMANDMESSAGEBASE_H_
+#define FRAMEWORK_IPC_COMMANDMESSAGEBASE_H_
+#include <framework/ipc/CommandMessageIF.h>
+#include <framework/ipc/MessageQueueMessage.h>
+
+/**
+ * @brief	Base implementation of a generic command message, which has
+ * 			a Command_t ID and message type ID in the header in addition
+ * 			to the sender message queue ID.
+ * @details
+ * This is the base implementation serves as a base for other command messages
+ * and which implements most functions required for MessageQueueMessageIF.
+ * The only functions which have to be supplied by a specific command message
+ * impelementations are the size related functions which are used for
+ * size checks:
+ *
+ *  1. getMinimumMessageSize()
+ *  2. getMaximumMessageSize()
+ *
+ * Don't forget to set the message size of the passed message in the concrete
+ * commandmessage implementation!
+ */
+class CommandMessageBase: public CommandMessageIF {
+public:
+	CommandMessageBase(MessageQueueMessageIF* message);
+
+	/**
+	 * Read the DeviceHandlerCommand_t that is stored in the message,
+	 * usually used after receiving.
+	 *
+	 * @return the Command stored in the Message
+	 */
+	virtual Command_t getCommand() const override;
+	/**
+	 * Set the command type of the message. Default implementation also
+	 * sets the message type, which will be the first byte of the command ID.
+	 * @param the Command to be sent
+	 */
+	virtual void setCommand(Command_t command);
+
+	/**
+	 * Extract message ID, which is the first byte of the command ID for the
+	 * default implementation.
+	 * @return
+	 */
+	virtual uint8_t getMessageType() const override;
+
+	/*
+	 * MessageQueueMessageIF functions, which generally just call the
+	 * respective functions of the internal message queue message.
+	 */
+	virtual uint8_t * getBuffer() override;
+	virtual const uint8_t * getBuffer() const override;
+	virtual void setSender(MessageQueueId_t setId) override;
+	virtual MessageQueueId_t getSender() const override;
+	virtual uint8_t * getData() override;
+	virtual const uint8_t* getData() const override;
+	virtual void setMessageSize(size_t messageSize) override;
+	virtual size_t getMessageSize() const override;
+
+protected:
+	/**
+	 * @brief 	Pointer to the message containing the data.
+	 * @details
+	 * The command message does not actually own the memory containing a
+	 * message, it just oprates on it via a pointer to a message queue message.
+	 */
+	MessageQueueMessageIF* internalMessage;
+};
+
+
+
+#endif /* FRAMEWORK_IPC_COMMANDMESSAGEBASE_H_ */

ipc/CommandMessageIF.h

@@ -0,0 +1,25 @@
+#ifndef FRAMEWORK_IPC_COMMANDMESSAGEIF_H_
+#define FRAMEWORK_IPC_COMMANDMESSAGEIF_H_
+
+#include <framework/ipc/MessageQueueMessageIF.h>
+
+#define MAKE_COMMAND_ID( number )	((MESSAGE_ID << 8) + (number))
+typedef uint16_t Command_t;
+
+class CommandMessageIF: public MessageQueueMessageIF {
+public:
+	virtual ~CommandMessageIF() {};
+
+	/**
+	 * A command message shall have a uint16_t command ID field.
+	 * @return
+	 */
+	virtual Command_t getCommand() const = 0;
+	/**
+	 * A command message shall have a uint8_t message type ID field.
+	 * @return
+	 */
+	virtual uint8_t getMessageType() const = 0;
+};
+
+#endif /* FRAMEWORK_IPC_COMMANDMESSAGEIF_H_ */

ipc/MessageQueueMessage.cpp

@@ -75,3 +75,7 @@ size_t MessageQueueMessage::getMessageSize() const {
 size_t MessageQueueMessage::getMaximumMessageSize() const {
 	return this->MAX_MESSAGE_SIZE;
 }
+
+void MessageQueueMessage::setMessageSize(size_t messageSize) {
+	this->messageSize = messageSize;
+}

ipc/MessageQueueMessage.h

@@ -3,7 +3,7 @@
 
 #include <framework/ipc/MessageQueueMessageIF.h>
 #include <framework/ipc/MessageQueueSenderIF.h>
-#include <stddef.h>
+#include <cstddef>
 
 /**
  *	@brief		This class is the representation and data organizer
@@ -150,6 +150,7 @@ public:
 	virtual size_t getMinimumMessageSize() const override;
 
 	virtual size_t getMessageSize() const override;
+	virtual void setMessageSize(size_t messageSize) override;
 
 	virtual size_t getMaximumMessageSize() const override;
 

ipc/MessageQueueMessageIF.h

@@ -24,7 +24,8 @@ public:
 
 	/**
 	 * @brief	With this method, the whole content and the message
-	 * 			size is set to zero.
+	 * 			size is set to zero. Implementations should also take care
+	 * 			to clear data which is stored indirectly (e.g. storage data).
 	 */
 	virtual void clear() = 0;
 
@@ -77,6 +78,7 @@ public:
 	 * @return
 	 */
 	virtual size_t getMessageSize() const = 0;
+	virtual void setMessageSize(size_t messageSize) = 0;
 
 	/**
 	 * Get maximum allowed size of current message implementation.