CppGraph Application Framework©
Copyright © 2004-202x Geoff Goldberg
Static Public Member Functions | Friends | List of all members
cppgraph::message_filter Struct Referenceabstract

A message filter is an abstract base for classes that determine if a specified envelope matches specified criteria. More...

#include <message_filter.h>

Inherits node.

Static Public Member Functions

static cppgraph::node_class const & static_get_class ()
 [auto-generated] Returns this class's meta-class node. More...
 
static cppgraph::node_class_id_t static_get_class_id ()
 [auto-generated] Returns this class's ID. More...
 

Friends

template<typename Filter , typename Item >
bool passes_filter (Item const &, Filter const &)
 Returns true if a specified filter passes a specified item. More...
 

Detailed Description

A message filter is an abstract base for classes that determine if a specified envelope matches specified criteria.

A message filter filters messages delivered to its parent nodes.

See also
passes_filter()

Object Diagram

dot_inline_dotgraph_267.png

Member Function Documentation

◆ static_get_class()

static cppgraph::node_class const& cppgraph::message_filter::static_get_class ( )
inlinestatic

[auto-generated] Returns this class's meta-class node.

Returns
This class's meta-class node.

◆ static_get_class_id()

static cppgraph::node_class_id_t cppgraph::message_filter::static_get_class_id ( )
inlinestatic

[auto-generated] Returns this class's ID.

Returns
This class's ID.

Friends And Related Function Documentation

◆ passes_filter

template<typename Filter , typename Item >
bool passes_filter ( Item const &  item,
Filter const &  h_filter 
)
friend

Returns true if a specified filter passes a specified item.

Template Parameters
FilterA filter handle class. The compiler will deduce this parameter from the h_filter argument. THerefore it need not be specified.
ItemClass of handle to item being tested. The compiler will deduce this parameter from the h_item argument. THerefore it need not be specified.
Parameters
itemHandle of type Item.
h_filterHandle of type Filter. It may be nullptr.
Returns
true if h_filter is nullptr or passes item.

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