MeVisLab Toolbox Reference
mlFileListToolsFileAttribute.h
Go to the documentation of this file.
1// Copyright (c) Fraunhofer MEVIS, Germany. All rights reserved.
2// **InsertLicense** code
3//----------------------------------------------------------------------------------
6
11//----------------------------------------------------------------------------------
12
13#pragma once
14
15// Local includes
17
18// ML includes
19#include <mlTypeDefs.h>
20#include <FMEThirdPartyWarningsDisable.h>
21#include <string>
22#include <FMEThirdPartyWarningsRestore.h>
23#include <mlErrorMacros.h>
24
25// DCMTree prototypes.
26#include <DCMTree_Lib.h>
27
29
30// Forwards
31class DicomMessageCollector;
32
33namespace FileListTools {
34
35//-------------------------------------------------------------------------------
38//-------------------------------------------------------------------------------
40 public:
41
53 FileAttribute(const std::string &absoluteFilePath = "",
54 bool passObject = true,
55 std::string volLabel = "",
56 std::string importCfg = "",
57 std::string procSettings = "",
59 filePath (absoluteFilePath),
60 pass (passObject),
61 volumeLabel (volLabel),
62 importConfig (importCfg),
63 processingSettings(procSettings),
64 fileTypeMask (fileTypeMaskArg),
65 otherFile (),
66 isDCMFilePairPart (false),
67 isTiffFilePairPart(false)
68 {
69 }
70
73 IsValidFile = 1,
74 IsOther = 2,
75 IsDCMTiffPair = 4,
76 IsValidDCMFrame = 8,
77 IsUnknownOrInvalidFileType = 16,
78 IsMLImage = 32,
79
80 AllFileTypeBits = 63
81 };
82
83
84 std::string filePath;
86
92
93 bool pass;
95
96 std::string volumeLabel;
99
100 std::string importConfig;
104
112
114
115 std::string otherFile;
117
120};
121
122}; // end namespace FileListTools.
123
126
127
Project global and OS specific declarations.
Class to collect messages and errors related to a given frame handle.
Attributes assigned to files in a FileList according to filter operations on the file names or DICOM ...
bool isDCMFilePairPart
True if this file is the DICOM file of a DCM/Tiff file pair.
MLuint32 fileTypeMask
Bit combination of FileTypeFlags describing the type of file.
std::string importConfig
If non empty then volumes with identical volumeLabel importConfig, and processingSettings will be han...
std::string processingSettings
If non empty then volumes with identical volumeLabel, importConfig, and processingSettings will be ...
bool isTiffFilePairPart
True if this file is the Tiff file of a DCM/Tiff file pair.
std::string otherFile
If a file pair calculation was done then this stores the other part of the file pair,...
DCMTree::Const_TreePtr getDcmTree(DicomMessageCollector &dcmMsgCollector) const
Gets the (cached) tree related to the file name (or loads it if necessary) and updates _dcmLoadErrorC...
FileTypeFlags
Flag bits describing file types.
std::string volumeLabel
Normally "" but can be set to a label stored in the created MultiFileVolume.
std::string filePath
Absolute file name of the file and/or DCMTree, usually only set by creator.
bool pass
If set to true (the default) then the object will be used and passed to the importer,...
FileAttribute(const std::string &absoluteFilePath="", bool passObject=true, std::string volLabel="", std::string importCfg="", std::string procSettings="", MLuint32 fileTypeMaskArg=0)
Constructor to initialize all members with default or with user defined values.
Target mlrange_cast(Source arg)
Generic version of checked ML casts.
unsigned int MLuint32
Definition mlTypeDefs.h:185
boost::shared_ptr< const Tree > Const_TreePtr
Definition DCMTree_Lib.h:73
Namespace containing a number of tools and classes to scan directories for files, assign attributes t...