dcmwlm/include/dcmtk/dcmwlm/wlfsim.h

/*
 *
 *  Copyright (C) 1996-2010, 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.
 *
 *  Last Update:      $Author: joergr $
 *  Update Date:      $Date: 2010-10-14 13:16:39 $
 *  CVS/RCS Revision: $Revision: 1.18 $
 *  Status:           $State: Exp $
 *
 *  CVS/RCS Log at end of file
 *
 */

#ifndef WlmFileSystemInteractionManager_h
#define WlmFileSystemInteractionManager_h

#include "dcmtk/config/osconfig.h"
#include "dcmtk/ofstd/ofstring.h"
#include "dcmtk/ofstd/oftypes.h"   /* for OFBool */

template <class T> class OFOrderedSet;
struct WlmSuperiorSequenceInfoType;
class DcmDataset;
class DcmTagKey;
class OFConsole;
class OFCondition;
class DcmItem;

class WlmFileSystemInteractionManager
{
  private:
    WlmFileSystemInteractionManager(const WlmFileSystemInteractionManager &old);

    WlmFileSystemInteractionManager &operator=(const WlmFileSystemInteractionManager &obj);

  protected:
    OFString dfPath;
    OFBool enableRejectionOfIncompleteWlFiles;
    OFString calledApplicationEntityTitle;
    DcmDataset **matchingRecords;
    unsigned long numOfMatchingRecords;

    void DetermineWorklistFiles( OFOrderedSet<OFString> &worklistFiles );

    OFBool IsWorklistFile( const char *fname );

    OFBool DatasetIsComplete( DcmDataset *dataset );

    OFBool ReferencedStudyOrPatientSequenceIsAbsentOrExistentButNonEmptyAndIncomplete( DcmTagKey sequenceTagKey, DcmItem *dset );

    OFBool DescriptionAndCodeSequenceAttributesAreIncomplete( DcmTagKey descriptionTagKey, DcmTagKey codeSequenceTagKey, DcmItem *dset );

    OFBool AttributeIsAbsentOrEmpty( DcmTagKey elemTagKey, DcmItem *dset );

    OFBool DatasetMatchesSearchMask( DcmDataset *dataset, DcmDataset *searchMask );

    void DetermineMatchingKeyAttributeValues( DcmDataset *dataset, const char **&matchingKeyAttrValues );

    OFBool ScheduledStationAETitlesMatch( const char *datasetValue, const char *searchMaskValue );

    OFBool ScheduledProcedureStepStartDateTimesMatch( const char *datasetDateValue, const char *datasetTimeValue, const char *searchMaskDateValue, const char *searchMaskTimeValue );

    OFBool ModalitiesMatch( const char *datasetValue, const char *searchMaskValue );

    OFBool ScheduledPerformingPhysicianNamesMatch( const char *datasetValue, const char *searchMaskValue );

    OFBool PatientsNamesMatch( const char *datasetValue, const char *searchMaskValue );

    OFBool PatientsIDsMatch( const char *datasetValue, const char *searchMaskValue );

    OFBool AccessionNumbersMatch( const char *datasetValue, const char *searchMaskValue );

    OFBool RequestedProcedureIdsMatch( const char *datasetValue, const char *searchMaskValue );

    OFBool ReferringPhysicianNamesMatch( const char *datasetValue, const char *searchMaskValue );

    OFBool PatientsSexesMatch( const char *datasetValue, const char *searchMaskValue );

    OFBool RequestingPhysiciansMatch( const char *datasetValue, const char *searchMaskValue );

    OFBool AdmissionIdsMatch( const char *datasetValue, const char *searchMaskValue );

    OFBool RequestedProcedurePrioritiesMatch( const char *datasetValue, const char *searchMaskValue );

    OFBool PatientsBirthDatesMatch( const char *datasetValue, const char *searchMaskValue );

    OFBool DateTimeRangeMatch( const char *datasetDateValue, const char *datasetTimeValue, const char *searchMaskDateValue, const char *searchMaskTimeValue );

    OFBool DateRangeMatch( const char *datasetDateValue, const char *searchMaskDateValue );

    OFBool TimeRangeMatch( const char *datasetTimeValue, const char *searchMaskTimeValue );

    OFBool DateTimeSingleValueMatch( const char *datasetDateValue, const char *datasetTimeValue, const char *searchMaskDateValue, const char *searchMaskTimeValue );

    OFBool DateSingleValueMatch( const char *datasetDateValue, const char *searchMaskDateValue );

    OFBool TimeSingleValueMatch( const char *datasetTimeValue, const char *searchMaskTimeValue );

    OFBool CaseSensitiveSingleValueMatch( const char *datasetValue, const char *searchMaskValue );

    OFBool WildcardMatch( const char *datasetValue, const char *searchMaskValue );

    OFBool MatchStarSymbol( const char *dv, const char *sv );

