BlackWhitelist< Key > Class Template Reference

A combination of blacklist and whitelist. More...

#include <RobotAPI/components/DebugDrawerToArViz/BlackWhitelist.h>

Public Member Functions

 BlackWhitelist ()=default
 Construct an empty blacklist and whitelist. More...
 
bool isExcluded (const Key &element) const
 An element is excluded if (1) it is in the blacklist, or (2) it is not in the non-empty whitelist. More...
 
bool isIncluded (const Key &element) const
 An element is included if (1) it is not in the blacklist, and (2) the whitelist is empty or it contains the element. More...
 

Public Attributes

std::set< Key > black
 Elements in this list are always excluded. More...
 
std::set< Key > white
 If not empty, only these elements are included. More...
 

Friends

template<class K >
std::ostream & operator<< (std::ostream &os, const BlackWhitelist< K > &bw)
 

Detailed Description

template<typename Key>
class armarx::BlackWhitelist< Key >

A combination of blacklist and whitelist.

An element is included if (1) it is not in the blacklist, and (2) the whitelist is empty or it contains the element.

Definition at line 19 of file BlackWhitelist.h.

Constructor & Destructor Documentation

◆ BlackWhitelist()

BlackWhitelist ( )
default

Construct an empty blacklist and whitelist.

Member Function Documentation

◆ isExcluded()

bool isExcluded ( const Key &  element) const
inline

An element is excluded if (1) it is in the blacklist, or (2) it is not in the non-empty whitelist.

Definition at line 42 of file BlackWhitelist.h.

+ Here is the caller graph for this function:

◆ isIncluded()

bool isIncluded ( const Key &  element) const
inline

An element is included if (1) it is not in the blacklist, and (2) the whitelist is empty or it contains the element.

Definition at line 32 of file BlackWhitelist.h.

+ Here is the caller graph for this function:

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<< ( std::ostream &  os,
const BlackWhitelist< K > &  bw 
)
friend

Definition at line 59 of file BlackWhitelist.h.

Member Data Documentation

◆ black

std::set<Key> black

Elements in this list are always excluded.

Definition at line 49 of file BlackWhitelist.h.

◆ white

std::set<Key> white

If not empty, only these elements are included.

Definition at line 51 of file BlackWhitelist.h.


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