OFFIS DCMTK  Version 3.6.0
Public Member Functions | List of all members
DSRImageFrameList Class Reference

Class for image frame list. More...

Inheritance diagram for DSRImageFrameList:
[legend]
Collaboration diagram for DSRImageFrameList:
[legend]

Public Member Functions

 DSRImageFrameList ()
 default constructor
 
 DSRImageFrameList (const DSRImageFrameList &lst)
 copy constructor
 
virtual ~DSRImageFrameList ()
 destructor
 
DSRImageFrameListoperator= (const DSRImageFrameList &lst)
 assignment operator
 
OFCondition print (STD_NAMESPACE ostream &stream, const size_t flags=0, const char separator= ',') const
 print list of referenced frame numbers.
 
OFCondition read (DcmItem &dataset)
 read list of referenced frame numbers
 
OFCondition write (DcmItem &dataset) const
 write list of referenced frame numbers
 
OFCondition putString (const char *stringValue)
 put list of referenced frame numbers as a string.
 
- Public Member Functions inherited from DSRListOfItems< Sint32 >
 DSRListOfItems ()
 default constructor
 
 DSRListOfItems (const DSRListOfItems< Sint32 > &lst)
 copy constructor
 
virtual ~DSRListOfItems ()
 destructor
 
DSRListOfItems< Sint32 > & operator= (const DSRListOfItems< Sint32 > &lst)
 assignment operator
 
void clear ()
 clear all internal variables
 
OFBool isEmpty () const
 check whether the list is empty
 
size_t getNumberOfItems () const
 get number of items contained in the list
 
OFBool isElement (const Sint32 &item) const
 check whether specified item is contained in the list
 
const Sint32 & getItem (const size_t idx) const
 get reference to the specified item
 
OFCondition getItem (const size_t idx, Sint32 &item) const
 get copy of the specified item
 
void addItem (const Sint32 &item)
 add item to the list
 
void addOnlyNewItem (const Sint32 &item)
 add item to the list only if it's not already contained
 
OFCondition insertItem (const size_t idx, const Sint32 &item)
 insert item at specified position to the list
 
OFCondition removeItem (const size_t idx)
 remove item from the list
 

Additional Inherited Members

- Static Public Attributes inherited from DSRListOfItems< Sint32 >
static const Sint32 EmptyItem
 default item which is returned in getItem() if the index is invalid.
 
- Protected Member Functions inherited from DSRListOfItems< Sint32 >
OFBool gotoItemPos (size_t idx, OFLIST_TYPENAME OFListConstIterator(Sint32)&iterator) const
 goto specified item position
 
OFBool gotoItem (const Sint32 &item, OFLIST_TYPENAME OFListConstIterator(Sint32)&iterator) const
 goto specified item
 
- Protected Attributes inherited from DSRListOfItems< Sint32 >
OFList< Sint32 > ItemList
 the list maintained by this class
 

Detailed Description

Class for image frame list.

Definition at line 46 of file dsrimgfr.h.

Constructor & Destructor Documentation

DSRImageFrameList::DSRImageFrameList ( const DSRImageFrameList lst)

copy constructor

Parameters
lstlist to be copied

Member Function Documentation

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

assignment operator

Parameters
lstlist to be copied
Returns
reference to this list after 'lst' has been copied
OFCondition DSRImageFrameList::print ( STD_NAMESPACE 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
streamoutput stream to which the list should be printed
flagsflag used to customize the output (see DSRTypes::PF_xxx)
separatorcharacter 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
stringValuestring value to be set
Returns
status, EC_Normal if successful, an error code otherwise
OFCondition DSRImageFrameList::read ( DcmItem dataset)

read list of referenced frame numbers

Parameters
datasetDICOM dataset from which the list should be read
Returns
status, EC_Normal if successful, an error code otherwise
OFCondition DSRImageFrameList::write ( DcmItem dataset) const

write list of referenced frame numbers

Parameters
datasetDICOM dataset to which the list should be written
Returns
status, EC_Normal if successful, an error code otherwise

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


Generated on Thu Dec 20 2012 for OFFIS DCMTK Version 3.6.0 by Doxygen 1.8.2