MeVisLab Toolbox Reference
Public Types | Public Member Functions | List of all members
ml::MultiFileVolumeListFind Class Reference

Class implementing some search functionality on MultiFileVolumeLists. More...

#include <mlMultiFileVolumeListFind.h>

Public Types

enum  BooleanOperation { BOOLEAN_OP_AND = 0 , BOOLEAN_OP_OR , NUM_BOOLEAN_OPS }
 An enumeration to define the boolean op to be performed on the results of all search items. More...
 

Public Member Functions

 MultiFileVolumeListFind ()
 
MultiFileVolume * findVolumeByInstanceUID (const MultiFileVolumeList &mfvList, std::string sopClassUID, std::string sopInstanceUID) const
 Find a volume in mfvList using given SOPClassUID and SOPInstanceUID.
 
bool findVolumesByCriteria (const MultiFileVolumeList &mfvList, TSearchTerm searchTerm, std::vector< MLuint32 > &outVolumeIds, BooleanOperation booleanOperation, bool searchAnyValue) const
 Find volumes in mfvList using given searchTerm (containing e.g.
 

Detailed Description

Class implementing some search functionality on MultiFileVolumeLists.

Definition at line 40 of file mlMultiFileVolumeListFind.h.

Member Enumeration Documentation

◆ BooleanOperation

enum ml::MultiFileVolumeListFind::BooleanOperation

An enumeration to define the boolean op to be performed on the results of all search items.

Enumerator
BOOLEAN_OP_AND 
BOOLEAN_OP_OR 
NUM_BOOLEAN_OPS 

Definition at line 45 of file mlMultiFileVolumeListFind.h.

Constructor & Destructor Documentation

◆ MultiFileVolumeListFind()

ml::MultiFileVolumeListFind::MultiFileVolumeListFind ( )
inline

Definition at line 52 of file mlMultiFileVolumeListFind.h.

Member Function Documentation

◆ findVolumeByInstanceUID()

MultiFileVolume * ml::MultiFileVolumeListFind::findVolumeByInstanceUID ( const MultiFileVolumeList & mfvList,
std::string sopClassUID,
std::string sopInstanceUID ) const

Find a volume in mfvList using given SOPClassUID and SOPInstanceUID.

◆ findVolumesByCriteria()

bool ml::MultiFileVolumeListFind::findVolumesByCriteria ( const MultiFileVolumeList & mfvList,
TSearchTerm searchTerm,
std::vector< MLuint32 > & outVolumeIds,
BooleanOperation booleanOperation,
bool searchAnyValue ) const

Find volumes in mfvList using given searchTerm (containing e.g.

DICOM tag ids of uint32 type); all criteria are composed with booleanOperation.

Parameters
mfvListThe MultiFileVolumeList in which the tag+value combination is searched.
searchTermThe multimap of pairs of raw-tag-id and value to be searched.
outVolumeIdsThe vector with index ids of all matching volumes in mfvList.
booleanOperationThe boolean operation deciding whether all searchTerm must be fulfilled (And) or only at least one (Or).
searchAnyValueIf true then it is looked only existing tags and not for the value, otherwise the value must match.
Returns
true if the criteria match, otherwise false.
The documentation for this class was generated from the following file: