The templated shortcut class for constructing a filter. More...

#include <Filter.h>

Inheritance diagram for TFilter< Cs >:

Collaboration diagram for TFilter< Cs >:

Public Member Functions
constexpr EFlagmark	GetFlagmark () const
	Get the flagmark specification.

constexpr EFlagmark	GetExcludingFlagmark () const
	Get the excluding flagmark specification.

constexpr bool	Includes (const EFlagmarkBit InBit) const
	Check whether a filter includes a certain flag.

constexpr bool	Includes (const EFlagmark InFlagmark) const
	Check whether a filter includes all of the passed flags.

constexpr bool	Excludes (const EFlagmarkBit InBit) const
	Check whether a filter excludes a certain flag.

constexpr bool	Excludes (const EFlagmark InFlagmark) const
	Check whether a filter excludes all of the passed flags.

template<class ... InCs>
constexpr bool	Includes () const
	Check if the filter includes certain component(s).

template<class ... InCs>
constexpr bool	Excludes () const
	Check if the filter includes certain component(s).

constexpr bool	IsBeltBased () const
	Check if the filter requires a belt-wise iterating process.

constexpr	TFilter ()
	Initialize a new filter instance.

Static Public Member Functions
static constexpr EFlagmark	GetFlagmarkAtCompileTime ()
	Get the compile-time flagmark specification.

static constexpr EFlagmark	GetExcludingFlagmarkAtCompileTime ()
	Get the excluding compile-time flagmark specification.

static constexpr bool	IncludesAtCompileTime (const EFlagmarkBit InBit)
	Check whether a filter includes a certain flag at compile-time.

static constexpr bool	IncludesAtCompileTime (const EFlagmark InFlagmark)
	Check whether a filter includes all of the passed flags at compile-time.

static constexpr bool	ExcludesAtCompileTime (const EFlagmarkBit InBit)
	Check whether a filter excludes a certain flag at compile-time.

static constexpr bool	ExcludesAtCompileTime (const EFlagmark InFlagmark)
	Check whether a filter excludes all of the passed flags at compile-time.

Static Public Attributes
static constexpr EFlagmark	DefaultFlagmark = FFilter::DefaultFlagmark

static constexpr EFlagmark	DefaultExcludingFlagmark = FFilter::DefaultExcludingFlagmark

static constexpr bool	HasFlagmarkSpec = TFlagmarkAccumulator<Cs...>::Count > 0

static constexpr bool	HasExcludingFlagmarkSpec = TExcludingFlagmarkAccumulator<Cs...>::Count > 0

Friends
struct	FFilter

Detailed Description

template<typename ... Cs>
struct TFilter< Cs >

The templated shortcut class for constructing a filter.

Template Parameters

Cs	The components of the filter. May feature traits, details and flagmark indicators.

Constructor & Destructor Documentation

◆ TFilter()

template<typename ... Cs>

constexpr TFilter< Cs >::TFilter ( )

inlineconstexpr

Initialize a new filter instance.

Member Function Documentation

◆ Excludes() [1/3]

template<typename ... Cs>

template<class ... InCs>

constexpr bool TFilter< Cs >::Excludes ( ) const

inlineconstexpr

Check if the filter includes certain component(s).

◆ Excludes() [2/3]

template<typename ... Cs>

constexpr bool TFilter< Cs >::Excludes ( const EFlagmark InFlagmark ) const

inlineconstexpr

Check whether a filter excludes all of the passed flags.

◆ Excludes() [3/3]

template<typename ... Cs>

constexpr bool TFilter< Cs >::Excludes ( const EFlagmarkBit InBit ) const

inlineconstexpr

Check whether a filter excludes a certain flag.

◆ ExcludesAtCompileTime() [1/2]

template<typename ... Cs>

static constexpr bool TFilter< Cs >::ExcludesAtCompileTime ( const EFlagmark InFlagmark )

inlinestaticconstexpr

Check whether a filter excludes all of the passed flags at compile-time.

◆ ExcludesAtCompileTime() [2/2]

template<typename ... Cs>

static constexpr bool TFilter< Cs >::ExcludesAtCompileTime ( const EFlagmarkBit InBit )

inlinestaticconstexpr

Check whether a filter excludes a certain flag at compile-time.

◆ GetExcludingFlagmark()

