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

Class for image segment number list. More...

+ Inheritance diagram for DSRImageSegmentList:

Public Member Functions

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

Additional Inherited Members

- Protected Member Functions inherited from DSRListOfItems< Uint16 >
OFBool gotoItemPos (size_t idx, OFLIST_TYPENAME OFListConstIterator(Uint16) &iterator) const
 goto specified item position More...
 
OFBool gotoItem (const Uint16 &item, OFLIST_TYPENAME OFListConstIterator(Uint16) &iterator) const
 goto specified item More...
 
- Protected Attributes inherited from DSRListOfItems< Uint16 >
OFList< Uint16 > ItemList
 the list maintained by this class
 

Detailed Description

Class for image segment number list.

Constructor & Destructor Documentation

◆ DSRImageSegmentList()

DSRImageSegmentList::DSRImageSegmentList ( const DSRImageSegmentList lst)

copy constructor

Parameters
lstlist to be copied

Member Function Documentation

◆ operator=()

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

assignment operator

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

◆ print()

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

print list of referenced segment 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

◆ putString()

OFCondition DSRImageSegmentList::putString ( const char *  stringValue)

put list of referenced segment 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

◆ read()

OFCondition DSRImageSegmentList::read ( DcmItem dataset,
const size_t  flags 
)

read list of referenced segment numbers

Parameters
datasetDICOM dataset from which the list should be read
flagsflag used to customize the reading process (see DSRTypes::RF_xxx)
Returns
status, EC_Normal if successful, an error code otherwise

◆ write()

OFCondition DSRImageSegmentList::write ( DcmItem dataset) const

write list of referenced segment 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 Mon Feb 5 2018 for DCMTK Version 3.6.3 by Doxygen 1.8.14