sparta::app::ConfigApplicator::ApplyFilter Struct Reference

Represents a filter for applying parameters based on tree location. More...

#include <ConfigApplicators.hpp>

Public Member Functions
	ApplyFilter ()
	Construct a null-filter (filters nothing)
	ApplyFilter (LocationFilter locfilter, const TreeNode *filternode)
	Construct a location-filter.
	ApplyFilter (const ApplyFilter &)=default
ApplyFilter &	operator= (const ApplyFilter &)=default
bool	test (const TreeNode *n) const
	Test a node against this filter.
LocationFilter	getLocationFilter () const
	Return the location filter policy.
const TreeNode *	getLocationFilterNode () const
	RReturn the location filter node (may be none)

Friends
std::ostream &	operator<< (std::ostream &o, const ConfigApplicator::ApplyFilter *filter)
	Prinit a configuration-application filter.
std::ostream &	operator<< (std::ostream &o, const ConfigApplicator::ApplyFilter &filter)
	Prinit a configuration-application filter.

Detailed Description

Represents a filter for applying parameters based on tree location.

Definition at line 90 of file ConfigApplicators.hpp.

Constructor & Destructor Documentation

ApplyFilter() [1/2]

sparta::app::ConfigApplicator::ApplyFilter::ApplyFilter ( )

inline

Construct a null-filter (filters nothing)

Definition at line 94 of file ConfigApplicators.hpp.

ApplyFilter() [2/2]

sparta::app::ConfigApplicator::ApplyFilter::ApplyFilter ( LocationFilter  locfilter, const TreeNode *  filternode  )

inline

Construct a location-filter.

Parameters

[in]	locfilter	Location-based filter policy
[in]	filternode	Node at which filter is applied

Definition at line 104 of file ConfigApplicators.hpp.

Member Function Documentation

getLocationFilter()

LocationFilter sparta::app::ConfigApplicator::ApplyFilter::getLocationFilter ( ) const

inline

Return the location filter policy.

Definition at line 143 of file ConfigApplicators.hpp.

getLocationFilterNode()

const TreeNode * sparta::app::ConfigApplicator::ApplyFilter::getLocationFilterNode ( ) const

inline

RReturn the location filter node (may be none)

Definition at line 148 of file ConfigApplicators.hpp.

test()

bool sparta::app::ConfigApplicator::ApplyFilter::test ( const TreeNode *  n ) const

inline

Test a node against this filter.

Parameters

[in]

n

Node to test

Returns

true if the node (n) passes the filter, false if not.

Definition at line 120 of file ConfigApplicators.hpp.

Here is the call graph for this function:

Friends And Related Symbol Documentation

operator<< [1/2]

std::ostream & operator<< ( std::ostream &  o, const ConfigApplicator::ApplyFilter &  filter  )

friend

Prinit a configuration-application filter.

Definition at line 166 of file ConfigApplicators.hpp.

operator<< [2/2]

std::ostream & operator<< ( std::ostream &  o, const ConfigApplicator::ApplyFilter *  filter  )

friend

Prinit a configuration-application filter.

Definition at line 153 of file ConfigApplicators.hpp.

---

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

• /github/workspace/sparta/sparta/app/ConfigApplicators.hpp