DSRImageFrameList Class Reference

Class for image frame list. More...

Inheritance diagram for DSRImageFrameList:

DSRListOfItems< Sint32 > List of all members.

Public Member Functions

 DSRImageFrameList ()
 default constructor
 DSRImageFrameList (const DSRImageFrameList &lst)
 copy constructor
virtual ~DSRImageFrameList ()
 destructor
DSRImageFrameList & operator= (const DSRImageFrameList &lst)
 assignment operator
OFCondition print (ostream &stream, const size_t flags=0, const char separator= ',') const
 print list of referenced frame numbers.
OFCondition read (DcmItem &dataset, OFConsole *logStream)
 read list of referenced frame numbers
OFCondition write (DcmItem &dataset, OFConsole *logStream) const
 write list of referenced frame numbers
OFCondition putString (const char *stringValue)
 put list of referenced frame numbers as a string.

Detailed Description

Class for image frame list.

Definition at line 50 of file dsrimgfr.h.

Constructor & Destructor Documentation

DSRImageFrameList::DSRImageFrameList (  const DSRImageFrameList &  lst  ) 
 

copy constructor

Parameters:
lst list to be copied

Member Function Documentation

DSRImageFrameList& DSRImageFrameList::operator= (  const DSRImageFrameList &  lst  ) 
 

assignment operator

Parameters:
lst list to be copied
Returns:
reference to this list after 'lst' has been copied

OFCondition DSRImageFrameList::print (  ostream &  stream,
const size_t  flags = 0,
const char  separator = ','
)  const
 

print list of referenced frame numbers.

The output of a typical list looks like this: 1,2,3 or 1,... if shortened.

Parameters:
stream output stream to which the list should be printed
flags flag used to customize the output (see DSRTypes::PF_xxx)
separator character specifying the separator between the list items
Returns:
status, EC_Normal if successful, an error code otherwise

OFCondition DSRImageFrameList::putString (  const char *  stringValue  ) 
 

put list of referenced frame numbers as a string.

This function expects the same input format as created by print(), i.e. a comma separated list of numerical values.

Parameters:
stringValue string value to be set
Returns:
status, EC_Normal if successful, an error code otherwise

OFCondition DSRImageFrameList::read (  DcmItem &  dataset,
OFConsole *  logStream
) 
 

read list of referenced frame numbers

Parameters:
dataset DICOM dataset from which the list should be read
logStream pointer to error/warning output stream (output disabled if NULL)
Returns:
status, EC_Normal if successful, an error code otherwise

OFCondition DSRImageFrameList::write (  DcmItem &  dataset,
OFConsole *  logStream
)  const
 

write list of referenced frame numbers

Parameters:
dataset DICOM dataset to which the list should be written
logStream pointer to error/warning output stream (output disabled if NULL)
Returns:
status, EC_Normal if successful, an error code otherwise

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