MADARA  3.0.11
madara::filters::AggregateFilter Class Referenceabstract

Abstract base class for implementing aggregate record filters via a functor interface. More...

#include <AggregateFilter.h>

Inheritance diagram for madara::filters::AggregateFilter:

Public Member Functions

virtual ~AggregateFilter ()
 Destructor. More...
 
virtual void filter (knowledge::KnowledgeMap &records, const transport::TransportContext &transport_context, knowledge::Variables &vars)=0
 User-implementable method for performing a filter on network data. More...
 

Detailed Description

Abstract base class for implementing aggregate record filters via a functor interface.

When subclassing this class, create a new instance with the new operator, and the pointer will be managed by the underlying MADARA infrastructure.

Definition at line 34 of file AggregateFilter.h.

Constructor & Destructor Documentation

virtual madara::filters::AggregateFilter::~AggregateFilter ( )
inlinevirtual

Destructor.

Definition at line 40 of file AggregateFilter.h.

Member Function Documentation

virtual void madara::filters::AggregateFilter::filter ( knowledge::KnowledgeMap records,
const transport::TransportContext transport_context,
knowledge::Variables vars 
)
pure virtual

User-implementable method for performing a filter on network data.

This is a pure abstract function that must be overridden when implementing a subclass.

Parameters
recordsthe aggregate records vector
transport_contextcontext for querying transport state
varscontext for querying current program state

Implemented in madara::filters::EndpointClear, madara::filters::EndpointDiscovery, madara::filters::PeerDiscovery, madara::filters::CounterFilter, and madara::filters::ClearRecords.


The documentation for this class was generated from the following file: