DVPSStoredPrint_PList Class Reference

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

List of all members.

Public Member Functions

 DVPSStoredPrint_PList ()
 default constructor
 DVPSStoredPrint_PList (const DVPSStoredPrint_PList &copy)
 copy constructor
DVPSStoredPrint_PList * clone ()
 clone method.
virtual ~DVPSStoredPrint_PList ()
 destructor
void clear ()
 reset the object to initial state.
size_t size () const
 get number of stored print objects in this list.
void insert (DVPSStoredPrint *newSP)
 adds a Stored Print object to the list of managed objects.
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.
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.
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.
void printSCPBasicFilmSessionAction (DVInterface &cfg, const char *cfgname, T_DIMSE_Message &rsp, DVPSPresentationLUT_PList &globalPresentationLUTList)
 performs a Print SCP Basic Film Session N-ACTION operation.
void printSCPBasicFilmBoxDelete (T_DIMSE_Message &rq, T_DIMSE_Message &rsp)
 performs a Print SCP basic film box N-DELETE operation.
OFBool haveFilmBoxInstance (const char *uid)
 checks whether a film box object with the given SOP instance UID already exists.
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.
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.
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.

Private Member Functions

DVPSStoredPrint_PList & operator= (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.

Definition at line 48 of file dvpsspl.h.

Member Function Documentation

DVPSStoredPrint_PList* DVPSStoredPrint_PList::clone (  )  [inline]

clone method.

Returns:
a pointer to a new DVPSStoredPrint_PList object containing a deep copy of this object.

Definition at line 61 of file dvpsspl.h.

References DVPSStoredPrint_PList().

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.

size_t DVPSStoredPrint_PList::size (  )  const [inline]

get number of stored print objects in this list.

Returns:
the number of stored print objects.

Definition at line 75 of file dvpsspl.h.

References list_, and OFList< T >::size().

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:
newSP Stored Print object to be added.

Definition at line 82 of file dvpsspl.h.

References list_, and OFList< T >::push_back().

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:
cfg config file facility
cfgname symbolic printer name in config file
rq N-SET request message
rqDataset N-SET request dataset
rsp N-SET response message
rspDataset N-SET response dataset passed back in this parameter
presentationLUTnegotiated OFTrue if support for the Presentation LUT SOP class has been negotiated at association negotiation
globalPresentationLUTList list 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:
cfg config file facility
cfgname symbolic printer name in config file
rq N-SET request message
rqDataset N-SET request dataset
rsp N-SET response message
rspDataset N-SET response dataset passed back in this parameter
presentationLUTnegotiated OFTrue if support for the Presentation LUT SOP class has been negotiated at association negotiation

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:
cfg config file facility
cfgname symbolic printer name in config file
rq N-ACTION request message
rsp N-ACTION response message
globalPresentationLUTList list 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:
cfg config file facility
cfgname symbolic printer name in config file
rsp N-ACTION response message
globalPresentationLUTList list 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:
rq N-DELETE request message
rsp N-DELETE response message

OFBool DVPSStoredPrint_PList::haveFilmBoxInstance ( const char *  uid  ) 

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

Parameters:
uid uid to be checked
Returns:
OFTrue if found, OFFalse otherwise

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:
uid uid to be compared
Returns:
OFTrue if equal, OFFalse otherwise

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:
align LUT 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:
newIllumination new value for illumination
newReflectedAmbientLight new value for reflectedAmbientLight
newReferencedPLUT new value for referenced presentation LUT instance UID
newAlignment new alignment type of active presentation LUT

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

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