#ifndef SERIALIZEADAPTER_H_ #define SERIALIZEADAPTER_H_ #include #include #include #include #include /** * This adapter provides an interface to use the SerializeIF functions * with arbitrary template objects to facilitate and simplify the serialization of classes * with different multiple different data types into buffers vice-versa. * * Examples: * A report class is converted into a TM buffer. The report class implements a serialize functions and calls * the AutoSerializeAdapter::serialize function repeatedly on all object data fields. * The getSerializedSize function is implemented by calling the * AutoSerializeAdapter::getSerializedSize function repeatedly on all data fields. * * The AutoSerializeAdapter functions can also be used as an alternative to memcpy * to retrieve data out of a buffer directly into a class variable with data type T while being able to specify endianness. * * In the SOURCE mission , the target architecture is little endian, * so any buffers must be deSerialized with bool bigEndian = false if * the parameters are used in the FSFW. * When serializing for downlink, the packets are generally serialized into big endian for the network when using a TC/UDP client * like seen in TmPacketStored.cpp for example. * * \ingroup serialize */ template class SerializeAdapter_ { public: static ReturnValue_t serialize(const T* object, uint8_t** buffer, uint32_t* size, const uint32_t max_size, bool bigEndian) { uint32_t ignoredSize = 0; if (size == NULL) { size = &ignoredSize; } if (sizeof(T) + *size <= max_size) { T tmp; if (bigEndian) { tmp = EndianSwapper::swap(*object); } else { tmp = *object; } memcpy(*buffer, &tmp, sizeof(T)); *size += sizeof(T); (*buffer) += sizeof(T); return HasReturnvaluesIF::RETURN_OK; } else { return SerializeIF::BUFFER_TOO_SHORT; } } ReturnValue_t deSerialize(T* object, const uint8_t** buffer, int32_t* size, bool bigEndian) { T tmp; *size -= sizeof(T); if (*size >= 0) { memcpy(&tmp, *buffer, sizeof(T)); if (bigEndian) { *object = EndianSwapper::swap(tmp); } else { *object = tmp; } *buffer += sizeof(T); return HasReturnvaluesIF::RETURN_OK; } else { return SerializeIF::STREAM_TOO_SHORT; } } uint32_t getSerializedSize(const T * object) { return sizeof(T); } }; template class SerializeAdapter_ { public: ReturnValue_t serialize(const T* object, uint8_t** buffer, uint32_t* size, const uint32_t max_size, bool bigEndian) const { uint32_t ignoredSize = 0; if (size == NULL) { size = &ignoredSize; } return object->serialize(buffer, size, max_size, bigEndian); } uint32_t getSerializedSize(const T* object) const { return object->getSerializedSize(); } ReturnValue_t deSerialize(T* object, const uint8_t** buffer, int32_t* size, bool bigEndian) { return object->deSerialize(buffer, size, bigEndian); } }; template class SerializeAdapter { public: static ReturnValue_t serialize(const T* object, uint8_t** buffer, uint32_t* size, const uint32_t max_size, bool bigEndian) { SerializeAdapter_::Is> adapter; return adapter.serialize(object, buffer, size, max_size, bigEndian); } static uint32_t getSerializedSize(const T* object) { SerializeAdapter_::Is> adapter; return adapter.getSerializedSize(object); } static ReturnValue_t deSerialize(T* object, const uint8_t** buffer, int32_t* size, bool bigEndian) { SerializeAdapter_::Is> adapter; return adapter.deSerialize(object, buffer, size, bigEndian); } }; class AutoSerializeAdapter { public: template static ReturnValue_t serialize(const T* object, uint8_t** buffer, uint32_t* size, const uint32_t max_size, bool bigEndian) { SerializeAdapter_::Is> adapter; return adapter.serialize(object, buffer, size, max_size, bigEndian); } template static uint32_t getSerializedSize(const T* object) { SerializeAdapter_::Is> adapter; return adapter.getSerializedSize(object); } template static ReturnValue_t deSerialize(T* object, const uint8_t** buffer, int32_t* size, bool bigEndian) { SerializeAdapter_::Is> adapter; return adapter.deSerialize(object, buffer, size, bigEndian); } }; #endif /* SERIALIZEADAPTER_H_ */