MADARA  3.4.1
madara::filters::PrefixPrint Class Reference

Filter for printing variables as they arrive and excluding prefixes that are unwanted via a user-specified MADARA StringVector container. More...

#include <PrefixPrint.h>

Inheritance diagram for madara::filters::PrefixPrint:
madara::filters::AggregateFilter

Public Member Functions

 PrefixPrint (const std::vector< std::string > &source_prefixes={}, bool print_verbose=true)
 Constructor. More...
 
virtual ~PrefixPrint ()
 Destructor. More...
 
virtual void filter (knowledge::KnowledgeMap &records, const transport::TransportContext &transport_context, knowledge::Variables &)
 Prints records and transport context information. More...
 

Public Attributes

std::vector< std::string > prefixes
 Prefixes to print. More...
 
bool verbose
 

Detailed Description

Filter for printing variables as they arrive and excluding prefixes that are unwanted via a user-specified MADARA StringVector container.

Definition at line 28 of file PrefixPrint.h.

Constructor & Destructor Documentation

◆ PrefixPrint()

madara::filters::PrefixPrint::PrefixPrint ( const std::vector< std::string > &  source_prefixes = {},
bool  print_verbose = true 
)
inline

Constructor.

Parameters
print_verboseif true, print more verbose information
source_prefixesthe static prefixes to use for printing. If empty, print all variables. If contains prefixes, only print variables that begin with contained prefixes

Definition at line 38 of file PrefixPrint.h.

◆ ~PrefixPrint()

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

Destructor.

Definition at line 47 of file PrefixPrint.h.

Member Function Documentation

◆ filter()

virtual void madara::filters::PrefixPrint::filter ( knowledge::KnowledgeMap records,
const transport::TransportContext transport_context,
knowledge::Variables  
)
inlinevirtual

Prints records and transport context information.

Parameters
recordsthe aggregate records vector
transport_contextdescribes transport information

Implements madara::filters::AggregateFilter.

Definition at line 56 of file PrefixPrint.h.

Member Data Documentation

◆ prefixes

std::vector<std::string> madara::filters::PrefixPrint::prefixes

Prefixes to print.

If empty, print all variables. If not empty, print only variables with prefixes that exist in the vector.

Definition at line 152 of file PrefixPrint.h.

◆ verbose

bool madara::filters::PrefixPrint::verbose

Definition at line 153 of file PrefixPrint.h.


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