FilterState

Stores the state of multiple filters. More...

#include <unity/scopes/FilterState.h>

Public Member Functions

 FilterState ()
 Constructs a an empty filter state instance.
 
bool has_filter (std::string const &id) const
 Check if state for the given filter has been stored. More...
 
void remove (std::string const &id)
 Removes the state for a specific filter. More...
 
Copy and assignment

Copy and assignment operators (move and non-move versions) have the usual value semantics.

 FilterState (FilterState const &other)
 
 FilterState (FilterState &&)
 
FilterStateoperator= (FilterState const &other)
 
FilterStateoperator= (FilterState &&other)
 

Detailed Description

Stores the state of multiple filters.

The state can be examined by passing an instance of FilterState to the appropriate methods of classes derived from FilterBase.

Member Function Documentation

bool unity::scopes::FilterState::has_filter ( std::string const &  id) const

Check if state for the given filter has been stored.

Returns
True if state for a filter with the given ID is present; false otherwise.
void unity::scopes::FilterState::remove ( std::string const &  id)

Removes the state for a specific filter.

Parameters
idThe identity of the filter to remove.