eive-obsw/mission/tmtc/VirtualChannel.h

57 lines
1.5 KiB
C
Raw Normal View History

2021-09-22 16:54:55 +02:00
#ifndef VIRTUALCHANNEL_H_
#define VIRTUALCHANNEL_H_
#include <fsfw/ipc/MessageQueueIF.h>
2021-09-26 08:29:30 +02:00
#include <linux/obc/PtmeIF.h>
2021-09-22 16:54:55 +02:00
2022-01-17 15:58:27 +01:00
#include "OBSWConfig.h"
#include "fsfw/returnvalues/HasReturnvaluesIF.h"
#include "fsfw/tmtcservices/AcceptsTelemetryIF.h"
class StorageManagerIF;
2021-09-22 16:54:55 +02:00
/**
2021-09-26 08:29:30 +02:00
* @brief This class represents a virtual channel. Sending a tm message to an object of this class
* will forward the tm packet to the respective virtual channel of the PTME IP Core.
2021-09-22 16:54:55 +02:00
*
* @author J. Meier
*/
2022-01-17 15:58:27 +01:00
class VirtualChannel : public AcceptsTelemetryIF, public HasReturnvaluesIF {
public:
/**
* @brief Constructor
*
* @param vcId The virtual channel id assigned to this object
* @param tmQueueDepth Queue depth of queue receiving telemetry from other objects
*/
VirtualChannel(uint8_t vcId, uint32_t tmQueueDepth);
ReturnValue_t initialize();
MessageQueueId_t getReportReceptionQueue(uint8_t virtualChannel = 0) override;
ReturnValue_t performOperation();
/**
* @brief Sets the PTME object which handles access to the PTME IP Core.
*
* @param ptme Pointer to ptme object
*/
void setPtmeObject(PtmeIF* ptme_);
/**
* @brief Can be used by the owner to set the link state. Packets will be discarded if link
* to ground station is down.
*/
void setLinkState(bool linkIsUp_);
private:
PtmeIF* ptme = nullptr;
MessageQueueIF* tmQueue = nullptr;
uint8_t vcId;
bool linkIsUp = false;
StorageManagerIF* tmStore = nullptr;
2021-09-22 16:54:55 +02:00
};
#endif /* VIRTUALCHANNEL_H_ */