dcmpstat/include/dcmtk/dcmpstat/dviface.h

/*
 *
 *  Copyright (C) 1998-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: dcmpstat
 *
 *  Author: Marco Eichelberg, Joerg Riesmeier
 *
 *  Purpose:
 *    classes: DVInterface
 *
 *  Last Update:      $Author: joergr $
 *  Update Date:      $Date: 2010-10-14 13:16:35 $
 *  CVS/RCS Revision: $Revision: 1.95 $
 *  Status:           $State: Exp $
 *
 *  CVS/RCS Log at end of file
 *
 */


#ifndef DVIFACE_H
#define DVIFACE_H

#include "dcmtk/config/osconfig.h"   /* make sure OS specific configuration is included first */


#include "dcmtk/ofstd/ofstream.h"
#include "dcmtk/dcmpstat/dvpscf.h"     /* for class DVConfiguration */
#include "dcmtk/dcmpstat/dvpstat.h"    /* for class DVPresentationState */
#include "dcmtk/dcmqrdb/dcmqridx.h"    /* for struct IdxRecord */
#include "dcmtk/ofstd/ofstring.h"      /* for class OFString */
#include "dcmtk/dcmpstat/dvcache.h"    /* for index file caching */


class DicomImage;
class DiDisplayFunction;
class DVPSStoredPrint;
class DVPSPrintMessageHandler;
class DSRDocument;
class DVSignatureHandler;

class DVInterface: public DVConfiguration
{

 public:

    DVInterface(const char *config_file = NULL, OFBool useLog = OFFalse);

    virtual ~DVInterface();

    /* load images, presentation states and structured reports */

    OFCondition loadImage(const char *studyUID, const char *seriesUID, const char *instanceUID, OFBool changeStatus = OFFalse);

    OFCondition loadImage(const char *filename);

    OFCondition loadReferencedImage(size_t idx, OFBool changeStatus = OFFalse);

    OFCondition loadPState(const char *studyUID, const char *seriesUID, const char *instanceUID, OFBool changeStatus = OFFalse);

    OFCondition loadPState(const char *pstName, const char *imgName = NULL);

    OFCondition loadStructuredReport(const char *studyUID, const char *seriesUID, const char *instanceUID, OFBool changeStatus = OFFalse);

    OFCondition loadStructuredReport(const char *filename);

    OFCondition loadSRTemplate(const char *reportID);

    OFCondition savePState(OFBool replaceSOPInstanceUID);

    OFCondition savePState(const char *filename, OFBool replaceSOPInstanceUID, OFBool explicitVR=OFTrue);

    OFCondition saveCurrentImage(const char *filename, OFBool explicitVR=OFTrue);

    OFCondition saveStructuredReport();

    OFCondition saveStructuredReport(const char *filename, OFBool explicitVR=OFTrue);

    OFCondition addImageReferenceToPState(const char *studyUID, const char *seriesUID, const char *instanceUID);

    size_t getNumberOfImageReferences();

    DVPresentationState& getCurrentPState()
    {
      return *pState;
    }

    DSRDocument& getCurrentReport()
    {
      return *pReport;
    }

    DVPSStoredPrint& getPrintHandler()
    {
      return *pPrint;
    }

    OFCondition resetPresentationState();

    OFCondition saveCurrentPStateForReset();

    OFCondition releaseDatabase();

    const char *getFilename(const char *studyUID, const char *seriesUID, const char *instanceUID);

    Uint32 getNumberOfStudies();

    OFCondition selectStudy(Uint32 idx);

    OFCondition selectStudy(const char *studyUID);

    DVIFhierarchyStatus getStudyStatus() ;

    const char *getStudyUID();

    const char *getStudyDescription();

    const char *getStudyDate();

    const char *getStudyTime();

    const char *getReferringPhysiciansName();

    const char *getAccessionNumber();

    const char *getNameOfPhysiciansReadingStudy();

    const char *getPatientName();

    const char *getPatientID();

    const char *getPatientBirthDate();

    const char *getPatientSex();

