📄 dvpsib.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 * * Last Update: $Author: meichel $ * Update Date: $Date: 2005/12/08 16:03:50 $ * CVS/RCS Revision: $Revision: 1.21 $ * Status: $State: Exp $ * * CVS/RCS Log at end of file * */#ifndef __DVPSIB_H__#define __DVPSIB_H__#include "dcmtk/config/osconfig.h" /* make sure OS specific configuration is included first */#include "dcmtk/ofstd/ofstring.h"#include "dcmtk/dcmdata/dctk.h"#include "dcmtk/dcmpstat/dvpstyp.h" /* for enum types */#include "dcmtk/dcmnet/dimse.h"class DVPSPresentationLUT_PList;class DVConfiguration;/** the representation of a Image Box Content SQ item for Stored Print */ class DVPSImageBoxContent{public: /// default constructor DVPSImageBoxContent(); /// copy constructor DVPSImageBoxContent(const DVPSImageBoxContent& copy); /** clone method. * @return a pointer to a new DVPSImageBoxContent object containing * a copy of this object. */ DVPSImageBoxContent *clone() { return new DVPSImageBoxContent(*this); } /// destructor virtual ~DVPSImageBoxContent(); /** resets the object to initial state. * After this call, the object is in the same state as after * creation with the default constructor. */ void clear(); /** reads an image box content item from a DICOM dataset. * The DICOM elements of the referenced item are copied * from the dataset to this object. * The completeness of the item (presence of all required elements, * value multiplicity) is checked. * If this method returns an error code, the object is in undefined state afterwards. * @param dset the item of the ImageBoxContentSequence from which the data is to be read * @param presentationLUTList list of presentation LUTs which may be referenced * @return EC_Normal if successful, an error code otherwise. */ OFCondition read(DcmItem &dset, DVPSPresentationLUT_PList& presentationLUTList); /** writes the image box managed by this object to a DICOM dataset. * Copies of the DICOM element managed by this object are inserted into * the DICOM dataset. * @param dset the the item of the ImageBoxContentSequence to which the data is written * @param writeRequestedImageSize if false, the Requested Image Size attribute is not written, * e.g. because it is not supported by the target printer. * @param writeReferencedPLUTSQ if false, the Referenced Presentation LUT Sequence is not written, * e.g. because a "general" presentation LUT is used instead of those referenced by the image boxes. * @return EC_Normal if successful, an error code otherwise. */ OFCondition write(DcmItem &dset, OFBool writeRequestedImageSize, OFBool writeReferencedPLUTSQ = OFTrue); /** create default values for all missing type 1 elements. * Called before a stored print object is written. * @param renumber if true, a new imageBoxPosition values is created * @param number new imageBoxPosition to be assigned * @param ignoreEmptyImages if true, an empty image box position does not cause an error. * @return EC_Normal if successful, an error code otherwise. */ OFCondition createDefaultValues(OFBool renumber, unsigned long number, OFBool ignoreEmptyImages); /** returns the referencedSOPClassUID from the ReferencedImageSequence * @return referencedSOPClassUID string */ const char *getSOPClassUID(); /** sets the content of this image box object. * @param instanceuid SOP instance UID of this image box * @param retrieveaetitle retrieve AETITLE of the referenced image * @param refstudyuid study instance UID of the referenced image * @param refseriesuid series instance UID of the referenced image * @param refsopclassuid SOP class UID of the referenced image * @param refsopinstanceuid SOP instance UID of the referenced image * @param requestedimagesize requested images size for this image * @param patientid patient ID for the referenced image * @param presentationlutreference referenced SOP instance UID for the referenced Presentation LUT, * @return EC_Normal if successful, an error code otherwise. */ OFCondition setContent( 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 *presentationlutreference); /** sets the (optional) requested decimate/crop behaviour for this image box. * @param value new enumerated value. The caller is responsible for * making sure that the selected printer supports decimate/crop * if a non-default value is set. * @return EC_Normal if successful, an error code otherwise. */ OFCondition setRequestedDecimateCropBehaviour(DVPSDecimateCropBehaviour value); /** gets the current requested decimate/crop behaviour setting * that is used for this image box. * @return requested decimate/crop behaviour */ DVPSDecimateCropBehaviour getRequestedDecimateCropBehaviour(); /** checks whether image box has additional settings * that are not default. * @return OFTrue if additional settings exist, OFFalse otherwise. */ OFBool hasAdditionalSettings(); /** gets the (optional) referenced Presentation LUT Instance UID. * @return UID, may be NULL. */ const char *getReferencedPresentationLUTInstanceUID(); /** gets the polarity. * @return polarity, may be NULL. */ const char *getPolarity(); /** gets the requested image size. * @return requested image size, may be NULL. */ const char *getRequestedImageSize(); /** gets the (optional) magnification type. * @return magnification type, may be NULL. */ const char *getMagnificationType(); /** gets the (optional) smoothing type. * @return smoothing type, may be NULL. */ const char *getSmoothingType(); /** gets the (optional) configuration information. * @return configuration information, may be NULL. */ const char *getConfigurationInformation(); /** gets the current SOP Instance UID. * @return SOP Instance UID, may be NULL. */ const char *getSOPInstanceUID(); /** gets the current image box position, 0 if none is set. * @return image box position */ Uint16 getImageBoxPosition(); /** sets the polarity. * @param value new attribute value (NORMAL or REVERSE), may be NULL. * @return EC_Normal if successful, an error code otherwise. */ OFCondition setPolarity(const char *value); /** sets the requested image size. * @param value new attribute value, may be NULL. * @return EC_Normal if successful, an error code otherwise. */ OFCondition setRequestedImageSize(const char *value); /** sets the (optional) magnification type. * @param value new attribute value, may be NULL. * The caller is responsible for making sure * that the value is valid for the selected printer. * @return EC_Normal if successful, an error code otherwise. */ OFCondition setMagnificationType(const char *value); /** sets the (optional) smoothing type. * @param value new attribute value, may be NULL. * The caller is responsible for making sure * that the value is valid for the selected printer. * @return EC_Normal if successful, an error code otherwise. */ OFCondition setSmoothingType(const char *value); /** sets the (optional) configuration information. * @param value new attribute value, may be NULL. * The caller is responsible for making sure * that the value is valid for the selected printer. * @return EC_Normal if successful, an error code otherwise. */ OFCondition setConfigurationInformation(const char *value); /** sets the SOP instance UID (which is returned by the Print SCP). * @param value new attribute value, must not be NULL. * @return EC_Normal if successful, an error code otherwise. */ OFCondition setSOPInstanceUID(const char *value); /** sets magnification type, smoothing type and configuration information back to default. * @return EC_Normal if successful, an error code otherwise. */ OFCondition setDefault(); /** returns the image UIDs that are required to look up the referenced image in the database * @param studyUID Study UID of the image * @param seriesUID series UID of the image * @param instanceUID instance UID of the image
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -