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

Class for waveform channel lists. More...

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

Public Member Functions

 DSRWaveformChannelList ()
 default constructor
 
 DSRWaveformChannelList (const DSRWaveformChannelList &lst)
 copy constructor
 
virtual ~DSRWaveformChannelList ()
 destructor
 
DSRWaveformChannelListoperator= (const DSRWaveformChannelList &lst)
 assignment operator
 
OFCondition print (STD_NAMESPACE ostream &stream, const size_t flags=0, const char pairSeparator= '/', const char itemSeparator= ',') const
 print list of waveform channels.
 
OFCondition read (DcmItem &dataset)
 read list of waveform channels
 
OFCondition write (DcmItem &dataset) const
 write list of waveform channels
 
OFBool isElement (const Uint16 multiplexGroupNumber, const Uint16 channelNumber) const
 check whether specified value pair is contained in the list
 
OFCondition getItem (const size_t idx, Uint16 &multiplexGroupNumber, Uint16 &channelNumber) const
 get copy of the specified value pair
 
void addItem (const Uint16 multiplexGroupNumber, const Uint16 channelNumber)
 add value pair to the list
 
OFCondition putString (const char *stringValue)
 put list of waveform channels as a string.
 
- Public Member Functions inherited from DSRListOfItems< DSRWaveformChannelItem >
 DSRListOfItems ()
 default constructor
 
 DSRListOfItems (const DSRListOfItems< DSRWaveformChannelItem > &lst)
 copy constructor
 
virtual ~DSRListOfItems ()
 destructor
 
DSRListOfItems
< DSRWaveformChannelItem > & 
operator= (const DSRListOfItems< DSRWaveformChannelItem > &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 DSRWaveformChannelItem &item) const
 check whether specified item is contained in the list
 
const DSRWaveformChannelItemgetItem (const size_t idx) const
 get reference to the specified item
 
OFCondition getItem (const size_t idx, DSRWaveformChannelItem &item) const
 get copy of the specified item
 
void addItem (const DSRWaveformChannelItem &item)
 add item to the list
 
void addOnlyNewItem (const DSRWaveformChannelItem &item)
 add item to the list only if it's not already contained
 
OFCondition insertItem (const size_t idx, const DSRWaveformChannelItem &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< DSRWaveformChannelItem >
static const DSRWaveformChannelItem EmptyItem
 default item which is returned in getItem() if the index is invalid.
 
- Protected Member Functions inherited from DSRListOfItems< DSRWaveformChannelItem >
OFBool gotoItemPos (size_t idx, OFLIST_TYPENAME OFListConstIterator(DSRWaveformChannelItem)&iterator) const
 goto specified item position
 
OFBool gotoItem (const DSRWaveformChannelItem &item, OFLIST_TYPENAME OFListConstIterator(DSRWaveformChannelItem)&iterator) const
 goto specified item
 
- Protected Attributes inherited from DSRListOfItems< DSRWaveformChannelItem >
OFList< DSRWaveformChannelItemItemList
 the list maintained by this class
 

Detailed Description

Class for waveform channel lists.

Definition at line 108 of file dsrwavch.h.

Constructor & Destructor Documentation

DSRWaveformChannelList::DSRWaveformChannelList ( const DSRWaveformChannelList lst)

copy constructor

Parameters
lstlist to be copied

Member Function Documentation

void DSRWaveformChannelList::addItem ( const Uint16  multiplexGroupNumber,
const Uint16  channelNumber 
)

add value pair to the list

Parameters
multiplexGroupNumbermultiplex group number to be added
channelNumberchannel number to be added
OFCondition DSRWaveformChannelList::getItem ( const size_t  idx,
Uint16 &  multiplexGroupNumber,
Uint16 &  channelNumber 
) const

get copy of the specified value pair

Parameters
idxindex of the value pair to be returned (starting from 1)
multiplexGroupNumbermultiplex group number of the specified index (set to 0)
channelNumberchannel number of the specified index (set to 0 first)
Returns
status, EC_Normal if successful, an error code otherwise
OFBool DSRWaveformChannelList::isElement ( const Uint16  multiplexGroupNumber,
const Uint16  channelNumber 
) const

check whether specified value pair is contained in the list

Parameters
multiplexGroupNumbermultiplex group number to be checked
channelNumberchannel number to be checked
Returns
OFTrue if the value pair is in the list, OFFalse otherwise
DSRWaveformChannelList& DSRWaveformChannelList::operator= ( const DSRWaveformChannelList lst)

assignment operator

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

print list of waveform channels.

The output of a typical list looks like this: 1/2,3/4,5/6

Parameters
streamoutput stream to which the list should be printed
flagsflag used to customize the output (see DSRTypes::PF_xxx)
pairSeparatorcharacter specifying the separator between the value pairs
itemSeparatorcharacter specifying the separator between the list items
Returns
status, EC_Normal if successful, an error code otherwise
OFCondition DSRWaveformChannelList::putString ( const char *  stringValue)

put list of waveform channels 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
stringValuestring value to be set
Returns
status, EC_Normal if successful, an error code otherwise
OFCondition DSRWaveformChannelList::read ( DcmItem dataset)

read list of waveform channels

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

write list of waveform channels

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