Detailed Description

Match element based on whether it is a subclass of a set of base classes, or one of them.

Definition at line 343 of file diagram_filter.h.

#include <diagram_filter.h>

Public Member Functions
	subclass_filter (filter_t type, std::vector< common::string_or_regex > roots)

	~subclass_filter () override=default

tvl::value_t	match (const diagram &d, const element &e) const override

Public Member Functions inherited from clanguml::common::model::filter_visitor
	filter_visitor (filter_t type)

virtual	~filter_visitor ()=default

virtual tvl::value_t	match (const diagram &d, const common::model::element &e) const

virtual tvl::value_t	match (const diagram &d, const common::model::relationship &r) const

virtual tvl::value_t	match (const diagram &d, const common::model::relationship_t &r) const

virtual tvl::value_t	match (const diagram &d, const common::model::access_t &a) const

virtual tvl::value_t	match (const diagram &d, const common::model::namespace_ &ns) const

virtual tvl::value_t	match (const diagram &d, const common::model::source_file &f) const

virtual tvl::value_t	match (const diagram &d, const common::model::source_location &f) const

virtual tvl::value_t	match (const diagram &d, const class_diagram::model::class_method &m) const

virtual tvl::value_t	match (const diagram &d, const class_diagram::model::class_member &m) const

virtual tvl::value_t	match (const diagram &d, const class_diagram::model::objc_method &m) const

virtual tvl::value_t	match (const diagram &d, const class_diagram::model::objc_member &m) const

virtual tvl::value_t	match (const diagram &d, const sequence_diagram::model::participant &p) const

bool	is_inclusive () const

bool	is_exclusive () const

filter_t	type () const

filter_mode_t	mode () const

void	set_mode (filter_mode_t mode)

Private Attributes
std::vector< common::string_or_regex >	roots_

Constructor & Destructor Documentation

◆ subclass_filter()

clanguml::common::model::subclass_filter::subclass_filter	(	filter_t	type,
		std::vector< common::string_or_regex >	roots
	)

Definition at line 805 of file diagram_filter.cc.

    : filter_visitor{type}
    , roots_{std::move(roots)}
{
}

◆ ~subclass_filter()

clanguml::common::model::subclass_filter::~subclass_filter ( )

overridedefault

Member Function Documentation

◆ match()

tvl::value_t clanguml::common::model::subclass_filter::match	(	const diagram &	d,
		const element &	e
	)		const

overridevirtual

Reimplemented from clanguml::common::model::filter_visitor.

Definition at line 812 of file diagram_filter.cc.

{
    if (d.type() != diagram_t::kClass)
        return {};
 
    if (roots_.empty())
        return {};
 
    if (!d.complete())
        return {};
 
    const auto &cd = dynamic_cast<const class_diagram::model::diagram &>(d);
 
    // First get all parents of element e
    clanguml::common::reference_set<class_diagram::model::class_> parents;
 
    const auto &fn = e.full_name(false);
    auto class_ref = cd.find<class_diagram::model::class_>(fn);
 
    if (!class_ref.has_value())
        return false;
 
    parents.emplace(class_ref.value());
 
    cd.get_parents(parents);
 
    std::vector<std::string> parents_names;
    for (const auto p : parents)
        parents_names.push_back(p.get().full_name(false));
 
    // Now check if any of the parents matches the roots specified in the
    // filter config
    for (const auto &root : roots_) {
        for (const auto &parent : parents) {
            auto full_name = parent.get().full_name(false);
            if (root == full_name) {
                if (type() == filter_t::kExclusive)
                    LOG_TRACE("Element {} rejected by subclass_filter",
                        e.full_name(false));
 
                return true;
            }
        }
    }
 
    if (type() == filter_t::kInclusive)
        LOG_TRACE("Element {} rejected by subclass_filter", e.full_name(false));
 
    return false;
}

Member Data Documentation

◆ roots_

std::vector<common::string_or_regex> clanguml::common::model::subclass_filter::roots_

private

Definition at line 351 of file diagram_filter.h.

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

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