DSRWaveformChannelList Class Reference
Class for waveform channel lists.
More...
List of all members.
Public Member Functions |
| DSRWaveformChannelList () |
| default constructor
|
| DSRWaveformChannelList (const DSRWaveformChannelList &lst) |
| copy constructor
|
virtual | ~DSRWaveformChannelList () |
| destructor
|
DSRWaveformChannelList & | operator= (const DSRWaveformChannelList &lst) |
| assignment operator
|
OFCondition | print (ostream &stream, const size_t flags=0, const char pairSeparator= '/', const char itemSeparator= ',') const |
| print list of waveform channels.
|
OFCondition | read (DcmItem &dataset, OFConsole *logStream) |
| read list of waveform channels
|
OFCondition | write (DcmItem &dataset, OFConsole *logStream) 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.
|
Detailed Description
Class for waveform channel lists.
Definition at line 112 of file dsrwavch.h.
Constructor & Destructor Documentation
copy constructor
- Parameters:
-
Member Function Documentation
void DSRWaveformChannelList::addItem |
( |
const Uint16 |
multiplexGroupNumber, |
|
|
const Uint16 |
channelNumber | |
|
) |
| | |
add value pair to the list
- Parameters:
-
| multiplexGroupNumber | multiplex group number to be added |
| channelNumber | channel number to be added |
OFCondition DSRWaveformChannelList::getItem |
( |
const size_t |
idx, |
|
|
Uint16 & |
multiplexGroupNumber, |
|
|
Uint16 & |
channelNumber | |
|
) |
| | const |
get copy of the specified value pair
- Parameters:
-
| idx | index of the value pair to be returned (starting from 1) |
| multiplexGroupNumber | multiplex group number of the specified index (set to 0) |
| channelNumber | channel 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:
-
| multiplexGroupNumber | multiplex group number to be checked |
| channelNumber | channel number to be checked |
- Returns:
- OFTrue if the value pair is in the list, OFFalse otherwise
OFCondition DSRWaveformChannelList::print |
( |
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:
-
| 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 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:
-
| stringValue | string value to be set |
- Returns:
- status, EC_Normal if successful, an error code otherwise
read list of waveform channels
- 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
write list of waveform channels
- 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: