fsfw/tcdistribution/CCSDSDistributor.h

72 lines
2.4 KiB
C
Raw Normal View History

2020-10-01 13:23:06 +02:00
#ifndef FRAMEWORK_TCDISTRIBUTION_CCSDSDISTRIBUTOR_H_
#define FRAMEWORK_TCDISTRIBUTION_CCSDSDISTRIBUTOR_H_
2020-08-13 20:53:35 +02:00
#include "../objectmanager/ObjectManagerIF.h"
#include "../storagemanager/StorageManagerIF.h"
2020-10-01 13:23:06 +02:00
#include "../tcdistribution/CCSDSDistributorIF.h"
#include "../tcdistribution/TcDistributor.h"
2020-08-13 20:53:35 +02:00
#include "../tmtcservices/AcceptsTelecommandsIF.h"
2020-10-01 13:23:06 +02:00
/**
2020-10-01 13:23:06 +02:00
* @brief An instantiation of the CCSDSDistributorIF.
* @details
* It receives Space Packets, and selects a destination depending on the
* APID of the telecommands.
* The Secondary Header (with Service/Subservice) is ignored.
2020-10-01 13:23:06 +02:00
* @ingroup tc_distribution
*/
2020-10-01 13:23:06 +02:00
class CCSDSDistributor : public TcDistributor,
public CCSDSDistributorIF,
public AcceptsTelecommandsIF {
public:
/**
2020-10-01 13:23:06 +02:00
* @brief The constructor sets the default APID and calls the
* TcDistributor ctor with a certain object id.
* @details
* @c tcStore is set in the @c initialize method.
* @param setDefaultApid The default APID, where packets with unknown
* destination are sent to.
*/
2020-10-01 13:23:06 +02:00
CCSDSDistributor(uint16_t setDefaultApid, object_id_t setObjectId);
/**
2020-10-01 13:23:06 +02:00
* The destructor is empty.
*/
2020-10-01 13:23:06 +02:00
virtual ~CCSDSDistributor();
MessageQueueId_t getRequestQueue() override;
ReturnValue_t registerApplication( uint16_t apid,
MessageQueueId_t id) override;
ReturnValue_t registerApplication(
AcceptsTelecommandsIF* application) override;
uint16_t getIdentifier() override;
ReturnValue_t initialize() override;
protected:
/**
2020-10-01 13:23:06 +02:00
* This implementation checks if an application with fitting APID has
* registered and forwards the packet to the according message queue.
* If the packet is not found, it returns the queue to @c defaultApid,
* where a Acceptance Failure message should be generated.
* @return Iterator to map entry of found APID or iterator to default APID.
*/
2020-10-01 13:23:06 +02:00
TcMqMapIter selectDestination() override;
/**
* The callback here handles the generation of acceptance
* success/failure messages.
*/
ReturnValue_t callbackAfterSending( ReturnValue_t queueStatus ) override;
/**
2020-10-01 13:23:06 +02:00
* The default APID, where packets with unknown APID are sent to.
*/
2020-10-01 13:23:06 +02:00
uint16_t defaultApid;
/**
2020-10-01 13:23:06 +02:00
* A reference to the TC storage must be maintained, as this class handles
* pure Space Packets and there exists no SpacePacketStored class.
*/
2020-10-01 13:23:06 +02:00
StorageManagerIF* tcStore = nullptr;
2020-10-01 13:23:06 +02:00
};
2020-10-01 13:23:06 +02:00
#endif /* FRAMEWORK_TCDISTRIBUTION_CCSDSDISTRIBUTOR_H_ */