    void ExtractValuesFromRange( const char *range, char *&lower, char *&upper );

  public:
    WlmFileSystemInteractionManager();

    ~WlmFileSystemInteractionManager();

    void SetEnableRejectionOfIncompleteWlFiles( OFBool value );

    OFCondition ConnectToFileSystem( const OFString& dfPathv );

    OFCondition DisconnectFromFileSystem();

    OFBool IsCalledApplicationEntityTitleSupported( const OFString& calledApplicationEntityTitlev );

    unsigned long DetermineMatchingRecords( DcmDataset *searchMask );

    unsigned long GetNumberOfSequenceItemsForMatchingRecord( DcmTagKey sequenceTag, WlmSuperiorSequenceInfoType *superiorSequenceArray, unsigned long numOfSuperiorSequences, unsigned long idx );

    void GetAttributeValueForMatchingRecord( DcmTagKey tag, WlmSuperiorSequenceInfoType *superiorSequenceArray, unsigned long numOfSuperiorSequences, unsigned long idx, char *&value );

    void ClearMatchingRecords();
};

#endif

/*
** CVS Log
** $Log: wlfsim.h,v $
** Revision 1.18  2010-10-14 13:16:39  joergr
** Updated copyright header. Added reference to COPYRIGHT file.
**
** Revision 1.17  2010-08-09 13:29:39  joergr
** Updated data dictionary to 2009 edition of the DICOM standard. From now on,
** the official "keyword" is used for the attribute name which results in a
** number of minor changes (e.g. "PatientsName" is now called "PatientName").
**
** Revision 1.16  2009-11-24 10:40:01  uli
** Switched to logging mechanism provided by the "new" oflog module.
**
** Revision 1.15  2009-11-02 15:50:25  joergr
** Changed forward declaration from "class" to "struct" in order to avoid
** warning messages reported by VisualStudio 2008.
**
** Revision 1.14  2009-09-30 08:40:34  uli
** Make dcmwlm's include headers self-sufficient by including all
** needed headers directly.
**
** Revision 1.13  2006-12-15 14:49:21  onken
** Removed excessive use char* and C-array in favour of OFString and
** OFList. Simplified some implementation details.
**
** Revision 1.12  2006/01/27 15:06:32  joergr
** Fixed issue with missing type 2 attributes in worklist files being reported
** as incomplete.  Now, the attributes are inserted automatically if required.
** Removed email address from CVS log.
**
** Revision 1.11  2005/12/08 16:05:42  meichel
** Changed include path schema for all DCMTK header files
**
** Revision 1.10  2005/09/23 12:56:40  wilkens
** Added attribute PatientsBirthDate as a matching key attribute to wlmscpfs.
**
** Revision 1.9  2005/06/16 08:06:51  meichel
** Removed redundant class name, needed for gcc 3.4
**
** Revision 1.8  2005/05/04 11:34:31  wilkens
** Added two command line options --enable-file-reject (default) and
** --disable-file-reject to wlmscpfs: these options can be used to enable or
** disable a file rejection mechanism which makes sure only complete worklist files
** will be used during the matching process. A worklist file is considered to be
** complete if it contains all necessary type 1 information which the SCP might
** have to return to an SCU in a C-Find response message.
**
** Revision 1.7  2004/01/07 08:32:28  wilkens
** Added new sequence type return key attributes to wlmscpfs. Fixed bug that for
** equally named attributes in sequences always the same value will be returned.
** Added functionality that also more than one item will be returned in sequence
** type return key attributes.
**
** Revision 1.6  2003/12/23 13:04:36  wilkens
** Integrated new matching key attributes into wlmscpfs.
**
** Revision 1.5  2003/07/02 09:17:55  wilkens
** Updated documentation to get rid of doxygen warnings.
**
** Revision 1.4  2002/12/16 11:08:35  wilkens
** Added missing #include "osconfig.h" to certain files.
**
** Revision 1.3  2002/12/09 13:41:43  joergr
** Renamed parameter to avoid name clash with global function index().
** Added private undefined copy constructor and/or assignment operator.
**
** Revision 1.2  2002/08/12 10:56:08  wilkens
** Made some modifications in in order to be able to create a new application
** which contains both wlmscpdb and ppsscpdb and another application which
** contains both wlmscpfs and ppsscpfs.
**
** Revision 1.1  2002/08/05 09:09:58  wilkens
** Modfified the project's structure in order to be able to create a new
** application which contains both wlmscpdb and ppsscpdb.
**
** Revision 1.1  2002/07/17 13:10:21  wilkens
** Corrected some minor logical errors in the wlmscpdb sources and completely
** updated the wlmscpfs so that it does not use the original wlistctn sources
** any more but standard wlm sources which are now used by all three variants
** of wlmscps.
**
**
*/

---

Generated on 6 Jan 2011 for OFFIS DCMTK Version 3.6.0 by Doxygen 1.5.1