70 lines
2.7 KiB
C++
70 lines
2.7 KiB
C++
#ifndef FSFW_TMTCPACKET_PUS_TMPACKETSTORED_PUSA_H_
|
|
#define FSFW_TMTCPACKET_PUS_TMPACKETSTORED_PUSA_H_
|
|
|
|
#include <FSFWConfig.h>
|
|
|
|
#include "TmPacketPusA.h"
|
|
#include "TmPacketStoredBase.h"
|
|
|
|
/**
|
|
* This class generates a ECSS PUS A Telemetry packet within a given
|
|
* intermediate storage.
|
|
* As most packets are passed between tasks with the help of a storage
|
|
* anyway, it seems logical to create a Packet-In-Storage access class
|
|
* which saves the user almost all storage handling operation.
|
|
* Packets can both be newly created with the class and be "linked" to
|
|
* packets in a store with the help of a storeAddress.
|
|
* @ingroup tmtcpackets
|
|
*/
|
|
class TmPacketStoredPusA : public TmPacketStoredBase, public TmPacketPusA {
|
|
public:
|
|
/**
|
|
* This is a default constructor which does not set the data pointer.
|
|
* However, it does try to set the packet store.
|
|
*/
|
|
TmPacketStoredPusA(store_address_t setAddress);
|
|
/**
|
|
* With this constructor, new space is allocated in the packet store and
|
|
* a new PUS Telemetry Packet is created there.
|
|
* Packet Application Data passed in data is copied into the packet.
|
|
* The Application data is passed in two parts, first a header, then a
|
|
* data field. This allows building a Telemetry Packet from two separate
|
|
* data sources.
|
|
* @param apid Sets the packet's APID field.
|
|
* @param service Sets the packet's Service ID field.
|
|
* This specifies the source service.
|
|
* @param subservice Sets the packet's Service Subtype field.
|
|
* This specifies the source sub-service.
|
|
* @param packet_counter Sets the Packet counter field of this packet
|
|
* @param data The payload data to be copied to the
|
|
* Application Data Field
|
|
* @param size The amount of data to be copied.
|
|
* @param headerData The header Data of the Application field,
|
|
* will be copied in front of data
|
|
* @param headerSize The size of the headerDataF
|
|
*/
|
|
TmPacketStoredPusA(uint16_t apid, uint8_t service, uint8_t subservice, uint8_t packet_counter = 0,
|
|
const uint8_t* data = nullptr, uint32_t size = 0,
|
|
const uint8_t* headerData = nullptr, uint32_t headerSize = 0);
|
|
/**
|
|
* Another ctor to directly pass structured content and header data to the
|
|
* packet to avoid additional buffers.
|
|
*/
|
|
TmPacketStoredPusA(uint16_t apid, uint8_t service, uint8_t subservice, uint8_t packet_counter,
|
|
SerializeIF* content, SerializeIF* header = nullptr);
|
|
|
|
uint8_t* getAllTmData() override;
|
|
|
|
private:
|
|
/**
|
|
* Implementation required by base class
|
|
* @param newPointer
|
|
* @param maxSize
|
|
* @param args
|
|
* @return
|
|
*/
|
|
ReturnValue_t setData(uint8_t* newPointer, size_t maxSize, void* args = nullptr) override;
|
|
};
|
|
|
|
#endif /* FSFW_TMTCPACKET_PUS_TMPACKETSTORED_PUSA_H_ */
|