dvpsibl.h

/*
 *
 *  Copyright (C) 1998-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: dcmpstat
 *
 *  Author: Marco Eichelberg
 *
 *  Purpose:
 *    classes: DVPSImageBoxContent_PList
 *
 *  Last Update:      $Author: meichel $
 *  Update Date:      $Date: 2005/12/08 16:03:51 $
 *  CVS/RCS Revision: $Revision: 1.23 $
 *  Status:           $State: Exp $
 *
 *  CVS/RCS Log at end of file
 *
 */

#ifndef __DVPSIBL_H__
#define __DVPSIBL_H__

#include "dcmtk/config/osconfig.h"    /* make sure OS specific configuration is included first */
#include "dcmtk/ofstd/oflist.h"
#include "dcmtk/dcmdata/dctk.h"
#include "dcmtk/dcmpstat/dvpstyp.h"     /* for enum types */

class DVPSImageBoxContent;
class DVPSPresentationLUT_PList;

class DVPSImageBoxContent_PList
{
public:

  DVPSImageBoxContent_PList();
  
  DVPSImageBoxContent_PList(const DVPSImageBoxContent_PList& copy);

  DVPSImageBoxContent_PList *clone() { return new DVPSImageBoxContent_PList(*this); }

  virtual ~DVPSImageBoxContent_PList();

  OFCondition read(DcmItem &dset, DVPSPresentationLUT_PList& presentationLUTList);
  
  OFCondition write(
    DcmItem &dset,
    OFBool writeRequestedImageSize,
    size_t numItems,
    OFBool ignoreEmptyImages,
    OFBool writeReferencedPLUTSQ = OFTrue);

  void clear();

  size_t size() const { return list_.size(); }

  OFCondition createDefaultValues(OFBool renumber, OFBool ignoreEmptyImages);
  
  OFCondition addImageSOPClasses(DcmSequenceOfItems& seq, size_t numItems=0);
  
  OFCondition addImageBox(
    const char *instanceuid,
    const char *retrieveaetitle,
    const char *refstudyuid,
    const char *refseriesuid,
    const char *refsopclassuid,
    const char *refsopinstanceuid,
    const char *requestedimagesize,
    const char *patientid,
    const char *presentationlutuid);

  OFCondition addImageBox(DVPSImageBoxContent *box);
  
  OFCondition setRequestedDecimateCropBehaviour(DVPSDecimateCropBehaviour value); 

  OFCondition deleteImage(size_t idx);
  
  OFCondition deleteMultipleImages(size_t number);

  OFBool imageHasAdditionalSettings(size_t idx);

  OFCondition setImagePolarity(size_t idx, const char *value);
  
  OFCondition setImageRequestedSize(size_t idx, const char *value);
  
  OFCondition setImageMagnificationType(size_t idx, const char *value);
  
  OFCondition setImageSmoothingType(size_t idx, const char *value);
  
  OFCondition setImageConfigurationInformation(size_t idx, const char *value);

  OFCondition setImageSOPInstanceUID(size_t idx, const char *value);

  OFCondition setAllImagesToDefault();

  const char *getImagePolarity(size_t idx);

  const char *getImageRequestedSize(size_t idx);

  const char *getImageMagnificationType(size_t idx);

  const char *getImageSmoothingType(size_t idx);

  const char *getImageConfigurationInformation(size_t idx);

  const char *getSOPInstanceUID(size_t idx);

  const char *getReferencedPresentationLUTInstanceUID(size_t idx);

  OFCondition getImageReference(size_t idx, const char *&studyUID, const char *&seriesUID, const char *&instanceUID);

  OFCondition prepareBasicImageBox(size_t idx, DcmItem &dset);

  void setLog(OFConsole *stream, OFBool verbMode, OFBool dbgMode);

  OFBool presentationLUTInstanceUIDisUsed(const char *uid);

  const char *haveSinglePresentationLUTUsed(const char *filmBox);

  OFBool printSCPCreate(
    unsigned long numBoxes,
    DcmUniqueIdentifier& studyUID, 
    DcmUniqueIdentifier& seriesUID, 
    const char *aetitle);

  OFCondition writeReferencedImageBoxSQ(DcmItem &dset);

  OFBool matchesPresentationLUT(DVPSPrintPresentationLUTAlignment align) const;

  DVPSImageBoxContent *duplicateImageBox(const char *uid);

  OFBool haveImagePositionClash(const char *uid, Uint16 position);

  void replace(DVPSImageBoxContent *newImageBox);

  OFBool emptyPageWarning();
  
private:

  DVPSImageBoxContent_PList& operator=(const DVPSImageBoxContent_PList&);
  
  DVPSImageBoxContent *getImageBox(size_t idx); 

  OFList<DVPSImageBoxContent *> list_;

  OFConsole *logstream;

  OFBool verboseMode;
   
  OFBool debugMode;
  
};


#endif

/*
 *  $Log: dvpsibl.h,v $
 *  Revision 1.23  2005/12/08 16:03:51  meichel
 *  Changed include path schema for all DCMTK header files
 *
 *  Revision 1.22  2003/06/04 10:18:06  meichel
 *  Replaced private inheritance from template with aggregation
 *
 *  Revision 1.21  2001/09/26 15:36:13  meichel
 *  Adapted dcmpstat to class OFCondition
 *
 *  Revision 1.20  2001/06/01 15:50:18  meichel
 *  Updated copyright header
 *
 *  Revision 1.19  2000/07/04 15:58:02  joergr
 *  Added support for overriding the presentation LUT settings made for the
 *  image boxes.
 *
 *  Revision 1.18  2000/06/14 11:28:14  joergr
 *  Added methods to access the attributes Polarity and Requested Image Size.
 *
 *  Revision 1.17  2000/06/08 10:44:29  meichel
 *  Implemented Referenced Presentation LUT Sequence on Basic Film Session level.
 *    Empty film boxes (pages) are not written to file anymore.
 *
 *  Revision 1.16  2000/06/07 14:17:41  joergr
 *  Added methods to access the image polarity attribute.
 *
 *  Revision 1.15  2000/06/02 16:00:48  meichel
 *  Adapted all dcmpstat classes to use OFConsole for log and error output
 *
 *  Revision 1.14  2000/05/31 12:56:39  meichel
 *  Added initial Print SCP support
 *
 *  Revision 1.13  2000/03/08 16:28:53  meichel
 *  Updated copyright header.
 *
 *  Revision 1.12  1999/10/19 14:46:03  meichel
 *  added support for the Basic Annotation Box SOP Class
 *    as well as access methods for Max Density and Min Density.
 *
 *  Revision 1.11  1999/10/07 17:21:48  meichel
 *  Reworked management of Presentation LUTs in order to create tighter
 *    coupling between Softcopy and Print.
 *
 *  Revision 1.10  1999/09/24 15:23:45  meichel
 *  Print spooler (dcmprtsv) now logs diagnostic messages in log files
 *    when operating in spool mode.
 *
 *  Revision 1.9  1999/09/17 14:33:57  meichel
 *  Completed print spool functionality including Supplement 22 support
 *
 *  Revision 1.8  1999/09/15 17:43:28  meichel
 *  Implemented print job dispatcher code for dcmpstat, adapted dcmprtsv
 *    and dcmpsprt applications.
 *
 *  Revision 1.7  1999/09/10 12:46:47  meichel
 *  Added implementations for a number of print API methods.
 *
 *  Revision 1.6  1999/09/09 14:57:33  thiel
 *  Added methods for print spooler
 *
 *  Revision 1.5  1999/09/01 16:14:40  meichel
 *  Added support for requested image size to print routines
 *
 *  Revision 1.4  1999/08/31 14:09:11  meichel
 *  Added get/set methods for stored print attributes
 *
 *  Revision 1.3  1999/08/27 15:57:56  meichel
 *  Added methods for saving hardcopy images and stored print objects
 *    either in file or in the local database.
 *
 *  Revision 1.2  1999/08/26 09:30:59  thiel
 *  Add extensions for the usage of the StoredPrint
 *
 *  Revision 1.1  1999/07/30 13:34:48  meichel
 *  Added new classes managing Stored Print objects
 *
 *
 */

---

Generated on 20 Dec 2005 for OFFIS DCMTK Version 3.5.4 by Doxygen 1.4.5