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
DVPSFilmSession Class Reference

a basic film session object managed by a Print SCP. More...

Public Member Functions

 DVPSFilmSession (Uint16 illumin, Uint16 reflection)
 constructor More...
 
 DVPSFilmSession (const DVPSFilmSession &copy)
 copy constructor
 
DVPSFilmSessionclone ()
 clone method. More...
 
virtual ~DVPSFilmSession ()
 destructor
 
OFBool printSCPCreate (DVConfiguration &cfg, const char *cfgname, DcmDataset *rqDataset, T_DIMSE_Message &rsp, DcmDataset *&rspDataset, const char *peerae, OFBool presentationLUTnegotiated, DVPSPresentationLUT_PList &globalPresentationLUTList)
 performs a Print SCP Basic Film Session N-CREATE operation on a newly created instance of this class. More...
 
OFBool printSCPSet (DVConfiguration &cfg, const char *cfgname, DcmDataset *rqDataset, T_DIMSE_Message &rsp, DcmDataset *&rspDataset, OFBool presentationLUTnegotiated, DVPSPresentationLUT_PList &globalPresentationLUTList, DVPSStoredPrint_PList &basicFilmBoxList)
 performs a Print SCP Basic Film Session N-SET operation on an instance of this class. More...
 
OFBool isInstance (const char *uid)
 compares the SOP instance UID with the given UID string. More...
 
const char * getUID ()
 returns the SOP instance UID of the basic film session. More...
 
void copyPresentationLUTSettings (DVPSStoredPrint &sp)
 copies the film box Presentation LUT settings into the stored print object passed by reference. More...
 

Private Member Functions

DVPSFilmSessionoperator= (const DVPSFilmSession &)
 private undefined assignment operator
 
OFCondition addPresentationLUTReference (DcmItem &dset)
 writes a Referenced Presentation LUT SQ, Illumination and reflected ambient light to the given dataset. More...
 

Private Attributes

OFString sopInstanceUID
 SOP instance UID of basic film session object.
 
DcmIntegerString numberOfCopies
 VR=IS, VM=1.
 
DcmCodeString printPriority
 VR=CS, VM=1.
 
DcmCodeString mediumType
 VR=CS, VM=1.
 
DcmCodeString filmDestination
 VR=CS, VM=1.
 
DcmLongString filmSessionLabel
 VR=LO, VM=1.
 
DcmShortString ownerID
 VR=SH, VM=1.
 
DcmUnsignedShort illumination
 VR=US, VM=1, Type 2c required if presentation SOP class present.
 
DcmUnsignedShort reflectedAmbientLight
 VR=US, VM=1, Type 2c required if presentation SOP class present.
 
DcmUniqueIdentifier referencedPresentationLUTInstanceUID
 the ReferencedPresentationLUTSequence is only created/read on the fly
 
DVPSPrintPresentationLUTAlignment referencedPresentationLUTAlignment
 The Print SCP can be configured to enforce a rule requiring that the number of entries in a Presentation LUT matches the bit depth of the image pixel data. More...
 

Detailed Description

a basic film session object managed by a Print SCP.

Constructor & Destructor Documentation

DVPSFilmSession::DVPSFilmSession ( Uint16  illumin,
Uint16  reflection 
)

constructor

Parameters
illumindefault Illumination setting
reflectiondefault Reflected Ambient Light setting

Member Function Documentation

OFCondition DVPSFilmSession::addPresentationLUTReference ( DcmItem dset)
private

writes a Referenced Presentation LUT SQ, Illumination and reflected ambient light to the given dataset.

Helper function used when creating Basic Film Session or Basic Film Box.

Parameters
dsetthe dataset to which the data is written
Returns
EC_Normal if successful, an error code otherwise.
DVPSFilmSession* DVPSFilmSession::clone ( )
inline

clone method.

Returns
a pointer to a new DVPSFilmSession object containing a copy of this object.
void DVPSFilmSession::copyPresentationLUTSettings ( DVPSStoredPrint sp)

copies the film box Presentation LUT settings into the stored print object passed by reference.

Parameters
spstored print object
const char* DVPSFilmSession::getUID ( )
inline

returns the SOP instance UID of the basic film session.

Returns
SOP instance UID
OFBool DVPSFilmSession::isInstance ( const char *  uid)

compares the SOP instance UID with the given UID string.

Returns
OFTrue if UIDs are equal, OFFalse otherwise.
OFBool DVPSFilmSession::printSCPCreate ( DVConfiguration cfg,
const char *  cfgname,
DcmDataset rqDataset,
T_DIMSE_Message rsp,
DcmDataset *&  rspDataset,
const char *  peerae,
OFBool  presentationLUTnegotiated,
DVPSPresentationLUT_PList globalPresentationLUTList 
)

performs a Print SCP Basic Film Session N-CREATE operation on a newly created instance of this class.

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

Parameters
cfgconfig file facility
cfgnamesymbolic printer name in config file
rqDatasetN-CREATE request dataset, may be NULL
rspN-CREATE response message
rspDatasetN-CREATE response dataset passed back in this parameter
peeraeapplication entity title of the print SCU we're communicating with. Used to create default values for ownerID and filmSessionLabel.
presentationLUTnegotiatedOFTrue if support for the Presentation LUT SOP class has been negotiated at association negotiation and is supported on Basic Film Session level
globalPresentationLUTListlist of presentation LUTs managed by the Print SCP
Returns
OFTrue if N-CREATE was successful, OFFalse otherwise.
OFBool DVPSFilmSession::printSCPSet ( DVConfiguration cfg,
const char *  cfgname,
DcmDataset rqDataset,
T_DIMSE_Message rsp,
DcmDataset *&  rspDataset,
OFBool  presentationLUTnegotiated,
DVPSPresentationLUT_PList globalPresentationLUTList,
DVPSStoredPrint_PList basicFilmBoxList 
)

performs a Print SCP Basic Film Session N-SET operation on an instance of this class.

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
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 and is supported on Basic Film Session level
globalPresentationLUTListlist of presentation LUTs managed by the Print SCP
basicFilmBoxListlist of basic film boxes. Presentation LUT settings are copied to all film boxes.
Returns
OFTrue if N-SET was successful, OFFalse otherwise.

Member Data Documentation

DVPSPrintPresentationLUTAlignment DVPSFilmSession::referencedPresentationLUTAlignment
private

The Print SCP can be configured to enforce a rule requiring that the number of entries in a Presentation LUT matches the bit depth of the image pixel data.

This member variable describes the type of the current presentation LUT (if any).


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