Class for graphic data lists. More...
Inheritance diagram for DSRGraphicDataList:
Public Member Functions | |
| DSRGraphicDataList () | |
| default constructor | |
| DSRGraphicDataList (const DSRGraphicDataList &lst) | |
| copy constructor More... | |
| virtual | ~DSRGraphicDataList () |
| destructor | |
| DSRGraphicDataList & | operator= (const DSRGraphicDataList &lst) |
| assignment operator More... | |
| OFCondition | print (STD_NAMESPACE ostream &stream, const size_t flags=0, const char pairSeparator='/', const char itemSeparator=',') const |
| print list of graphic data. More... | |
| OFCondition | read (DcmItem &dataset, const size_t flags) |
| read list of graphic data More... | |
| OFCondition | write (DcmItem &dataset) const |
| write list of graphic data More... | |
| const DSRGraphicDataItem & | getItem (const size_t idx) const |
| get reference to the specified item More... | |
| OFCondition | getItem (const size_t idx, Float32 &column, Float32 &row) const |
| get copy of the specified value pair More... | |
| void | addItem (const Float32 column, const Float32 row) |
| add value pair to the list More... | |
| OFCondition | putString (const char *stringValue) |
| put list of graphic data as a string. More... | |
| Public Member Functions inherited from DSRListOfItems< DSRGraphicDataItem > | |
| DSRListOfItems () | |
| default constructor | |
| DSRListOfItems (const DSRListOfItems< DSRGraphicDataItem > &lst) | |
| copy constructor More... | |
| virtual | ~DSRListOfItems () |
| destructor | |
| DSRListOfItems< DSRGraphicDataItem > & | operator= (const DSRListOfItems< DSRGraphicDataItem > &lst) |
| assignment operator More... | |
| OFBool | operator== (const DSRListOfItems< DSRGraphicDataItem > &lst) const |
| comparison operator "equal" More... | |
| OFBool | operator!= (const DSRListOfItems< DSRGraphicDataItem > &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 DSRGraphicDataItem &item) const |
| check whether specified item is contained in the list More... | |
| const DSRGraphicDataItem & | getItem (const size_t idx) const |
| get reference to the specified item More... | |
| OFCondition | getItem (const size_t idx, DSRGraphicDataItem &item) const |
| get copy of the specified item More... | |
| OFCondition | getItems (OFVector< DSRGraphicDataItem > &items) const |
| get copy of all items (as a vector) More... | |
| void | addItem (const DSRGraphicDataItem &item) |
| add item to the list More... | |
| void | addOnlyNewItem (const DSRGraphicDataItem &item) |
| add item to the list only if it's not already contained More... | |
| void | addItems (const OFVector< DSRGraphicDataItem > &items) |
| add items to the list More... | |
| OFCondition | insertItem (const size_t idx, const DSRGraphicDataItem &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< DSRGraphicDataItem > | |
| OFBool | gotoItemPos (size_t idx, OFLIST_TYPENAME OFListConstIterator(DSRGraphicDataItem) &iterator) const |
| goto specified item position More... | |
| OFBool | gotoItem (const DSRGraphicDataItem &item, OFLIST_TYPENAME OFListConstIterator(DSRGraphicDataItem) &iterator) const |
| goto specified item More... | |
| Protected Attributes inherited from DSRListOfItems< DSRGraphicDataItem > | |
| OFList< DSRGraphicDataItem > | ItemList |
| the list maintained by this class | |
Detailed Description
Class for graphic data lists.
Constructor & Destructor Documentation
◆ DSRGraphicDataList()
| DSRGraphicDataList::DSRGraphicDataList | ( | const DSRGraphicDataList & | lst | ) |
copy constructor
- Parameters
-
lst list to be copied
Member Function Documentation
◆ addItem()
| void DSRGraphicDataList::addItem | ( | const Float32 | column, |
| const Float32 | row | ||
| ) |
add value pair to the list
- Parameters
-
column column value to be added row row value to be added
◆ getItem() [1/2]
| const DSRGraphicDataItem& DSRGraphicDataList::getItem | ( | const size_t | idx | ) | const |
get reference to the specified item
- Parameters
-
idx index of the item to be returned (starting from 1)
- Returns
- reference to the specified item if successful, EmptyItem otherwise
◆ getItem() [2/2]
| OFCondition DSRGraphicDataList::getItem | ( | const size_t | idx, |
| Float32 & | column, | ||
| Float32 & | row | ||
| ) | const |
get copy of the specified value pair
- Parameters
-
idx index of the value pair to be returned (starting from 1) column column value of the specified index (set to 0 first) row row value of the specified index (set to 0 first)
- Returns
- status, EC_Normal if successful, an error code otherwise
◆ operator=()
| DSRGraphicDataList& DSRGraphicDataList::operator= | ( | const DSRGraphicDataList & | lst | ) |
assignment operator
- Parameters
-
lst list to be copied
- Returns
- reference to this list after 'lst' has been copied
◆ print()
| OFCondition DSRGraphicDataList::print | ( | STD_NAMESPACE ostream & | stream, |
| const size_t | flags = 0, |
||
| const char | pairSeparator = '/', |
||
| const char | itemSeparator = ',' |
||
| ) | const |
print list of graphic data.
The output of a typical list looks like this: 0/0,127/127,255/255
- Parameters
-
stream output stream to which the list should be printed flags flag used to customize the output (see DSRTypes::PF_xxx) pairSeparator character specifying the separator between the value pairs itemSeparator character specifying the separator between the list items
- Returns
- status, EC_Normal if successful, an error code otherwise
◆ putString()
| OFCondition DSRGraphicDataList::putString | ( | const char * | stringValue | ) |
put list of graphic data as a string.
This function expects the same input format as created by print(), i.e. a comma separated list of numerical value pairs.
- Parameters
-
stringValue string value to be set
- Returns
- status, EC_Normal if successful, an error code otherwise
◆ read()
| OFCondition DSRGraphicDataList::read | ( | DcmItem & | dataset, |
| const size_t | flags | ||
| ) |
read list of graphic data
- Parameters
-
dataset DICOM dataset from which the list should be read flags flag used to customize the reading process (see DSRTypes::RF_xxx)
- Returns
- status, EC_Normal if successful, an error code otherwise
◆ write()
| OFCondition DSRGraphicDataList::write | ( | DcmItem & | dataset | ) | const |
write list of graphic data
- Parameters
-
dataset DICOM 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:
- dcmsr/include/dcmtk/dcmsr/dsrscogr.h