    const char *getPatientBirthTime();

    const char *getOtherPatientNames();

    const char *getOtherPatientID();

    const char *getEthnicGroup();

    Uint32 getNumberOfSeries();

    OFCondition selectSeries(Uint32 idx);

    OFCondition selectSeries(const char *seriesUID);

    const char *getSeriesUID();

    DVIFhierarchyStatus getSeriesStatus();

    DVPSInstanceType getSeriesType();

    DVPSInstanceType getInstanceType();

    const char *getSeriesNumber();

    const char *getSeriesDate();

    const char *getSeriesTime();

    const char *getSeriesDescription();

    const char *getSeriesPerformingPhysiciansName();

    const char *getSeriesProtocolName();

    const char *getSeriesOperatorsName();

    const char *getModality();

    Uint32 getNumberOfInstances();

    OFCondition selectInstance(Uint32 idx);

    OFCondition selectInstance(const char *instanceUID);

    OFCondition selectInstance(const char *instanceUID, const char *sopClassUID);

    OFCondition selectInstance(const char *studyUID, const char *seriesUID, const char *instanceUID);

    const char *getSOPClassUID();

    const char *getInstanceUID();

    const char *getImageNumber();

    const char *getFilename();

    DVIFhierarchyStatus getInstanceStatus() ;

    const char *getInstanceDescription();

    const char *getPresentationLabel();


    /* methods modifying the database */

    OFCondition instanceReviewed(const char *studyUID, const char *seriesUID, const char *instanceUID);

    OFCondition deleteInstance(const char *studyUID, const char *seriesUID, const char *instanceUID);

    OFCondition deleteSeries(const char *studyUID, const char *seriesUID);

    OFCondition deleteStudy(const char *studyUID);

    /* here follow the Network interface methods */

    OFCondition startReceiver();

    OFCondition terminateReceiver();

    OFCondition startQueryRetrieveServer();

    OFCondition terminateQueryRetrieveServer();

    OFBool newInstancesReceived();

    OFCondition sendStudy(const char *targetID, const char *studyUID)
    {
      return sendIOD(targetID, studyUID, NULL, NULL);
    }

    OFCondition sendSeries(const char *targetID, const char *studyUID, const char *seriesUID)
    {
      return sendIOD(targetID, studyUID, seriesUID, NULL);
    }

    OFCondition sendIOD(const char *targetID, const char *studyUID, const char *seriesUID, const char *instanceUID);

    OFCondition dumpIOD(const char *filename);

    OFCondition dumpIOD(const char *studyUID, const char *seriesUID, const char *instanceUID);

    OFCondition checkIOD(const char *filename);

    OFCondition checkIOD(const char *studyUID, const char *seriesUID, const char *instanceUID);

    OFCondition saveDICOMImage(
      const char *filename,
      const void *pixelData,
      unsigned long width,
      unsigned long height,
      double aspectRatio=1.0,
      OFBool explicitVR=OFTrue,
      const char *instanceUID=NULL);

    OFCondition saveDICOMImage(
      const void *pixelData,
      unsigned long width,
      unsigned long height,
      double aspectRatio=1.0);

    OFCondition saveHardcopyGrayscaleImage(
      const char *filename,
      const void *pixelData,
      unsigned long width,
      unsigned long height,
      double aspectRatio=1.0,
      OFBool explicitVR=OFTrue,
      const char *instanceUID=NULL);

    OFCondition saveHardcopyGrayscaleImage(
      const void *pixelData,
      unsigned long width,
      unsigned long height,
      double aspectRatio=1.0);

    OFCondition saveFileFormatToDB(DcmFileFormat &fileformat);

    OFCondition loadStoredPrint(const char *studyUID, const char *seriesUID, const char *instanceUID, OFBool changeStatus = OFFalse);

    OFCondition loadStoredPrint(const char *filename);

    OFCondition saveStoredPrint(
      const char *filename,
      OFBool writeRequestedImageSize,
      OFBool explicitVR=OFTrue,
      const char *instanceUID=NULL);

    OFCondition saveStoredPrint(OFBool writeRequestedImageSize);

    size_t getNumberOfPrintPreviews();

    OFCondition loadPrintPreview(size_t idx, OFBool printLUT = OFTrue, OFBool changeStatus = OFFalse);

    void unloadPrintPreview();

    unsigned long getPrintPreviewSize();

    void setMaxPrintPreviewWidthHeight(unsigned long width, unsigned long height);

    OFCondition getPrintPreviewWidthHeight(unsigned long &width, unsigned long &height);

    OFCondition getPrintPreviewBitmap(void *bitmap, unsigned long size);

    OFCondition disablePState();

    OFCondition enablePState();

    Uint32 getNumberOfPStates();

    OFCondition selectPState(Uint32 idx, OFBool changeStatus = OFFalse);

    const char *getPStateDescription(Uint32 idx);

    const char *getPStateLabel(Uint32 idx);

    OFBool isDisplayTransformPossible(DVPSDisplayTransform transform = DVPSD_GSDF);

    OFCondition setAmbientLightValue(double value);

    OFCondition getAmbientLightValue(double &value);

    /* print related methods */

    OFCondition setCurrentPrinter(const char *targetID);

    const char *getCurrentPrinter();

    OFCondition setPrinterMediumType(const char *value);

    const char *getPrinterMediumType();

    OFCondition setPrinterFilmDestination(const char *value);

    const char *getPrinterFilmDestination();

    OFCondition setPrinterFilmSessionLabel(const char *value);

    const char *getPrinterFilmSessionLabel();

    OFCondition setPrinterPriority(const char *value);

    const char *getPrinterPriority();

    OFCondition setPrinterOwnerID(const char *value);

    const char *getPrinterOwnerID();

    OFCondition setPrinterNumberOfCopies(unsigned long value);

    unsigned long getPrinterNumberOfCopies();

    void clearFilmSessionSettings();

    OFCondition selectDisplayPresentationLUT(const char *lutID);

    const char *getDisplayPresentationLUTID();

    OFCondition selectPrintPresentationLUT(const char *lutID);

    const char *getPrintPresentationLUTID();

    OFCondition spoolPrintJob(OFBool deletePrintedImages=OFTrue);

    OFCondition startPrintSpooler();

    OFCondition terminatePrintSpooler();

    OFCondition startPrintServer();

    OFCondition terminatePrintServer();

    OFCondition addToPrintHardcopyFromDB(const char *studyUID, const char *seriesUID, const char *instanceUID);

    OFCondition spoolStoredPrintFromDB(const char *studyUID, const char *seriesUID, const char *instanceUID);

    OFCondition printSCUcreateBasicFilmSession(DVPSPrintMessageHandler& printHandler, OFBool plutInSession);

    /* annotation interface */

    OFBool isActiveAnnotation() { return activateAnnotation; }

    OFBool getPrependDateTime() { return prependDateTime; }

    OFBool getPrependPrinterName() { return prependPrinterName; }

    OFBool getPrependLighting() { return prependLighting; }

    const char *getAnnotationText() { return annotationText.c_str(); }

    void setActiveAnnotation(OFBool value) { activateAnnotation=value; }

    void setPrependDateTime(OFBool value) { prependDateTime=value; }

    void setPrependPrinterName(OFBool value) { prependPrinterName=value; }

    void setPrependLighting(OFBool value) { prependLighting=value; }

    void setAnnotationText(const char *value);

    /* user management interface */

    OFBool verifyUserPassword(const char *userID, const char *passwd);

    OFCondition verifyAndSignStructuredReport(const char *userID, const char *passwd, DVPSVerifyAndSignMode mode);


    /* digital signatures */

    const char *getCurrentSignatureValidationHTML(DVPSObjectType objtype) const;

    const char *getCurrentSignatureValidationOverview() const;

    DVPSSignatureStatus getCurrentSignatureStatus(DVPSObjectType objtype) const;

    DVPSSignatureStatus getCombinedImagePStateSignatureStatus() const;

    unsigned long getNumberOfCorrectSignatures(DVPSObjectType objtype) const;

    unsigned long getNumberOfUntrustworthySignatures(DVPSObjectType objtype) const;

    unsigned long getNumberOfCorruptSignatures(DVPSObjectType objtype) const;

    void disableImageAndPState();

private:

    DVInterface(const DVInterface&);

    DVInterface& operator=(const DVInterface&);

    OFCondition exchangeImageAndPState(DVPresentationState *newState, DcmFileFormat *image, DcmFileFormat *state=NULL);

    OFCondition lockDatabase();

    OFCondition lockExclusive();

    OFCondition unlockExclusive();

    OFCondition createPrintJobFilenames(const char *printer, OFString& tempname, OFString& jobname);

    OFCondition createQueryRetrieveServerConfigFile(const char *filename);

    OFCondition startExternalApplication(const char *application, const char *filename);

    /* member variables */

    DVPSStoredPrint *pPrint;

    DVPresentationState *pState;

    DSRDocument *pReport;

    DVSignatureHandler *pSignatureHandler;

    DVPresentationState *pStoredPState;

    DcmFileFormat *pDicomImage;

    DcmFileFormat *pDicomPState;

    DicomImage *pHardcopyImage;

    OFString printJobIdentifier;

    unsigned long printJobCounter;

    OFString configPath;

    OFString databaseIndexFile;

    unsigned long referenceTime;

    DiDisplayFunction *displayFunction[DVPSD_max];

    DcmQueryRetrieveIndexDatabaseHandle *pHandle;

    OFBool lockingMode;

    DVStudyCache idxCache;

    IdxRecord idxRec;

    int idxRecPos;

    OFBool imageInDatabase;

    /* private methods for database */

    OFBool createIndexCache();

    OFBool createPStateCache();

    void clearIndexCache();

    void clearIndexRecord(IdxRecord &record,
                          int &recpos);

    OFBool readIndexRecord(const int pos,
                           IdxRecord &record,
                           int *oldpos = NULL);

    void updateStatusCache();

    DVStudyCache::ItemStruct *getStudyStruct(const char *studyUID = NULL,
                                             const char *seriesUID = NULL);

    DVSeriesCache::ItemStruct *getSeriesStruct(const char *studyUID = NULL,
                                               const char *seriesUID = NULL,
                                               const char *instanceUID = NULL);

    DVInstanceCache::ItemStruct *getInstanceStruct(const char *studyUID = NULL,
                                                   const char *seriesUID = NULL,
                                                   const char *instanceUID = NULL);

    int findStudyIdx(StudyDescRecord *study,
                     const char *uid);

    int deleteImageFile(const char *filename);

    void resetDatabaseReferenceTime();


    OFCondition instanceReviewed(int pos);

    unsigned long minimumPrintBitmapWidth;

    unsigned long minimumPrintBitmapHeight;

    unsigned long maximumPrintBitmapWidth;

    unsigned long maximumPrintBitmapHeight;

    unsigned long maximumPrintPreviewWidth;

    unsigned long maximumPrintPreviewHeight;

    unsigned long maximumPreviewImageWidth;

    unsigned long maximumPreviewImageHeight;

    OFString currentPrinter;

    OFString displayCurrentLUTID;

    OFString printCurrentLUTID;

    OFString printerMediumType;

    OFString printerFilmDestination;

    OFString printerFilmSessionLabel;

    unsigned long printerNumberOfCopies;

    OFString printerPriority;

    OFString printerOwnerID;

    OFBool activateAnnotation;

    OFBool prependDateTime;

    OFBool prependPrinterName;

    OFBool prependLighting;

    OFString annotationText;
};


#endif


/*
 *  CVS/RCS Log:
 *  $Log: dviface.h,v $
 *  Revision 1.95  2010-10-14 13:16:35  joergr
 *  Updated copyright header. Added reference to COPYRIGHT file.
 *
 *  Revision 1.94  2009-11-24 14:12:57  uli
 *  Switched to logging mechanism provided by the "new" oflog module.
 *
 *  Revision 1.93  2009-09-30 10:42:37  uli
 *  Make dcmpstat's include headers self-sufficient by including all
 *  needed headers directly and stop using dctk.h
 *
 *  Revision 1.92  2009-05-28 10:55:38  joergr
 *  Fixed various Doxygen API documentation issues.
 *
 *  Revision 1.91  2005/12/08 16:03:31  meichel
 *  Changed include path schema for all DCMTK header files
 *
 *  Revision 1.90  2005/04/04 10:11:57  meichel
 *  Module dcmpstat now uses the dcmqrdb API instead of imagectn for maintaining
 *    the index database
 *
 *  Revision 1.89  2004/02/04 15:48:23  joergr
 *  Removed acknowledgements with e-mail addresses from CVS log.
 *
 *  Revision 1.88  2003/04/29 10:13:56  meichel
 *  Moved configuration file parser from module dcmpstat to ofstd and renamed
 *    class to OFConfigFile. Cleaned up implementation (no more friend declarations).
 *
 *  Revision 1.87  2002/04/16 14:02:02  joergr
 *  Added configurable support for C++ ANSI standard includes (e.g. streams).
 *
 *  Revision 1.86  2001/09/26 15:36:06  meichel
 *  Adapted dcmpstat to class OFCondition
 *
 *  Revision 1.85  2001/02/23 13:31:46  joergr
 *  Changed behaviour of method verifyAndSignStructuredReport() with 'finalize'.
 *  Now the entire document is always signed independently from the tree items
 *  marked.
 *
 *  Revision 1.84  2001/01/29 17:32:30  joergr
 *  Added method to verify and digitally sign structured reports.
 *
 *  Revision 1.83  2001/01/29 14:55:41  meichel
 *  Added new methods for creating signatures and checking the signature
 *    status in module dcmpstat.
 *
 *  Revision 1.82  2001/01/25 15:18:04  meichel
 *  Added initial support for verification of digital signatures
 *    in presentation states, images and structured reports to module dcmpstat.
 *
 *  Revision 1.81  2000/11/14 16:35:16  joergr
 *  Added creation of new UIDs and setting of content date/time when starting
 *  a new SR document from a "template".
 *
 *  Revision 1.80  2000/11/13 15:50:42  meichel
 *  Added dcmpstat support methods for creating image references
 *    in SR documents.
 *
 *  Revision 1.79  2000/11/13 11:52:40  meichel
 *  Added support for user logins and certificates.
 *
 *  Revision 1.78  2000/11/13 10:42:38  joergr
 *  Added support for Structured Reporting "templates".
 *
 *  Revision 1.77  2000/10/16 11:39:43  joergr
 *  Added support for new structured reports.
 *  Added method allowing to select an instance by instance UID and SOP class
 *  UID (without series and study UID). Required for composite references in
 *  DICOM SR.
 *
 *  Revision 1.76  2000/10/10 12:23:39  meichel
 *  Added extensions for TLS encrypted communication
 *
 *  Revision 1.75  2000/07/18 16:02:35  joergr
 *  Moved method convertODtoLum/PValue from class DVInterface to DVPSStoredPrint
 *  and corrected implementation.
 *
 *  Revision 1.74  2000/07/17 12:05:09  joergr
 *  Added methods to select objects from the database directly.
 *
 *  Revision 1.73  2000/07/14 17:09:47  joergr
 *  Added changeStatus parameter to all methods loading instances from the
 *  database.
 *
 *  Revision 1.72  2000/07/06 09:41:00  joergr
 *  Added flag to loadPrintPreview() method allowing to choose how to interpret
 *  the presentation LUT (hardcopy or softcopy definition).
 *
 *  Revision 1.71  2000/07/04 15:58:00  joergr
 *  Added support for overriding the presentation LUT settings made for the
 *  image boxes.
 *
 *  Revision 1.70  2000/06/21 15:40:57  meichel
 *  Added DICOMscope support for calling the Presentation State Checker.
 *
 *  Revision 1.69  2000/06/09 10:13:54  joergr
 *  Added method to get number of presentation states referencing an image
 *  (specified by the three UIDs).
 *
 *  Revision 1.68  2000/06/08 17:36:23  joergr
 *  Added method convertODtoLum().
 *
 *  Revision 1.67  2000/06/07 14:15:52  joergr
 *  Added configuration file entry "LogLevel" to filter log messages.
 *  Added flag to constructor specifying whether the general log file should be
 *  used (default: off).
 *
 *  Revision 1.66  2000/06/05 16:21:30  joergr
 *  Implemented log message methods.
 *  Added method allowing to specify the current presentation state to be used
 *  for resetting the pstate.
 *
 *  Revision 1.65  2000/06/02 16:00:41  meichel
 *  Adapted all dcmpstat classes to use OFConsole for log and error output
 *
 *  Revision 1.64  2000/06/02 13:53:53  joergr
 *  Implemented start/terminatePrintServer methods.
 *
 *  Revision 1.63  2000/06/02 12:41:50  joergr
 *  Corrected wrong interface descriptions.
 *
 *  Revision 1.62  2000/05/31 12:56:37  meichel
 *  Added initial Print SCP support
 *
 *  Revision 1.61  2000/05/31 07:54:23  joergr
 *  Added support for Stored Print attributes Originator and Destination
 *  application entity title.
 *
 *  Revision 1.60  2000/05/30 13:36:45  joergr
 *  Added new private SOP class (UID definition) to allow external shutdown
 *  of console applications via negotiation of this special SOP class
 *  (currently used for imagectn and dcmpsrcv).
 *  Renamed GrayscaleHardcopy to HardcopyGrayscale (which is the correct term
 *  according to the DICOM standard).
 *  Added support for multi-frame images and multiple references from a single
 *  presentation to a number of images.
 *  Removed methods which were already marked as "retired".
 *  Added interface methods to support the following new features:
 *    - start/terminate query/retrieve server
 *    - load stored print objects
 *    - create print preview from hardcopy grayscale images
 *    - check DICOM IODs for correctness (not yet implemented)
 *    - set presentation LUT for film session (not yet implemented)
 *    - start/terminate print server (not yet implemented)
 *    - write/filter log messages (not yet implemented)
 *
 *  Revision 1.59  2000/03/08 16:28:47  meichel
 *  Updated copyright header.
 *
 *  Revision 1.58  2000/03/03 14:13:54  meichel
 *  Implemented library support for redirecting error messages into memory
 *    instead of printing them to stdout/stderr for GUI applications.
 *
 *  Revision 1.57  1999/11/03 13:05:31  meichel
 *  Added support for transmitting annotations in the film session label.
 *    Added support for dump tool launched from DVInterface.
 *
 *  Revision 1.56  1999/10/20 10:47:13  joergr
 *  Added support for a down-scaled preview image of the current DICOM image
 *  (e.g. useful for online-windowing or print preview).
 *
 *  Revision 1.55  1999/10/19 14:46:01  meichel
 *  added support for the Basic Annotation Box SOP Class
 *    as well as access methods for Max Density and Min Density.
 *
 *  Revision 1.54  1999/10/07 17:21:45  meichel
 *  Reworked management of Presentation LUTs in order to create tighter
 *    coupling between Softcopy and Print.
 *
 *  Revision 1.53  1999/09/27 10:41:52  meichel
 *  Print interface now copies current printer name, avoids JNI problems.
 *
 *  Revision 1.52  1999/09/24 15:24:28  meichel
 *  Added support for CP 173 (Presentation LUT clarifications)
 *
 *  Revision 1.51  1999/09/23 17:37:12  meichel
 *  Added support for Basic Film Session options to dcmpstat print code.
 *
 *  Revision 1.50  1999/09/17 14:33:55  meichel
 *  Completed print spool functionality including Supplement 22 support
 *
 *  Revision 1.49  1999/09/15 17:43:25  meichel
 *  Implemented print job dispatcher code for dcmpstat, adapted dcmprtsv
 *    and dcmpsprt applications.
 *
 *  Revision 1.48  1999/09/13 15:19:08  meichel
 *  Added implementations for a number of further print API methods.
 *
 *  Revision 1.47  1999/09/10 12:46:44  meichel
 *  Added implementations for a number of print API methods.
 *
 *  Revision 1.46  1999/09/10 09:37:29  joergr
 *  Re-added automatically removed method declarations (maybe a problem with
 *  CVS's merge algorithm).
 *
 *  Revision 1.43  1999/09/08 17:03:01  joergr
 *  Added support for new instance types in database (grayscale hardcopy and
 *  stored print).
 *
 *  Revision 1.42  1999/09/08 16:42:01  meichel
 *  Moved configuration file evaluation to separate class.
 *
 *  Revision 1.41  1999/09/01 16:14:39  meichel
 *  Added support for requested image size to print routines
 *
 *  Revision 1.40  1999/08/31 16:54:44  meichel
 *  Added new sample application that allows to create simple print jobs.
 *
 *  Revision 1.39  1999/08/31 14:02:05  meichel
 *  Added print related config file methods
 *
 *  Revision 1.38  1999/08/27 15:57:55  meichel
 *  Added methods for saving hardcopy images and stored print objects
 *    either in file or in the local database.
 *
 *  Revision 1.37  1999/08/25 16:47:20  joergr
 *  Moved method 'saveFileFormat()' to public part of the interface class.
 *
 *  Revision 1.36  1999/05/05 14:25:26  joergr
 *  Added optional parameter to method loadPState (from database) to change
 *  instance reviewed flag for pstate and image.
 *
 *  Revision 1.35  1999/04/29 15:25:37  joergr
 *  Added PresentationLabel to index file.
 *
 *  Revision 1.34  1999/04/27 11:23:16  joergr
 *  Enhanced savePState() method: now image file is also added to index file
 *  and stored in image directory (if not already there).
 *  Added new entry to index file: Presentation Description.
 *
 *  Revision 1.33  1999/03/03 13:24:32  joergr
 *  Added methods to get and set ambient light value (re: Barten transformation).
 *  Moved method 'isBartenTransformPossible()' from presentation state class to
 *  interface class.
 *
 *  Revision 1.32  1999/03/02 12:52:51  joergr
 *  Added parameter to selectPState() specifying whether to change the review
 *  status of the loaded presentation state.
 *
 *  Revision 1.31  1999/02/25 18:38:58  joergr
 *  Added some comments.
 *  Renamed methods enable/disablePState().
 *
 *  Revision 1.30  1999/02/24 20:17:48  joergr
 *  Added methods to get a list of presentation states referencing the
 *  currently selected image.
 *  Added support for exchanging current presentation state (load from file)
 *  without deleting the current image.
 *
 *  Revision 1.29  1999/02/22 14:20:20  joergr
 *  Added deletion of image files (depending on directory where the file is
 *  stored).
 *  Modified comments for getGUIConfig... methods to indicate that the
 *  specified key must be upper case.
 *  Reset reference time for file modification checking after the index file
 *  has been changed internally (delete and change status methods).
 *
 *  Revision 1.28  1999/02/19 18:58:11  joergr
 *  Added methods to disable and (re-)enable PresentationStates.
 *  Added (private) helper methods to reduce redundant lines of code.
 *
 *  Revision 1.27  1999/02/19 09:44:17  joergr
 *  Added comments to new database routines and related member variables.
 *
 *  Revision 1.26  1999/02/18 18:46:19  joergr
 *  Re-implemented methods to access index file (delete methods are still
 *  missing).
 *  Removed parameter 'deletefile' from delete methods. This parameter is
 *  not necessary because the decision whether a images file is deleted only
 *  depends on the directory where the file is stored (see comments).
 *
 *  Revision 1.25  1999/02/18 11:07:26  meichel
 *  Added new parameter explicitVR to interface methods savePState,
 *    saveDICOMImage.  Allows to choose between explicit VR and implicit VR
 *    little endian format.  Added new method saveCurrentImage that allows to
 *    save the current image to file.
 *
 *  Revision 1.24  1999/02/17 10:05:30  meichel
 *  Moved creation of Display Function object from DVPresentationState to
 *    DVInterface to avoid unnecessary re-reads.
 *
 *  Revision 1.23  1999/02/16 16:36:10  meichel
 *  Added method newInstancesReceived() to DVInterface class.
 *
 *  Revision 1.22  1999/02/12 10:02:46  vorwerk
 *  added cache , changed deletemethods.
 *
 *  Revision 1.21  1999/02/09 15:58:07  meichel
 *  Implemented methods that save images and presentation states in the DB.
 *
 *  Revision 1.20  1999/02/08 10:52:33  meichel
 *  Updated documentation of dviface.h in Doc++ style.
 *    Removed dummy parameter from constructor.
 *
 *  Revision 1.19  1999/02/05 17:45:35  meichel
 *  Added config file entry for monitor characteristics file.  Monitor charac-
 *    teristics are passed to dcmimage if present to activate Barten transform.
 *
 *  Revision 1.18  1999/02/05 11:38:01  vorwerk
 *  parameter in stripidxarray added.
 *
 *  Revision 1.17  1999/01/29 16:01:05  meichel
 *  Reworked index file handle acquisition and locking code.
 *
 *  Revision 1.16  1999/01/28 15:30:53  vorwerk
 *  New database lock method added.
 *
 *  Revision 1.15  1999/01/27 15:28:34  vorwerk
 *  new method idxfiletest added to handle with indexfiles of length zero.
 *
 *  Revision 1.14  1999/01/27 14:59:28  meichel
 *  Implemented DICOM network receive application "dcmpsrcv" which receives
 *    images and presentation states and stores them in the local database.
 *
 *  Revision 1.13  1999/01/25 18:18:23  meichel
 *  Defined private SOP class UID for network receiver
 *    shutdown function. Cleanup up some code.
 *
 *  Revision 1.12  1999/01/25 16:55:17  vorwerk
 *  function stripidxarray added.
 *
 *  Revision 1.11  1999/01/25 13:05:55  meichel
 *  Implemented DVInterface::startReceiver()
 *    and several config file related methods.
 *
 *  Revision 1.10  1999/01/20 19:25:25  meichel
 *  Implemented sendIOD method which creates a separate process for trans-
 *    mitting images from the local database to a remote communication peer.
 *
 *  Revision 1.9  1999/01/19 15:14:48  vorwerk
 *  Methods for acesseing additional attributes added.
 *
 *  Revision 1.8  1999/01/15 17:27:14  meichel
 *  added DVInterface method resetPresentationState() which allows to reset a
 *    presentation state to the initial state (after loading).
 *
 *  Revision 1.7  1999/01/14 17:50:30  meichel
 *  added new method saveDICOMImage() to class DVInterface.
 *    Allows to store a bitmap as a DICOM image.
 *
 *  Revision 1.6  1999/01/04 13:27:16  vorwerk
 *  line inserted
 *
 *  Revision 1.5  1999/01/04 13:02:26  vorwerk
 *  getSeriesPerformingPhysicainsName() changed in getSeriesPerformingPhysiciansName()
 *
 *  Revision 1.4  1998/12/22 17:57:03  meichel
 *  Implemented Presentation State interface for overlays,
 *    VOI LUTs, VOI windows, curves. Added test program that
 *    allows to add curve data to DICOM images.
 *
 *  Revision 1.3  1998/12/22 15:50:06  vorwerk
 *  - constructor now with parameter for directory of index.dat
 *  - changed const methods in non-const-methods
 *  - added methods for attributes of DICOM-documents
 *  - added private method for operations on index.dat
 *
 *  Revision 1.2  1998/11/30 11:26:59  joergr
 *  Added CVS/RCS log at end of file.
 *
 *
 */

---

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