ml::DicomMessageFilter Class Reference

Class describing a string id of a message, a set of substrings how it can be found by searching them in a string as well as a match routine performing such a search. More...

#include <mlDicomMessageFilter.h>

Public Types
typedef std::vector< std::string >	DicomMessageListType
	Container type of the list of filtered substring. More...

Public Member Functions
	DicomMessageFilter (const std::string &filterIdString, const DicomMessageListType &filterSubStrings=DicomMessageListType(), bool useCaseSensitiveFiltering=true)
	Creates an empty message with no filter features. More...
virtual	~DicomMessageFilter ()
	Virtual destructor. More...
const std::string &	filterIdString () const
	Returns the constructor argument filterIdString. More...
bool	useCaseSensitiveFiltering () const
	Returns true if message is be filtered case sensitively, otherwise false. More...
bool &	useCaseSensitiveFiltering ()
	Returns true if message is be filtered case sensitively, otherwise false. More...
bool	isFiltered () const
	Returns true if message shall be filtered / suppressed, otherwise false. More...
bool &	isFiltered ()
	Returns true if message shall be filtered / suppressed, otherwise false. More...
const DicomMessageListType &	filterSubStrings () const
	Returns the constant list of string which must be found in a message to filter it out. More...
DicomMessageListType &	filterSubStrings ()
	Returns the modifiable list of string which must be found in a message to filter it out. More...
bool	matches (std::string message) const
	Returns false if none of filterSubStrings() can be found in message, otherwise true. More...

Detailed Description

Class describing a string id of a message, a set of substrings how it can be found by searching them in a string as well as a match routine performing such a search.

Definition at line 28 of file mlDicomMessageFilter.h.

Member Typedef Documentation

DicomMessageListType

typedef std::vector<std::string> ml::DicomMessageFilter::DicomMessageListType

Container type of the list of filtered substring.

Definition at line 31 of file mlDicomMessageFilter.h.

Constructor & Destructor Documentation

DicomMessageFilter()

ml::DicomMessageFilter::DicomMessageFilter ( const std::string &  filterIdString, const DicomMessageListType &  filterSubStrings = DicomMessageListType(), bool  useCaseSensitiveFiltering = true  )

inline

Creates an empty message with no filter features.

Definition at line 34 of file mlDicomMessageFilter.h.

~DicomMessageFilter()

virtual ml::DicomMessageFilter::~DicomMessageFilter ( )

inlinevirtual

Virtual destructor.

Definition at line 43 of file mlDicomMessageFilter.h.

Member Function Documentation

filterIdString()

const std::string& ml::DicomMessageFilter::filterIdString ( ) const

inline

Returns the constructor argument filterIdString.

Definition at line 46 of file mlDicomMessageFilter.h.

filterSubStrings() [1/2]

DicomMessageListType& ml::DicomMessageFilter::filterSubStrings ( )

inline

Returns the modifiable list of string which must be found in a message to filter it out.

Definition at line 64 of file mlDicomMessageFilter.h.

filterSubStrings() [2/2]

const DicomMessageListType& ml::DicomMessageFilter::filterSubStrings ( ) const

inline

Returns the constant list of string which must be found in a message to filter it out.

Definition at line 61 of file mlDicomMessageFilter.h.

isFiltered() [1/2]

bool& ml::DicomMessageFilter::isFiltered ( )

inline

Returns true if message shall be filtered / suppressed, otherwise false.

Definition at line 58 of file mlDicomMessageFilter.h.

isFiltered() [2/2]

bool ml::DicomMessageFilter::isFiltered ( ) const

inline

Returns true if message shall be filtered / suppressed, otherwise false.

Definition at line 55 of file mlDicomMessageFilter.h.

matches()

bool ml::DicomMessageFilter::matches

(

std::string

message

)

const

Returns false if none of filterSubStrings() can be found in message, otherwise true.

useCaseSensitiveFiltering() [1/2]

bool& ml::DicomMessageFilter::useCaseSensitiveFiltering ( )

inline

Returns true if message is be filtered case sensitively, otherwise false.

Definition at line 52 of file mlDicomMessageFilter.h.

useCaseSensitiveFiltering() [2/2]

bool ml::DicomMessageFilter::useCaseSensitiveFiltering ( ) const

inline

Returns true if message is be filtered case sensitively, otherwise false.

Definition at line 49 of file mlDicomMessageFilter.h.

---

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

• FMEstable/ReleaseMeVis/Projects/DICOM/MLDicomMessageFilter/Sources/mlDicomMessageFilter.h