helics::MessageConditionalOperator Class Reference

#include <MessageOperators.hpp>

Inheritance diagram for helics::MessageConditionalOperator:

Public Member Functions
	MessageConditionalOperator ()=default
	MessageConditionalOperator (std::function< bool(const Message *)> userConditionalFunction)
void	setConditionFunction (std::function< bool(const Message *)> userConditionFunction)
Public Member Functions inherited from helics::FilterOperator
	FilterOperator ()=default
virtual	~FilterOperator ()=default
virtual std::vector< std::unique_ptr< Message > >	processVector (std::unique_ptr< Message > message)
std::unique_ptr< Message >	operator() (std::unique_ptr< Message > message)
virtual bool	isMessageGenerating () const

Detailed Description

class defining an message operator that either passes the message or not

the evaluation function used should return true if the message should be allowed through false if it should be dropped

Constructor & Destructor Documentation

MessageConditionalOperator() [1/2]

helics::MessageConditionalOperator::MessageConditionalOperator ( )

default

default constructor

MessageConditionalOperator() [2/2]

helics::MessageConditionalOperator::MessageConditionalOperator ( std::function< bool(const Message *)>  userConditionalFunction )

explicit

set the function to modify the data of the message in the constructor

Member Function Documentation

setConditionFunction()

void helics::MessageConditionalOperator::setConditionFunction

(

std::function< bool(const Message *)>

userConditionFunction

)

set the function to modify the data of the message

---

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

• MessageOperators.hpp
• MessageOperators.cpp