Public Member Functions | Private Attributes | Friends | List of all members
walberla::selectable::SetSelectionPair< T > Class Template Reference

Detailed Description

template<typename T>
class walberla::selectable::SetSelectionPair< T >

Class for storing two sets: one marked as "included" and one marked as "excluded".

Objects of type SetSelectionPair are used as attributes for objects stored in a "wrapper" object of type SetSelectableObject. For further information see class SetSelectableObject.

#include <SetSelectionPair.h>

Public Member Functions

 SetSelectionPair (const Set< T > &include, const Set< T > &exclude=Set< T >::emptySet())
 
const Set< T > & included () const
 
const Set< T > & excluded () const
 
bool isEqual (const SetSelectionPair< T > &s) const
 
void toStream (std::ostream &os) const
 
std::string toString () const
 

Private Attributes

Set< T > include_
 
Set< T > exclude_
 

Friends

bool operator== (const SetSelectionPair &a, const SetSelectionPair &b)
 
bool operator!= (const SetSelectionPair &a, const SetSelectionPair &b)
 

Constructor & Destructor Documentation

◆ SetSelectionPair()

template<typename T >
walberla::selectable::SetSelectionPair< T >::SetSelectionPair ( const Set< T > &  include,
const Set< T > &  exclude = Set<T>::emptySet() 
)
inline

Member Function Documentation

◆ excluded()

template<typename T >
const Set<T>& walberla::selectable::SetSelectionPair< T >::excluded ( ) const
inline

◆ included()

template<typename T >
const Set<T>& walberla::selectable::SetSelectionPair< T >::included ( ) const
inline

◆ isEqual()

template<typename T >
bool walberla::selectable::SetSelectionPair< T >::isEqual ( const SetSelectionPair< T > &  s) const
inline

◆ toStream()

template<typename T >
void walberla::selectable::SetSelectionPair< T >::toStream ( std::ostream &  os) const
inline

◆ toString()

template<typename T >
std::string walberla::selectable::SetSelectionPair< T >::toString ( ) const
inline

Friends And Related Function Documentation

◆ operator!=

template<typename T >
bool operator!= ( const SetSelectionPair< T > &  a,
const SetSelectionPair< T > &  b 
)
friend

◆ operator==

template<typename T >
bool operator== ( const SetSelectionPair< T > &  a,
const SetSelectionPair< T > &  b 
)
friend

Member Data Documentation

◆ exclude_

template<typename T >
Set<T> walberla::selectable::SetSelectionPair< T >::exclude_
private

◆ include_

template<typename T >
Set<T> walberla::selectable::SetSelectionPair< T >::include_
private
The documentation for this class was generated from the following file: