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.
 
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.
 
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.
 

Public Attributes

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

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.

Constructor & Destructor Documentation

◆ BlackWhitelist()

template<typename Key>
BlackWhitelist ( )
default

Construct an empty blacklist and whitelist.

Member Function Documentation

◆ isExcluded()

template<typename Key>
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.

◆ isIncluded()

template<typename Key>
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.

Friends And Related Symbol Documentation

◆ operator<<

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

Member Data Documentation

◆ black

template<typename Key>
std::set<Key> black

Elements in this list are always excluded.

◆ white

template<typename Key>
std::set<Key> white

If not empty, only these elements are included.


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