DCMTK  Version 3.6.3
OFFIS DICOM Toolkit
Public Member Functions | Private Member Functions | Private Attributes | List of all members
DVPSPresentationLUT_PList Class Reference

the list of presentation LUTs contained in a stored print object. More...

Public Member Functions

 DVPSPresentationLUT_PList ()
 default constructor
 
 DVPSPresentationLUT_PList (const DVPSPresentationLUT_PList &copy)
 copy constructor
 
DVPSPresentationLUT_PListclone ()
 clone method. More...
 
virtual ~DVPSPresentationLUT_PList ()
 destructor
 
OFCondition read (DcmItem &dset)
 reads a list of Presentation LUTs (Presentation LUT Content Sequence) from a DICOM dataset. More...
 
OFCondition write (DcmItem &dset)
 writes the list of Presentation LUTs managed by this object to a DICOM dataset. More...
 
void clear ()
 reset the object to initial state. More...
 
size_t size () const
 gets the number of Presentation LUTs in this list. More...
 
DVPSPresentationLUTfindPresentationLUT (const char *instanceUID)
 finds a presentation LUT by its SOP instance UID. More...
 
void cleanup (const char *filmBox, DVPSImageBoxContent_PList &imageBoxes)
 removes all presentation LUT entries that are not referenced from the film box or image box level. More...
 
const char * addPresentationLUT (DVPSPresentationLUT *newLUT, OFBool inversePLUT)
 adds a Presentation LUT to the list of managed LUTs. More...
 
void insert (DVPSPresentationLUT *newLUT)
 adds a Presentation LUT to the list of managed LUT. More...
 
void printSCPDelete (T_DIMSE_Message &rq, T_DIMSE_Message &rsp)
 performs a Print SCP Presentation LUT N-DELETE operation. More...
 

Private Member Functions

DVPSPresentationLUT_PListoperator= (const DVPSPresentationLUT_PList &)
 private undefined assignment operator
 

Private Attributes

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

Detailed Description

the list of presentation LUTs contained in a stored print object.

This class manages the data structures comprising one complete Presentation LUT Content Sequence.

Member Function Documentation

◆ addPresentationLUT()

const char* DVPSPresentationLUT_PList::addPresentationLUT ( DVPSPresentationLUT newLUT,
OFBool  inversePLUT 
)

adds a Presentation LUT to the list of managed LUTs.

The referenced LUT is copied. If an identical LUT already exists, no duplicate is created.

Parameters
newLUTpointer to new Presentation LUT. May be NULL.
inversePLUTtrue if presentation LUT is for Monochrome1 and must be inversed.
Returns
UID of referenced Presentation LUT. May be NULL (if input was NULL).

◆ cleanup()

void DVPSPresentationLUT_PList::cleanup ( const char *  filmBox,
DVPSImageBoxContent_PList imageBoxes 
)

removes all presentation LUT entries that are not referenced from the film box or image box level.

Parameters
filmBoxPresentation LUT UID reference on film box level, may be NULL.
imageBoxeslist of image boxes

◆ clear()

void DVPSPresentationLUT_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.

◆ clone()

DVPSPresentationLUT_PList* DVPSPresentationLUT_PList::clone ( )
inline

clone method.

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

◆ findPresentationLUT()

DVPSPresentationLUT* DVPSPresentationLUT_PList::findPresentationLUT ( const char *  instanceUID)

finds a presentation LUT by its SOP instance UID.

Parameters
instanceUIDSOP instance UID
Returns
pointer to matching presentation LUT if found, NULL otherwise.

◆ insert()

void DVPSPresentationLUT_PList::insert ( DVPSPresentationLUT newLUT)
inline

adds a Presentation LUT to the list of managed LUT.

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

Parameters
newLUTLUT to be added.

◆ printSCPDelete()

void DVPSPresentationLUT_PList::printSCPDelete ( T_DIMSE_Message rq,
T_DIMSE_Message rsp 
)

performs a Print SCP Presentation LUT 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

◆ read()

OFCondition DVPSPresentationLUT_PList::read ( DcmItem dset)

reads a list of Presentation LUTs (Presentation LUT Content Sequence) from a DICOM dataset.

The DICOM elements of the image references item are copied from the dataset to this object. The completeness of all items (presence of all required elements, value multiplicity) is checked. If this method returns an error code, the object is in undefined state afterwards.

Parameters
dsetthe DICOM dataset from which the sequence is to be read
Returns
EC_Normal if successful, an error code otherwise.

◆ size()

size_t DVPSPresentationLUT_PList::size ( ) const
inline

gets the number of Presentation LUTs in this list.

Returns
the number of Presentation LUTs.

◆ write()

OFCondition DVPSPresentationLUT_PList::write ( DcmItem dset)

writes the list of Presentation LUTs managed by this object to a DICOM dataset.

Copies of the DICOM element managed by this object are inserted into the DICOM dataset.

Parameters
dsetthe DICOM dataset to which the ReferencedImageSequence is written
Returns
EC_Normal if successful, an error code otherwise.

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


Generated on Mon Feb 5 2018 for DCMTK Version 3.6.3 by Doxygen 1.8.14