/usr/include/dcmtk/dcmwlm/wlfsim.h is in libdcmtk-dev 3.6.2-3build3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 | /*
*
* Copyright (C) 1996-2017, OFFIS e.V.
* All rights reserved. See COPYRIGHT file for details.
*
* This software and supporting documentation were developed by
*
* OFFIS e.V.
* R&D Division Health
* Escherweg 2
* D-26121 Oldenburg, Germany
*
*
* Module: dcmwlm
*
* Author: Thomas Wilkens
*
* Purpose: Class for managing file system interaction.
*
*/
#ifndef WlmFileSystemInteractionManager_h
#define WlmFileSystemInteractionManager_h
#include "dcmtk/config/osconfig.h"
#include "dcmtk/ofstd/ofstring.h"
#include "dcmtk/ofstd/oftypes.h" /* for OFBool */
#include "dcmtk/ofstd/ofvector.h"
#include "dcmtk/dcmwlm/wldefine.h"
template <class T> class OFOrderedSet;
struct WlmSuperiorSequenceInfoType;
class DcmDataset;
class DcmTagKey;
class OFCondition;
class DcmItem;
/** This class encapsulates data structures and operations for managing
* data base interaction in the framework of the DICOM basic worklist
* management service.
*/
class DCMTK_DCMWLM_EXPORT WlmFileSystemInteractionManager
{
private:
/** Matching keys configuration. */
class MatchingKeys;
/** Privately defined copy constructor.
* @param old Object which shall be copied.
*/
WlmFileSystemInteractionManager(const WlmFileSystemInteractionManager &old);
/** Privately defined assignment operator.
* @param obj Object which shall be copied.
*/
WlmFileSystemInteractionManager &operator=(const WlmFileSystemInteractionManager &obj);
protected:
/// path to database files
OFString dfPath;
/// indicates if wl-files which are lacking return type 1 attributes or information in such attributes shall be rejected or not
OFBool enableRejectionOfIncompleteWlFiles;
/// called AE title
OFString calledApplicationEntityTitle;
/// array of matching records
DcmDataset **matchingRecords;
/// number of array fields
unsigned long numOfMatchingRecords;
/** This function determines all worklist files in the directory specified by
* dfPath and calledApplicationEntityTitle, and returns the complete path and
* filename information in an array of strings.
* @param worklistFiles Set of strings, each specifying path and filename to one worklist file.
*/
void DetermineWorklistFiles( OFVector<OFString> &worklistFiles );
/** This function returns OFTrue if the given filename refers to a worklist file,
* i.e. has an extension of ".wl".
* @param fname The name of the file.
* @return OFTrue in case the given filename refers to a worklist file, OFFalse otherwise.
*/
OFBool IsWorklistFile( const char *fname );
/** This function checks if the given dataset (which represents the information from a
* worklist file) contains all necessary return type 1 information. According to the
* DICOM standard part 4 annex K, the following attributes are type 1 attributes in
* C-Find RSP messages:
* Attribute Tag Return Key Type
* SpecificCharacterSet (0008,0005) 1C (will be checked in WlmDataSourceFileSystem::StartFindRequest(...); this attribute does not have to be checked here)
* ScheduledProcedureStepSequence (0040,0100) 1
* > ScheduledStationAETitle (0040,0001) 1
* > ScheduledProcedureStepStartDate (0040,0002) 1
* > ScheduledProcedureStepStartTime (0040,0003) 1
* > Modality (0008,0060) 1
* > ScheduledProcedureStepDescription (0040,0007) 1C (The ScheduledProcedureStepDescription (0040,0007) or the ScheduledProtocolCodeSequence (0040,0008) or both shall be supported by the SCP; we actually support both, so we have to check if at least one of the two attributes contains valid information.)
* > ScheduledProtocolCodeSequence (0040,0008) 1C (see abobve)
* > > CodeValue (0008,0100) 1
* > > CodingSchemeDesignator (0008,0102) 1
* > ScheduledProcedureStepID (0040,0009) 1
* RequestedProcedureID (0040,1001) 1
* RequestedProcedureDescription (0032,1060) 1C (The RequestedProcedureDescription (0032,1060) or the RequestedProcedureCodeSequence (0032,1064) or both shall be supported by the SCP; we actually support both, so we have to check if at least one of the two attributes contains valid information.)
* RequestedProcedureCodeSequence (0032,1064) 1C (see abobve)
* > > CodeValue (0008,0100) 1
* > > CodingSchemeDesignator (0008,0102) 1
* StudyInstanceUID (0020,000D) 1
* ReferencedStudySequence (0008,1110) 2
* > ReferencedSOPClassUID (0008,1150) 1C (Required if a sequence item is present)
* > ReferencedSOPInstanceUID (0008,1155) 1C (Required if a sequence item is present)
* ReferencedPatientSequence (0008,1120) 2
* > ReferencedSOPClassUID (0008,1150) 1C (Required if a sequence item is present)
* > ReferencedSOPInstanceUID (0008,1155) 1C (Required if a sequence item is present)
* PatientName (0010,0010) 1
* PatientID (0010,0020) 1
* @param dataset - [in] The dataset of the worklist file which is currently examined.
* @return OFTrue in case the given dataset contains all necessary return type 1 information,
* OFFalse otherwise.
*/
OFBool DatasetIsComplete( DcmDataset *dataset );
/** This function checks if the specified sequence attribute is absent or existent but non-empty
* and incomplete in the given dataset.
* @param sequenceTagKey The sequence attribute which shall be checked.
* @param dset The dataset in which the attribute is contained.
* @return OFTrue in case the sequence attribute is absent (and cannot be added to the dataset)
* or existent but non-empty and incomplete, OFFalse otherwise.
*/
OFBool ReferencedStudyOrPatientSequenceIsAbsentOrExistentButNonEmptyAndIncomplete( DcmTagKey sequenceTagKey, DcmItem *dset );
/** This method ensures that either code or description is set to a non-empty value,
* and at the same time none of the attributes is present with a zero-length value.
* If one of these requirements are not met, then OFTrue is returned, otherwise OFFalse.
* @param descriptionTagKey The description attribute which shall be checked.
* @param codeSequenceTagKey The codeSequence attribute which shall be checked.
* @param dset The dataset in which the attributes are contained.
* @return OFFalse (i.e. no error regarding the standard) in case at least
* one of both attributes has a non-empty, valid value, and none
* is set to an empty value. OFTrue otherwise.
*/
OFBool DescriptionAndCodeSequenceAttributesAreIncomplete( DcmTagKey descriptionTagKey, DcmTagKey codeSequenceTagKey, DcmItem *dset );
/** This function checks if the specified attribute is absent or contains an empty value in the given dataset.
* @param elemTagKey The attribute which shall be checked.
* @param dset The dataset in which the attribute is contained.
* @return OFTrue in case the attribute is absent or contains an empty value, OFFalse otherwise.
*/
OFBool AttributeIsAbsentOrEmpty( DcmTagKey elemTagKey, DcmItem *dset );
/** This function returns OFTrue, if the matching key attribute values in the one of the items of the candidate sequence
* match the matching key attribute values in at least one of the items of the query sequence.
* @param candidate The candidate sequence.
* @param query The query sequence.
* @param matchingKeys The matching keys to regard.
* @return OFTrue in case at least one item matches, OFFalse otherwise.
*/
OFBool MatchSequences( DcmSequenceOfItems& candidate, DcmSequenceOfItems& query, const MatchingKeys& matchingKeys );
/** This function returns OFTrue, if the matching key attribute values in the
* dataset match the matching key attribute values in the search mask.
* @param dataset The dataset which shall be checked.
* @param searchMask The search mask.
* @param matchingKeys The matching keys to regard.
* @return OFTrue in case the dataset matches the search mask in the matching key attribute values, OFFalse otherwise.
*/
OFBool DatasetMatchesSearchMask( DcmItem *dataset, DcmItem *searchMask, const MatchingKeys& matchingKeys );
public:
/** default constructor.
*/
WlmFileSystemInteractionManager();
/** destructor
*/
~WlmFileSystemInteractionManager();
/** Set value in member variable.
* @param value The value to set.
*/
void SetEnableRejectionOfIncompleteWlFiles( OFBool value );
/** Connects to the worklist file system database.
* @param dfPathv Path to worklist file system database.
* @return Indicates if the connection could be established or not.
*/
OFCondition ConnectToFileSystem( const OFString& dfPathv );
/** Disconnects from the worklist file system database..
* @return Indicates if the connection was disconnected successfully.
*/
OFCondition DisconnectFromFileSystem();
/** Checks if the given called application entity title is supported. If this is the case,
* OFTrue will be returned, else OFFalse.
* @param calledApplicationEntityTitlev The application entity title which shall be checked
* for support. Valid pointer expected.
* @return OFTrue, if the called application entity title is supported,
* OFFalse, if the called application entity title is not supported or it is not given.
*/
OFBool IsCalledApplicationEntityTitleSupported( const OFString& calledApplicationEntityTitlev );
/** This function determines the records from the worklist files which match
* the given search mask and returns the number of matching records. Also,
* this function will store the matching records in memory in the array
* member variable matchingRecords.
* @param searchMask - [in] The search mask.
* @return Number of matching records.
*/
unsigned long DetermineMatchingRecords( DcmDataset *searchMask );
/** For the matching record that is identified through idx, this function returns the number
* of items that are contained in the sequence element that is referred to by sequenceTag.
* In case this sequence element is itself contained in a certain item of another superior
* sequence, superiorSequenceArray contains information about where to find the correct
* sequence element.
* @param sequenceTag The tag of the sequence element for which the number of items
* shall be determined.
* @param superiorSequenceArray Array which contains information about superior sequence elements
* the given sequence element is contained in.
* @param numOfSuperiorSequences The number of elements in the above array.
* @param idx Identifies the record from which the number of sequence items
* shall be determined.
* @return The number of items that are contained in the sequence element that is referred to by
* sequenceTag and that can be found in sequence items which are specified in superiorSequenceArray.
*/
unsigned long GetNumberOfSequenceItemsForMatchingRecord( DcmTagKey sequenceTag, WlmSuperiorSequenceInfoType *superiorSequenceArray, unsigned long numOfSuperiorSequences, unsigned long idx );
/** This function determines an attribute value of a matching record
* and returns this value in a newly created string to the caller.
* @param tag Attribute tag. Specifies which attribute's value shall be returned.
* @param superiorSequenceArray Array which contains information about superior sequence elements
* the given element is contained in.
* @param numOfSuperiorSequences The number of elements in the above array.
* @param idx Identifies the record from which the attribute value shall be retrieved.
* @param value Pointer to a newly created string that contains the requested value.
* If value was not found an emtpy string will be returned.
*/
void GetAttributeValueForMatchingRecord( DcmTagKey tag, WlmSuperiorSequenceInfoType *superiorSequenceArray, unsigned long numOfSuperiorSequences, unsigned long idx, char *&value );
/** This function frees the memory which was occupied by matchingRecords.
* It shall be called when the matching records are no longer needed.
*/
void ClearMatchingRecords();
};
#endif
|