OpenWalnut: WDataModuleInputFilterFile Class Reference

OpenWalnut 1.5.0dev

Checks a given WDataModuleInput against a file type. More...

#include <WDataModuleInputFilterFile.h>

Inheritance diagram for WDataModuleInputFilterFile:

Collaboration diagram for WDataModuleInputFilterFile:

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

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

Public Types inherited from WDataModuleInputFilter
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
	WDataModuleInputFilterFile (std::string extension, std::string description)
	Default constructor. More...

virtual	~WDataModuleInputFilterFile ()
	Destructor. More...

const std::string &	getExtension () const
	Get the defined extension. More...

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

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

virtual	~WDataModuleInputFilter ()
	Destructor. More...

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

Private Attributes
std::string	m_extension
	Extension to check against. More...

Detailed Description

Checks a given WDataModuleInput against a file type.

Definition at line 37 of file WDataModuleInputFilterFile.h.

Member Typedef Documentation

◆ ConstSPtr

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

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

Definition at line 48 of file WDataModuleInputFilterFile.h.

◆ SPtr

typedef std::shared_ptr< WDataModuleInputFilterFile > WDataModuleInputFilterFile::SPtr

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

Definition at line 43 of file WDataModuleInputFilterFile.h.

Constructor & Destructor Documentation

◆ WDataModuleInputFilterFile()

WDataModuleInputFilterFile::WDataModuleInputFilterFile	(	std::string	extension,
		std::string	description
	)

Default constructor.

Provide an extension and description for it.

Parameters

extension	the extension, without "." (i.e. "nii.gz")
description	the description for this kind of file.

Definition at line 33 of file WDataModuleInputFilterFile.cpp.

◆ ~WDataModuleInputFilterFile()

WDataModuleInputFilterFile::~WDataModuleInputFilterFile ( )

virtual

Destructor.

Definition at line 40 of file WDataModuleInputFilterFile.cpp.

Member Function Documentation

◆ getExtension()

const std::string & WDataModuleInputFilterFile::getExtension ( ) const

Get the defined extension.

Returns: the extension

Definition at line 55 of file WDataModuleInputFilterFile.cpp.

References m_extension.

◆ matches()

bool WDataModuleInputFilterFile::matches ( WDataModuleInput::ConstSPtr input ) const

virtual

Check whether the filter matches the input or not.

This filter requires the input to be a file with a certain extension.

Parameters

input the input to check against.

Returns: true if the last extension of the file matches.

Implements WDataModuleInputFilter.

Definition at line 45 of file WDataModuleInputFilterFile.cpp.

References m_extension.

Member Data Documentation

◆ m_extension

std::string WDataModuleInputFilterFile::m_extension

private

Extension to check against.

Definition at line 83 of file WDataModuleInputFilterFile.h.

Referenced by getExtension(), and matches().

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