This class is the abstract interface allowing WDataModule to define possible supported WDataModuleInput. More...

#include <WDataModuleInputFilter.h>

Inheritance diagram for WDataModuleInputFilter:

Collaboration diagram for WDataModuleInputFilter:

Public Types
typedef std::shared_ptr< WDataModuleInputFilter >	SPtr
	Convenience typedef for a std::shared_ptr< WDataModuleInputFilter >. More...

typedef std::shared_ptr< const WDataModuleInputFilter >	ConstSPtr
	Convenience typedef for a std::shared_ptr< const WDataModuleInputFilter >. More...

Public Member Functions
	WDataModuleInputFilter (std::string description)
	Default constructor. More...

virtual	~WDataModuleInputFilter ()
	Destructor. More...

virtual bool	matches (WDataModuleInput::ConstSPtr input) const =0
	Check whether the filter matches the input or not. More...

const std::string &	getDescription () const
	Return the description of this filter. More...

Private Attributes
std::string	m_description
	The description of the filter. More...

Detailed Description

This class is the abstract interface allowing WDataModule to define possible supported WDataModuleInput.

Definition at line 37 of file WDataModuleInputFilter.h.

Member Typedef Documentation

◆ ConstSPtr

typedef std::shared_ptr< const WDataModuleInputFilter > WDataModuleInputFilter::ConstSPtr

Convenience typedef for a std::shared_ptr< const WDataModuleInputFilter >.

Definition at line 48 of file WDataModuleInputFilter.h.

◆ SPtr

typedef std::shared_ptr< WDataModuleInputFilter > WDataModuleInputFilter::SPtr

Convenience typedef for a std::shared_ptr< WDataModuleInputFilter >.

Definition at line 43 of file WDataModuleInputFilter.h.

Constructor & Destructor Documentation

◆ WDataModuleInputFilter()

WDataModuleInputFilter::WDataModuleInputFilter ( std::string description )

explicit

Default constructor.

Always provide a useful description!

Parameters

description a useful description

Definition at line 29 of file WDataModuleInputFilter.cpp.

◆ ~WDataModuleInputFilter()

WDataModuleInputFilter::~WDataModuleInputFilter ( )

virtual

Destructor.

Definition at line 35 of file WDataModuleInputFilter.cpp.

Member Function Documentation

◆ getDescription()

const std::string & WDataModuleInputFilter::getDescription ( ) const

Return the description of this filter.

Returns: the description

Definition at line 40 of file WDataModuleInputFilter.cpp.

References m_description.

◆ matches()

virtual bool WDataModuleInputFilter::matches ( WDataModuleInput::ConstSPtr input ) const

pure virtual

Check whether the filter matches the input or not.

You can check contents of the file/stream/... if you like to be more accurate.

Parameters

input the input to check against.

Returns: true if the filter matches.

Implemented in WDataModuleInputFilterFile.

Member Data Documentation

◆ m_description

std::string WDataModuleInputFilter::m_description

private

The description of the filter.

Definition at line 82 of file WDataModuleInputFilter.h.

Referenced by getDescription().

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

Public Types

Public Member Functions

Private Attributes