fsfw/container/DynamicFIFO.h

55 lines
1.6 KiB
C
Raw Normal View History

2020-08-27 20:19:27 +02:00
#ifndef FSFW_CONTAINER_DYNAMICFIFO_H_
#define FSFW_CONTAINER_DYNAMICFIFO_H_
2020-07-07 17:44:15 +02:00
#include "FIFOBase.h"
2020-07-07 17:44:15 +02:00
#include <vector>
/**
* @brief Simple First-In-First-Out data structure. The maximum size
* can be set in the constructor.
* @details
* The maximum capacity can be determined at run-time, so this container
* performs dynamic memory allocation!
* The public interface of FIFOBase exposes the user interface for the FIFO.
* @tparam T Entry Type
* @tparam capacity Maximum capacity
*/
template<typename T>
class DynamicFIFO: public FIFOBase<T> {
public:
2020-07-28 13:13:40 +02:00
DynamicFIFO(size_t maxCapacity): FIFOBase<T>(nullptr, maxCapacity),
fifoVector(maxCapacity) {
// trying to pass the pointer of the uninitialized vector
// to the FIFOBase constructor directly lead to a super evil bug.
// So we do it like this now.
2020-09-01 12:53:53 +02:00
this->setContainer(fifoVector.data());
2020-07-28 13:13:40 +02:00
};
/**
* @brief Custom copy constructor which prevents setting the
2020-09-07 15:43:48 +02:00
* underlying pointer wrong. This function allocates memory!
* @details This is a very heavy operation so try to avoid this!
*
2020-07-28 13:13:40 +02:00
*/
DynamicFIFO(const DynamicFIFO& other): FIFOBase<T>(other),
fifoVector(other.maxCapacity) {
2020-09-01 12:53:53 +02:00
this->setContainer(fifoVector.data());
2020-07-28 13:13:40 +02:00
}
2020-09-07 15:43:48 +02:00
/**
* @brief Custom assignment operator
* @details This is a very heavy operation so try to avoid this!
* @param other DyamicFIFO to copy from
*/
DynamicFIFO& operator=(const DynamicFIFO& other){
FIFOBase<T>::operator=(other);
this->fifoVector = other.fifoVector;
this->setContainer(fifoVector.data());
return *this;
}
2020-07-07 17:44:15 +02:00
private:
2020-07-28 13:13:40 +02:00
std::vector<T> fifoVector;
2020-07-07 17:44:15 +02:00
};
2020-08-27 20:19:27 +02:00
#endif /* FSFW_CONTAINER_DYNAMICFIFO_H_ */