OFFIS DCMTK  Version 3.6.0
Public Member Functions
DSRGraphicData3DList Class Reference

Class for graphic data (3D) lists. More...

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

List of all members.

Public Member Functions

 DSRGraphicData3DList ()
 default constructor
 DSRGraphicData3DList (const DSRGraphicData3DList &lst)
 copy constructor
virtual ~DSRGraphicData3DList ()
 destructor
DSRGraphicData3DListoperator= (const DSRGraphicData3DList &lst)
 assignment operator
OFCondition print (STD_NAMESPACE ostream &stream, const size_t flags=0, const char tripletSeparator= '/', const char itemSeparator= ',') const
 print list of graphic data.
OFCondition read (DcmItem &dataset)
 read list of graphic data
OFCondition write (DcmItem &dataset) const
 write list of graphic data
const DSRGraphicData3DItemgetItem (const size_t idx) const
 get reference to the specified item
OFCondition getItem (const size_t idx, Float32 &x, Float32 &y, Float32 &z) const
 get copy of the specified value triplet
void addItem (const Float32 x, const Float32 y, const Float32 z)
 add value triplet to the list
OFCondition putString (const char *stringValue)
 put list of graphic data as a string.
- Public Member Functions inherited from DSRListOfItems< DSRGraphicData3DItem >
 DSRListOfItems ()
 default constructor
 DSRListOfItems (const DSRListOfItems< DSRGraphicData3DItem > &lst)
 copy constructor
virtual ~DSRListOfItems ()
 destructor
DSRListOfItems
< DSRGraphicData3DItem > & 
operator= (const DSRListOfItems< DSRGraphicData3DItem > &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 DSRGraphicData3DItem &item) const
 check whether specified item is contained in the list
OFCondition getItem (const size_t idx, DSRGraphicData3DItem &item) const
 get copy of the specified item
void addItem (const DSRGraphicData3DItem &item)
 add item to the list
void addOnlyNewItem (const DSRGraphicData3DItem &item)
 add item to the list only if it's not already contained
OFCondition insertItem (const size_t idx, const DSRGraphicData3DItem &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< DSRGraphicData3DItem >
static const DSRGraphicData3DItem EmptyItem
 default item which is returned in getItem() if the index is invalid.
- Protected Member Functions inherited from DSRListOfItems< DSRGraphicData3DItem >
OFBool gotoItemPos (size_t idx, OFLIST_TYPENAME OFListConstIterator(DSRGraphicData3DItem)&iterator) const
 goto specified item position
OFBool gotoItem (const DSRGraphicData3DItem &item, OFLIST_TYPENAME OFListConstIterator(DSRGraphicData3DItem)&iterator) const
 goto specified item
- Protected Attributes inherited from DSRListOfItems< DSRGraphicData3DItem >
OFList< DSRGraphicData3DItemItemList
 the list maintained by this class

Detailed Description

Class for graphic data (3D) lists.

Definition at line 95 of file dsrsc3gr.h.


Constructor & Destructor Documentation

DSRGraphicData3DList::DSRGraphicData3DList ( const DSRGraphicData3DList lst)

copy constructor

Parameters:
lstlist to be copied

Member Function Documentation

void DSRGraphicData3DList::addItem ( const Float32  x,
const Float32  y,
const Float32  z 
)

add value triplet to the list

Parameters:
xx value to be added
yy value to be added
zz value to be added
const DSRGraphicData3DItem& DSRGraphicData3DList::getItem ( const size_t  idx) const

get reference to the specified item

Parameters:
idxindex of the item to be returned (starting from 1)
Returns:
reference to the specified item if successful, EmptyItem otherwise

Reimplemented from DSRListOfItems< DSRGraphicData3DItem >.

OFCondition DSRGraphicData3DList::getItem ( const size_t  idx,
Float32 &  x,
Float32 &  y,
Float32 &  z 
) const

get copy of the specified value triplet

Parameters:
idxindex of the value triplet to be returned (starting from 1)
xx value of the specified index (set to 0 first)
yy value of the specified index (set to 0 first)
zz value of the specified index (set to 0 first)
Returns:
status, EC_Normal if successful, an error code otherwise
DSRGraphicData3DList& DSRGraphicData3DList::operator= ( const DSRGraphicData3DList lst)

assignment operator

Parameters:
lstlist to be copied
Returns:
reference to this list after 'lst' has been copied
OFCondition DSRGraphicData3DList::print ( STD_NAMESPACE ostream &  stream,
const size_t  flags = 0,
const char  tripletSeparator = '/',
const char  itemSeparator = ',' 
) const

print list of graphic data.

The output of a typical list looks like this: 0/0/0,127/127/127,255/255/255

Parameters:
streamoutput stream to which the list should be printed
flagsflag used to customize the output (see DSRTypes::PF_xxx)
tripletSeparatorcharacter specifying the separator between the value triplets
itemSeparatorcharacter specifying the separator between the list items
Returns:
status, EC_Normal if successful, an error code otherwise
OFCondition DSRGraphicData3DList::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 triplets.

Parameters:
stringValuestring value to be set
Returns:
status, EC_Normal if successful, an error code otherwise
OFCondition DSRGraphicData3DList::read ( DcmItem dataset)

read list of graphic data

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

write list of graphic data

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 May 31 2012 for OFFIS DCMTK Version 3.6.0 by Doxygen 1.8.1