DVPSFilmSession Class Reference

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

List of all members.

Public Member Functions

 DVPSFilmSession (Uint16 illumin, Uint16 reflection)
 constructor
 DVPSFilmSession (const DVPSFilmSession &copy)
 copy constructor
DVPSFilmSession * clone ()
 clone method.
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.
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.
OFBool isInstance (const char *uid)
 compares the SOP instance UID with the given UID string.
const char * getUID ()
 returns the SOP instance UID of the basic film session.
void setLog (OFConsole *stream, OFBool verbMode, OFBool dbgMode)
 sets a new log stream
void copyPresentationLUTSettings (DVPSStoredPrint &sp)
 copies the film box Presentation LUT settings into the stored print object passed by reference.

Private Member Functions

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

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.
OFConsole * logstream
 output stream for error messages, never NULL
OFBool verboseMode
 flag indicating whether we're operating in verbose mode
OFBool debugMode
 flag indicating whether we're operating in debug mode

Detailed Description

a basic film session object managed by a Print SCP.

Definition at line 49 of file dvpsfs.h.

Constructor & Destructor Documentation

DVPSFilmSession::DVPSFilmSession (  Uint16  illumin,
Uint16  reflection
) 
 

constructor

Parameters:
illumin default Illumination setting
reflection default Reflected Ambient Light setting

Referenced by clone().

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:
dset the 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.

Definition at line 66 of file dvpsfs.h.

References DVPSFilmSession().

void DVPSFilmSession::copyPresentationLUTSettings (  DVPSStoredPrint &  sp  ) 
 

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

Parameters:
sp stored print object

const char* DVPSFilmSession::getUID (   )  [inline]
 

returns the SOP instance UID of the basic film session.

Returns:
SOP instance UID

Definition at line 136 of file dvpsfs.h.

References OFString::c_str(), and sopInstanceUID.

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:
cfg config file facility
cfgname symbolic printer name in config file
rqDataset N-CREATE request dataset, may be NULL
rsp N-CREATE response message
rspDataset N-CREATE response dataset passed back in this parameter
peerae application entity title of the print SCU we're communicating with. Used to create default values for ownerID and filmSessionLabel.
presentationLUTnegotiated OFTrue if support for the Presentation LUT SOP class has been negotiated at association negotiation and is supported on Basic Film Session level
globalPresentationLUTList list 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:
cfg config file facility
cfgname symbolic printer name in config file
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 and is supported on Basic Film Session level
globalPresentationLUTList list of presentation LUTs managed by the Print SCP
basicFilmBoxList list of basic film boxes. Presentation LUT settings are copied to all film boxes.
Returns:
OFTrue if N-SET was successful, OFFalse otherwise.

void DVPSFilmSession::setLog (  OFConsole *  stream,
OFBool  verbMode,
OFBool  dbgMode
) 
 

sets a new log stream

Parameters:
stream new log stream, NULL for default logstream
verbMode verbose mode flag
dbgMode debug mode flag

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).

Definition at line 192 of file dvpsfs.h.

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

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