DCMTK  Version 3.6.1 20170228
OFFIS DICOM Toolkit
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | Private Member Functions | Private Attributes | List of all members
DVPSStoredPrint_PList Class Reference

a list of stored print objects, each of which manages a single Basic Film Box in a Print SCP. More...

Public Member Functions

 DVPSStoredPrint_PList ()
 default constructor
 
 DVPSStoredPrint_PList (const DVPSStoredPrint_PList &copy)
 copy constructor
 
DVPSStoredPrint_PListclone ()
 clone method. More...
 
virtual ~DVPSStoredPrint_PList ()
 destructor
 
void clear ()
 reset the object to initial state. More...
 
size_t size () const
 get number of stored print objects in this list. More...
 
void insert (DVPSStoredPrint *newSP)
 adds a Stored Print object to the list of managed objects. More...
 
void printSCPBasicFilmBoxSet (DVConfiguration &cfg, const char *cfgname, T_DIMSE_Message &rq, DcmDataset *rqDataset, T_DIMSE_Message &rsp, DcmDataset *&rspDataset, OFBool presentationLUTnegotiated, DVPSPresentationLUT_PList &globalPresentationLUTList)
 performs a Print SCP Basic Film Box N-SET operation. More...
 
void printSCPBasicGrayscaleImageBoxSet (DVInterface &cfg, const char *cfgname, T_DIMSE_Message &rq, DcmDataset *rqDataset, T_DIMSE_Message &rsp, DcmDataset *&rspDataset, OFBool presentationLUTnegotiated)
 performs a Print SCP Basic Grayscale Image Box N-SET operation. More...
 
void printSCPBasicFilmBoxAction (DVInterface &cfg, const char *cfgname, T_DIMSE_Message &rq, T_DIMSE_Message &rsp, DVPSPresentationLUT_PList &globalPresentationLUTList)
 performs a Print SCP Basic Film Box N-ACTION operation. More...
 
void printSCPBasicFilmSessionAction (DVInterface &cfg, const char *cfgname, T_DIMSE_Message &rsp, DVPSPresentationLUT_PList &globalPresentationLUTList)
 performs a Print SCP Basic Film Session N-ACTION operation. More...
 
void printSCPBasicFilmBoxDelete (T_DIMSE_Message &rq, T_DIMSE_Message &rsp)
 performs a Print SCP basic film box N-DELETE operation. More...
 
OFBool haveFilmBoxInstance (const char *uid)
 checks whether a film box object with the given SOP instance UID already exists. More...
 
OFBool usesPresentationLUT (const char *uid)
 checks whether the Presentation LUT with the given UID is referenced by any Stored Print object in this list on the film box level. More...
 
OFBool matchesPresentationLUT (DVPSPrintPresentationLUTAlignment align) const
 checks whether the given Presentation LUT type could be used together with all image boxes in all film boxes on a Print SCP that requires a matching alignment between a Presentation LUT and the image pixel data. More...
 
void overridePresentationLUTSettings (DcmUnsignedShort &newIllumination, DcmUnsignedShort &newReflectedAmbientLight, DcmUniqueIdentifier &newReferencedPLUT, DVPSPrintPresentationLUTAlignment newAlignment)
 replaces the settings for illumination, reflected ambient light and referenced Presentation LUT in all film boxes in this list. More...
 

Private Member Functions

DVPSStoredPrint_PListoperator= (const DVPSStoredPrint_PList &)
 private undefined assignment operator
 

Private Attributes

OFList< DVPSStoredPrint * > list_
 the list maintained by this object
 

Detailed Description

a list of stored print objects, each of which manages a single Basic Film Box in a Print SCP.

Member Function Documentation

void DVPSStoredPrint_PList::clear ( )

reset the object to initial state.

After this call, the object is in the same state as after creation with the default constructor.

DVPSStoredPrint_PList* DVPSStoredPrint_PList::clone ( )
inline

clone method.

Returns
a pointer to a new DVPSStoredPrint_PList object containing a deep copy of this object.
OFBool DVPSStoredPrint_PList::haveFilmBoxInstance ( const char *  uid)

checks whether a film box object with the given SOP instance UID already exists.

Parameters
uiduid to be checked
Returns
OFTrue if found, OFFalse otherwise
void DVPSStoredPrint_PList::insert ( DVPSStoredPrint newSP)
inline

adds a Stored Print object to the list of managed objects.

The stored print object becomes owned by this object and is destroyed upon destruction of the list.

Parameters
newSPStored Print object to be added.
OFBool DVPSStoredPrint_PList::matchesPresentationLUT ( DVPSPrintPresentationLUTAlignment  align) const

checks whether the given Presentation LUT type could be used together with all image boxes in all film boxes on a Print SCP that requires a matching alignment between a Presentation LUT and the image pixel data.

Parameters
alignLUT alignment type
Returns
OFTrue if matching, OFFalse otherwise
void DVPSStoredPrint_PList::overridePresentationLUTSettings ( DcmUnsignedShort newIllumination,
DcmUnsignedShort newReflectedAmbientLight,
DcmUniqueIdentifier newReferencedPLUT,
DVPSPrintPresentationLUTAlignment  newAlignment 
)

replaces the settings for illumination, reflected ambient light and referenced Presentation LUT in all film boxes in this list.

Used by a Print SCP if Presentation LUT is implemented on Film Session level.

Parameters
newIlluminationnew value for illumination
newReflectedAmbientLightnew value for reflectedAmbientLight
newReferencedPLUTnew value for referenced presentation LUT instance UID
newAlignmentnew alignment type of active presentation LUT
void DVPSStoredPrint_PList::printSCPBasicFilmBoxAction ( DVInterface cfg,
const char *  cfgname,
T_DIMSE_Message rq,
T_DIMSE_Message rsp,
DVPSPresentationLUT_PList globalPresentationLUTList 
)

performs a Print SCP Basic Film Box N-ACTION operation.

The results of the N-ACTION operation are stored in the object passed as rsp. If successful, a Stored Print object containing the film box hierarchy is created in the database.

Parameters
cfgconfig file facility
cfgnamesymbolic printer name in config file
rqN-ACTION request message
rspN-ACTION response message
globalPresentationLUTListlist of presentation LUTs managed by the Print SCP
void DVPSStoredPrint_PList::printSCPBasicFilmBoxDelete ( T_DIMSE_Message rq,
T_DIMSE_Message rsp 
)

performs a Print SCP basic film box N-DELETE operation.

The results of the N-DELETE operation are stored in the object passed as rsp.

Parameters
rqN-DELETE request message
rspN-DELETE response message
void DVPSStoredPrint_PList::printSCPBasicFilmBoxSet ( DVConfiguration cfg,
const char *  cfgname,
T_DIMSE_Message rq,
DcmDataset rqDataset,
T_DIMSE_Message rsp,
DcmDataset *&  rspDataset,
OFBool  presentationLUTnegotiated,
DVPSPresentationLUT_PList globalPresentationLUTList 
)

performs a Print SCP Basic Film Box N-SET operation.

The results of the N-SET operation are stored in the objects passed as rsp and rspDataset.

Parameters
cfgconfig file facility
cfgnamesymbolic printer name in config file
rqN-SET request message
rqDatasetN-SET request dataset
rspN-SET response message
rspDatasetN-SET response dataset passed back in this parameter
presentationLUTnegotiatedOFTrue if support for the Presentation LUT SOP class has been negotiated at association negotiation
globalPresentationLUTListlist of presentation LUTs managed by the Print SCP
void DVPSStoredPrint_PList::printSCPBasicFilmSessionAction ( DVInterface cfg,
const char *  cfgname,
T_DIMSE_Message rsp,
DVPSPresentationLUT_PList globalPresentationLUTList 
)

performs a Print SCP Basic Film Session N-ACTION operation.

The results of the N-ACTION operation are stored in the object passed as rsp. If successful, one Stored Print object for each film box in the film session is created in the database.

Parameters
cfgconfig file facility
cfgnamesymbolic printer name in config file
rspN-ACTION response message
globalPresentationLUTListlist of presentation LUTs managed by the Print SCP
void DVPSStoredPrint_PList::printSCPBasicGrayscaleImageBoxSet ( DVInterface cfg,
const char *  cfgname,
T_DIMSE_Message rq,
DcmDataset rqDataset,
T_DIMSE_Message rsp,
DcmDataset *&  rspDataset,
OFBool  presentationLUTnegotiated 
)

performs a Print SCP Basic Grayscale Image Box N-SET operation.

The results of the N-SET operation are stored in the objects passed as rsp and rspDataset. If successful, a Hardcopy Grayscale Image object containing the image data of the N-SET request is created in the database.

Parameters
cfgconfig file facility
cfgnamesymbolic printer name in config file
rqN-SET request message
rqDatasetN-SET request dataset
rspN-SET response message
rspDatasetN-SET response dataset passed back in this parameter
presentationLUTnegotiatedOFTrue if support for the Presentation LUT SOP class has been negotiated at association negotiation
size_t DVPSStoredPrint_PList::size ( ) const
inline

get number of stored print objects in this list.

Returns
the number of stored print objects.
OFBool DVPSStoredPrint_PList::usesPresentationLUT ( const char *  uid)

checks whether the Presentation LUT with the given UID is referenced by any Stored Print object in this list on the film box level.

Parameters
uiduid to be compared
Returns
OFTrue if equal, OFFalse otherwise

The documentation for this class was generated from the following file:


Generated on Tue Feb 28 2017 for DCMTK Version 3.6.1 20170228 by Doxygen 1.8.8