wlfsim.h

/*
*
*  Copyright (C) 1996-2005, OFFIS
*
*  This software and supporting documentation were developed by
*
*    Kuratorium OFFIS e.V.
*    Healthcare Information and Communication Systems
*    Escherweg 2
*    D-26121 Oldenburg, Germany
*
*  THIS SOFTWARE IS MADE AVAILABLE,  AS IS,  AND OFFIS MAKES NO  WARRANTY
*  REGARDING  THE  SOFTWARE,  ITS  PERFORMANCE,  ITS  MERCHANTABILITY  OR
*  FITNESS FOR ANY PARTICULAR USE, FREEDOM FROM ANY COMPUTER DISEASES  OR
*  ITS CONFORMITY TO ANY SPECIFICATION. THE ENTIRE RISK AS TO QUALITY AND
*  PERFORMANCE OF THE SOFTWARE IS WITH THE USER.
*
*  Module:  dcmwlm
*
*  Author:  Thomas Wilkens
*
*  Purpose: Class for managing file system interaction.
*
*  Last Update:      $Author: meichel $
*  Update Date:      $Date: 2005/12/08 16:05:42 $
*  Source File:      $Source: /share/dicom/cvs-depot/dcmtk/dcmwlm/include/dcmtk/dcmwlm/wlfsim.h,v $
*  CVS/RCS Revision: $Revision: 1.11 $
*  Status:           $State: Exp $
*
*  CVS/RCS Log at end of file
*
*/

#ifndef WlmFileSystemInteractionManager_h
#define WlmFileSystemInteractionManager_h

#include "dcmtk/config/osconfig.h"

template <class T> class OFOrderedSet;
class DcmTagKey;
class OFConsole;
class OFCondition;

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

    WlmFileSystemInteractionManager &operator=(const WlmFileSystemInteractionManager &obj);

  protected:
    OFBool verboseMode;
    OFBool debugMode;
    OFConsole *logStream;
    char *dfPath;
    OFBool enableRejectionOfIncompleteWlFiles;
    char *calledApplicationEntityTitle;
    DcmDataset **matchingRecords;
    unsigned long numOfMatchingRecords;

    void DumpMessage( const char *message );

    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 ScheduledPerformingPhysiciansNamesMatch( const char *datasetValue, const char *searchMaskValue );

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

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

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

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

    OFBool ReferringPhysiciansNamesMatch( 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 SetLogStream( OFConsole *value );

    void SetVerbose( OFBool value );

    void SetDebug( OFBool value );

    void SetEnableRejectionOfIncompleteWlFiles( OFBool value );

    OFCondition ConnectToFileSystem( char *dfPathv );

    OFCondition DisconnectFromFileSystem();

    OFBool IsCalledApplicationEntityTitleSupported( char *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.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.
** Thanks to Andre M. Descombes <andre@descombes.info> for the code template.
**
** 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 20 Dec 2005 for OFFIS DCMTK Version 3.5.4 by Doxygen 1.4.5