DSRGraphicDataList Class Reference

Class for graphic data lists. More...

Inheritance diagram for DSRGraphicDataList:

DSRListOfItems< DSRGraphicDataItem > List of all members.

Public Member Functions

 DSRGraphicDataList ()
 default constructor
 DSRGraphicDataList (const DSRGraphicDataList &lst)
 copy constructor
virtual ~DSRGraphicDataList ()
 destructor
DSRGraphicDataList & operator= (const DSRGraphicDataList &lst)
 assignment operator
OFCondition print (ostream &stream, const size_t flags=0, const char pairSeparator= '/', const char itemSeparator= ',') const
 print list of graphic data.
OFCondition read (DcmItem &dataset, OFConsole *logStream)
 read list of graphic data
OFCondition write (DcmItem &dataset, OFConsole *logStream) const
 write list of graphic data
const DSRGraphicDataItem & getItem (const size_t idx) const
 get reference to the specified item
OFCondition getItem (const size_t idx, Float32 &column, Float32 &row) const
 get copy of the specified value pair
void addItem (const Float32 column, const Float32 row)
 add value pair to the list
OFCondition putString (const char *stringValue)
 put list of graphic data as a string.

Detailed Description

Class for graphic data lists.

Definition at line 112 of file dsrscogr.h.

Constructor & Destructor Documentation

DSRGraphicDataList::DSRGraphicDataList (  const DSRGraphicDataList &  lst  ) 
 

copy constructor

Parameters:
lst list to be copied

Member Function Documentation

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

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

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

Reimplemented from DSRListOfItems< DSRGraphicDataItem >.

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

assignment operator

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

OFCondition DSRGraphicDataList::print (  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

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

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

read list of graphic data

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 DSRGraphicDataList::write (  DcmItem &  dataset,
OFConsole *  logStream
)  const
 

write list of graphic data

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