File: CustomContentFilter.hpp

package info (click to toggle)
fastdds 3.3.0%2Bds-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 60,540 kB
  • sloc: cpp: 793,735; xml: 15,283; python: 5,902; sh: 219; makefile: 95; ansic: 12
file content (95 lines) | stat: -rw-r--r-- 3,118 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
// Copyright 2024 Proyectos y Sistemas de Mantenimiento SL (eProsima).
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#ifndef FASTDDS_EXAMPLES_CPP_CONTENT_FILTER__CUSTOMCONTENTFILTER_HPP
#define FASTDDS_EXAMPLES_CPP_CONTENT_FILTER__CUSTOMCONTENTFILTER_HPP

#include <fastcdr/Cdr.h>

#include <fastdds/dds/topic/IContentFilter.hpp>
#include <fastdds/rtps/common/CdrSerialization.hpp>

//! Custom filter class
//! It requieres two parameters 'low_mark_' and 'high_mark_'.
//! Filter samples which index is lower than 'low_mark_' and higher than 'high_mark_'.
class CustomContentFilter : public eprosima::fastdds::dds::IContentFilter
{
public:

    /**
     * @brief Construct a new CustomContentFilter object
     *
     * @param low_mark
     * @param high_mark
     */
    CustomContentFilter(
            int low_mark,
            int high_mark)
        : low_mark_(low_mark)
        , high_mark_(high_mark)
    {
    }

    //! Destructor
    virtual ~CustomContentFilter() = default;

    /**
     * @brief Evaluate filter discriminating whether the sample is relevant or not, i.e. whether it meets the filtering
     * criteria
     *
     * @param payload Serialized sample
     * @return true if sample meets filter requirements. false otherwise.
     */
    bool evaluate(
            const SerializedPayload& payload,
            const FilterSampleInfo& /*sample_info*/,
            const GUID_t& /*reader_guid*/) const override
    {
        // Deserialize the `index` field from the serialized sample.
        eprosima::fastcdr::FastBuffer fastbuffer(reinterpret_cast<char*>(payload.data), payload.length);
        eprosima::fastcdr::Cdr deser(fastbuffer, eprosima::fastcdr::Cdr::DEFAULT_ENDIAN,
                eprosima::fastdds::rtps::DEFAULT_XCDR_VERSION);
        // Deserialize encapsulation.
        deser.read_encapsulation();
        uint32_t index = 0;

        // Deserialize `index` field.
        try
        {
            deser >> index;
        }
        catch (eprosima::fastcdr::exception::NotEnoughMemoryException& /*exception*/)
        {
            return false;
        }

        // Custom filter: reject samples where index > low_mark_ and index < high_mark_.
        if (index < low_mark_ || index > high_mark_)
        {
            return true;
        }

        return false;
    }

private:

    //! Low mark: lower threshold below which the samples are relevant
    uint32_t low_mark_ = 0;
    //! High mark: upper threshold over which the samples are relevant
    uint32_t high_mark_ = 0;

};

#endif // FASTDDS_EXAMPLES_CPP_CONTENT_FILTER__CUSTOMCONTENTFILTER_HPP