template<typename ... Cs>

constexpr EFlagmark TFilter< Cs >::GetExcludingFlagmark ( ) const

inlineconstexpr

Get the excluding flagmark specification.

◆ GetExcludingFlagmarkAtCompileTime()

template<typename ... Cs>

static constexpr EFlagmark TFilter< Cs >::GetExcludingFlagmarkAtCompileTime ( )

inlinestaticconstexpr

Get the excluding compile-time flagmark specification.

◆ GetFlagmark()

template<typename ... Cs>

constexpr EFlagmark TFilter< Cs >::GetFlagmark ( ) const

inlineconstexpr

Get the flagmark specification.

◆ GetFlagmarkAtCompileTime()

template<typename ... Cs>

static constexpr EFlagmark TFilter< Cs >::GetFlagmarkAtCompileTime ( )

inlinestaticconstexpr

Get the compile-time flagmark specification.

◆ Includes() [1/3]

template<typename ... Cs>

template<class ... InCs>

constexpr bool TFilter< Cs >::Includes ( ) const

inlineconstexpr

Check if the filter includes certain component(s).

◆ Includes() [2/3]

template<typename ... Cs>

constexpr bool TFilter< Cs >::Includes ( const EFlagmark InFlagmark ) const

inlineconstexpr

Check whether a filter includes all of the passed flags.

◆ Includes() [3/3]

template<typename ... Cs>

constexpr bool TFilter< Cs >::Includes ( const EFlagmarkBit InBit ) const

inlineconstexpr

Check whether a filter includes a certain flag.

◆ IncludesAtCompileTime() [1/2]

template<typename ... Cs>

static constexpr bool TFilter< Cs >::IncludesAtCompileTime ( const EFlagmark InFlagmark )

inlinestaticconstexpr

Check whether a filter includes all of the passed flags at compile-time.

◆ IncludesAtCompileTime() [2/2]

template<typename ... Cs>

static constexpr bool TFilter< Cs >::IncludesAtCompileTime ( const EFlagmarkBit InBit )

inlinestaticconstexpr

Check whether a filter includes a certain flag at compile-time.

◆ IsBeltBased()

template<typename ... Cs>

constexpr bool TFilter< Cs >::IsBeltBased ( ) const

inlineconstexpr

Check if the filter requires a belt-wise iterating process.

Returns true, if there are any details included within the filter.

Friends And Related Function Documentation

◆ FFilter

template<typename ... Cs>

friend struct FFilter

friend

Member Data Documentation

◆ DefaultExcludingFlagmark

template<typename ... Cs>

constexpr EFlagmark TFilter< Cs >::DefaultExcludingFlagmark = FFilter::DefaultExcludingFlagmark

staticconstexpr

◆ DefaultFlagmark

template<typename ... Cs>

constexpr EFlagmark TFilter< Cs >::DefaultFlagmark = FFilter::DefaultFlagmark

staticconstexpr

◆ HasExcludingFlagmarkSpec

template<typename ... Cs>

constexpr bool TFilter< Cs >::HasExcludingFlagmarkSpec = TExcludingFlagmarkAccumulator<Cs...>::Count > 0

staticconstexpr

◆ HasFlagmarkSpec

template<typename ... Cs>

constexpr bool TFilter< Cs >::HasFlagmarkSpec = TFlagmarkAccumulator<Cs...>::Count > 0

staticconstexpr

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

Filter.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ TFilter()

Member Function Documentation

◆ Excludes() [1/3]

◆ Excludes() [2/3]

◆ Excludes() [3/3]

◆ ExcludesAtCompileTime() [1/2]

◆ ExcludesAtCompileTime() [2/2]

◆ GetExcludingFlagmark()

◆ GetExcludingFlagmarkAtCompileTime()

◆ GetFlagmark()

◆ GetFlagmarkAtCompileTime()

◆ Includes() [1/3]

◆ Includes() [2/3]

◆ Includes() [3/3]

◆ IncludesAtCompileTime() [1/2]

◆ IncludesAtCompileTime() [2/2]

◆ IsBeltBased()

Friends And Related Function Documentation

◆ FFilter

Member Data Documentation

◆ DefaultExcludingFlagmark

◆ DefaultFlagmark

◆ HasExcludingFlagmarkSpec

◆ HasFlagmarkSpec