clanguml::common::model::diagram_filter Class Reference

Composite of all diagrams filters. More...

Detailed Description

Composite of all diagrams filters.

Instances of this class contain all filters specified in configuration file for a given diagram.

See also

clanguml::common::model::filter_visitor

Definition at line 874 of file diagram_filter.h.

#include <diagram_filter.h>

Classes
struct	private_constructor_tag_t

Public Member Functions
	diagram_filter (const common::model::diagram &d, const config::diagram &c, private_constructor_tag_t unused)
void	add_filter (filter_t filter_type, std::unique_ptr< filter_visitor > fv)
void	add_inclusive_filter (std::unique_ptr< filter_visitor > fv)
void	add_exclusive_filter (std::unique_ptr< filter_visitor > fv)
bool	should_include (const namespace_ &ns, const std::string &name) const
template<typename T >
bool	should_include (const T &e) const
filter_mode_t	mode () const
void	set_mode (filter_mode_t mode)
void	reset ()

Private Attributes
std::vector< std::unique_ptr< filter_visitor > >	inclusive_
std::vector< std::unique_ptr< filter_visitor > >	exclusive_
const common::model::diagram &	diagram_
filter_mode_t	mode_ {filter_mode_t::basic}

Friends
class	diagram_filter_factory

Constructor & Destructor Documentation

diagram_filter()

clanguml::common::model::diagram_filter::diagram_filter	(	const common::model::diagram &	d,
		const config::diagram &	c,
		private_constructor_tag_t	unused
	)

Definition at line 1348 of file diagram_filter.cc.

    : diagram_{d}
{
}

Member Function Documentation

add_exclusive_filter()

void clanguml::common::model::diagram_filter::add_exclusive_filter

(

std::unique_ptr< filter_visitor >

fv

)

Add exclusive filter.

Parameters

fv	Filter visitor.

Definition at line 1368 of file diagram_filter.cc.

{
    exclusive_.emplace_back(std::move(fv));
}

add_filter()

void clanguml::common::model::diagram_filter::add_filter	(	filter_t	filter_type,
		std::unique_ptr< filter_visitor >	fv
	)

Definition at line 1354 of file diagram_filter.cc.

{
    if (filter_type == filter_t::kInclusive)
        add_inclusive_filter(std::move(fv));
    else
        add_exclusive_filter(std::move(fv));
}

add_inclusive_filter()

void clanguml::common::model::diagram_filter::add_inclusive_filter

(

std::unique_ptr< filter_visitor >

fv

)

Add inclusive filter.

Parameters

fv	Filter visitor.

Definition at line 1363 of file diagram_filter.cc.

{
    inclusive_.emplace_back(std::move(fv));
}

mode()

filter_mode_t clanguml::common::model::diagram_filter::mode

(

)

const

Definition at line 1387 of file diagram_filter.cc.

{ return mode_; }

reset()

void clanguml::common::model::diagram_filter::reset

(

)

Definition at line 1391 of file diagram_filter.cc.

{
    for (auto &f : inclusive_)
        f->reset();
 
    for (auto &f : exclusive_)
        f->reset();
}

set_mode()

void clanguml::common::model::diagram_filter::set_mode

(

filter_mode_t

mode

)

Definition at line 1389 of file diagram_filter.cc.

{ mode_ = mode; }

should_include() [1/2]

bool clanguml::common::model::diagram_filter::should_include	(	const namespace_ &	ns,
		const std::string &	name
	)		const

should_include overload for namespace and name.

Parameters

ns	Namespace
name	Name

Returns

Match result.

Definition at line 1373 of file diagram_filter.cc.

{
    if (should_include(ns)) {
        element e{namespace_{}};
        e.set_name(name);
        e.set_namespace(ns);
 
        return should_include(e);
    }
 
    return false;
}

should_include() [2/2]

template<typename T >

bool clanguml::common::model::diagram_filter::should_include ( const T &  e ) const

inline

Generic should_include overload for various diagram elements.

Template Parameters

T	Type to to match - must match one of filter_visitor's match(T)

Parameters

e	Value of type T to match

Returns

Match result.

Definition at line 914 of file diagram_filter.h.

    {
        auto exc = tvl::any_of(
            exclusive_.begin(), exclusive_.end(), [this, &e](const auto &ex) {
                assert(ex.get() != nullptr);
 
                return ex->match(diagram_, e);
            });
 
        if (tvl::is_true(exc))
            return false;
 
        auto inc = tvl::all_of(
            inclusive_.begin(), inclusive_.end(), [this, &e](const auto &in) {
                assert(in.get() != nullptr);
 
                return in->match(diagram_, e);
            });
 
        return static_cast<bool>(tvl::is_undefined(inc) || tvl::is_true(inc));
    }

Friends And Related Symbol Documentation

diagram_filter_factory

friend class diagram_filter_factory

friend

Definition at line 942 of file diagram_filter.h.

Member Data Documentation

diagram_

const common::model::diagram& clanguml::common::model::diagram_filter::diagram_

private

Reference to the diagram model

Definition at line 952 of file diagram_filter.h.

exclusive_

std::vector<std::unique_ptr<filter_visitor> > clanguml::common::model::diagram_filter::exclusive_

private

List of exclusive filters

Definition at line 949 of file diagram_filter.h.

inclusive_

std::vector<std::unique_ptr<filter_visitor> > clanguml::common::model::diagram_filter::inclusive_

private

List of inclusive filters

Definition at line 946 of file diagram_filter.h.

mode_

filter_mode_t clanguml::common::model::diagram_filter::mode_ {filter_mode_t::basic}

private

Definition at line 954 of file diagram_filter.h.

---

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

• src/common/model/filters/diagram_filter.h
• src/common/model/filters/diagram_filter.cc