MaxHistorySize.h

Go to the documentation of this file.

#pragma once
 
namespace armarx::armem::server::wm::detail
{
    // TODO: Replace by ConstrainedHistorySize (not only max entries, e.g. delete oldest / delete least accessed / ...)
 
    class MaxHistorySize
    {
    public:
        /**
         * @brief Set the maximum number of snapshots to be contained in an entity.
         * Affected entities are to be update right away.
         */
        void setMaxHistorySize(long maxSize, const std::string& additionalInfo = "");
 
        long getMaxHistorySize() const;
 
        /**
         * @brief Set the threshold for warning about unlimited history growth.
         * When maxHistorySize is negative (unlimited) and the number of snapshots
         * exceeds this threshold, a warning will be emitted.
         * Set to 0 to disable the warning.
         */
        void setUnlimitedHistoryWarningThreshold(size_t threshold);
 
        size_t getUnlimitedHistoryWarningThreshold() const;
 
        /**
         * @brief Set the maximum number of snapshots to remove per truncate() call.
         * This prevents long blocking when many snapshots need to be removed.
         * Set to 0 for unlimited (remove all excess in one call).
         */
        void setTruncateMaxBatchSize(size_t batchSize);
 
        size_t getTruncateMaxBatchSize() const;
 
 
    protected:
        /**
         * @brief Maximum size of entity histories.
         *
         * If negative, the size of `history` is not limited.
         * Default: 120,000 snapshots (10 minutes at 200Hz).
         *
         * @see Entity::maxHstorySize
         */
        long _maxHistorySize = 120000;
 
        /**
         * @brief Threshold for warning about unlimited history growth.
         * When maxHistorySize < 0 and container size exceeds this value,
         * a throttled warning is emitted. Set to 0 to disable.
         * Default: 500,000 snapshots.
         */
        size_t _unlimitedHistoryWarningThreshold = 500000;
 
        /**
         * @brief Maximum number of snapshots to remove per truncate() call.
         * Limits blocking time when many snapshots exceed the limit.
         * Set to 0 for unlimited. Default: 100 snapshots per call.
         */
        size_t _truncateMaxBatchSize = 100;
    };
 
    template <class DerivedT>
    class MaxHistorySizeParent : public MaxHistorySize
    {
    public:
        /**
         * @brief Sets the maximum history size of entities in this container.
         * This affects all current entities as well as new ones.
         *
         * @see MaxHistorySize::setMaxHistorySize()
         */
        void
        setMaxHistorySize(long maxSize)
        {
            MaxHistorySize::setMaxHistorySize(maxSize);
            static_cast<DerivedT&>(*this).forEachChild([maxSize](auto& child)
                                                       { child.setMaxHistorySize(maxSize); });
        }
 
        /**
         * @brief Sets the warning threshold for unlimited history growth.
         * This affects all current entities as well as new ones.
         *
         * @see MaxHistorySize::setUnlimitedHistoryWarningThreshold()
         */
        void
        setUnlimitedHistoryWarningThreshold(size_t threshold)
        {
            MaxHistorySize::setUnlimitedHistoryWarningThreshold(threshold);
            static_cast<DerivedT&>(*this).forEachChild(
                [threshold](auto& child)
                { child.setUnlimitedHistoryWarningThreshold(threshold); });
        }
 
        /**
         * @brief Sets the maximum batch size for truncation.
         * This affects all current entities as well as new ones.
         *
         * @see MaxHistorySize::setTruncateMaxBatchSize()
         */
        void
        setTruncateMaxBatchSize(size_t batchSize)
        {
            MaxHistorySize::setTruncateMaxBatchSize(batchSize);
            static_cast<DerivedT&>(*this).forEachChild(
                [batchSize](auto& child) { child.setTruncateMaxBatchSize(batchSize); });
        }
    };
} // namespace armarx::armem::server::wm::detail