Item class.
More...
|
| Item (const OFBool emptyDefaultItem=OFFalse) |
| (default) constructor More...
|
|
| Item (const Item ©) |
| copy constructor More...
|
|
virtual | ~Item () |
| destructor
|
|
Item & | operator= (const Item ©) |
| assigment operator More...
|
|
void | clear () |
| clear all internal member variables
|
|
OFBool | isEmpty () |
| check if item is empty More...
|
|
OFBool | isValid () const |
| check if item is valid, i.e. not the empty default item More...
|
|
OFCondition | read (DcmItem &item) |
| read elements from sequence item More...
|
|
OFCondition | write (DcmItem &item) |
| write elements to sequence item More...
|
|
OFCondition | getChannelIdentificationCode (OFString &value, const signed long pos=0) const |
| get ChannelIdentificationCode (003a,0301) More...
|
|
OFCondition | getChannelIdentificationCode (Sint32 &value, const unsigned long pos=0) const |
| get ChannelIdentificationCode (003a,0301) More...
|
|
OFCondition | getChannelMode (OFString &value, const signed long pos=0) const |
| get ChannelMode (003a,0302) More...
|
|
DRTChannelSourceSequence & | getChannelSourceSequence () |
| get ChannelSourceSequence (003a,0208) More...
|
|
const DRTChannelSourceSequence & | getChannelSourceSequence () const |
| get ChannelSourceSequence (003a,0208) More...
|
|
OFCondition | setChannelIdentificationCode (const OFString &value, const OFBool check=OFTrue) |
| set ChannelIdentificationCode (003a,0301) More...
|
|
OFCondition | setChannelMode (const OFString &value, const OFBool check=OFTrue) |
| set ChannelMode (003a,0302) More...
|
|
|
virtual | ~DRTTypes () |
| destructor. More...
|
|
static OFCondition | addElementToDataset (OFCondition &result, DcmItem &dataset, DcmElement *element, const OFString &vm, const OFString &type, const char *moduleName=NULL) |
| add given element to the dataset. More...
|
|
static OFCondition | getElementFromDataset (DcmItem &dataset, DcmElement &element) |
| get element from dataset More...
|
|
static OFCondition | getStringValueFromElement (const DcmElement &element, OFString &stringValue, const signed long pos=0) |
| get string value from element More...
|
|
static OFCondition | getStringValueFromDataset (DcmItem &dataset, const DcmTagKey &tagKey, OFString &stringValue) |
| get string value from dataset More...
|
|
static OFCondition | putStringValueToDataset (DcmItem &dataset, const DcmTag &tag, const OFString &stringValue, const OFBool allowEmpty=OFTrue) |
| put string value to dataset More...
|
|
static OFBool | checkElementValue (DcmElement &element, const OFString &vm, const OFString &type, const OFCondition &searchCond=EC_Normal, const char *moduleName=NULL) |
| check element value for correct value multiplicity and type More...
|
|
static OFCondition | getAndCheckElementFromDataset (DcmItem &dataset, DcmElement &element, const OFString &vm, const OFString &type, const char *moduleName=NULL) |
| get element from dataset and check it for correct value multiplicity and type. More...
|
|
static OFCondition | getAndCheckStringValueFromDataset (DcmItem &dataset, const DcmTagKey &tagKey, OFString &stringValue, const OFString &vm, const OFString &type, const char *moduleName=NULL) |
| get string value from dataset and check it for correct value multiplicity and type. More...
|
|
◆ Item() [1/2]
DRTMultiplexedAudioChannelsDescriptionCodeSequence::Item::Item |
( |
const OFBool |
emptyDefaultItem = OFFalse | ) |
|
(default) constructor
- Parameters
-
emptyDefaultItem | flag used to mark the empty default item |
◆ Item() [2/2]
DRTMultiplexedAudioChannelsDescriptionCodeSequence::Item::Item |
( |
const Item & |
copy | ) |
|
copy constructor
- Parameters
-
copy | item object to be copied |
◆ getChannelIdentificationCode() [1/2]
OFCondition DRTMultiplexedAudioChannelsDescriptionCodeSequence::Item::getChannelIdentificationCode |
( |
OFString & |
value, |
|
|
const signed long |
pos = 0 |
|
) |
| const |
get ChannelIdentificationCode (003a,0301)
- Parameters
-
value | reference to variable in which the value should be stored |
pos | index of the value to get (0..vm-1), -1 for all components |
- Returns
- status, EC_Normal if successful, an error code otherwise
◆ getChannelIdentificationCode() [2/2]
OFCondition DRTMultiplexedAudioChannelsDescriptionCodeSequence::Item::getChannelIdentificationCode |
( |
Sint32 & |
value, |
|
|
const unsigned long |
pos = 0 |
|
) |
| const |
get ChannelIdentificationCode (003a,0301)
- Parameters
-
value | reference to variable in which the value should be stored |
pos | index of the value to get (0..vm-1) |
- Returns
- status, EC_Normal if successful, an error code otherwise
◆ getChannelMode()
OFCondition DRTMultiplexedAudioChannelsDescriptionCodeSequence::Item::getChannelMode |
( |
OFString & |
value, |
|
|
const signed long |
pos = 0 |
|
) |
| const |
get ChannelMode (003a,0302)
- Parameters
-
value | reference to variable in which the value should be stored |
pos | index of the value to get (0..vm-1), -1 for all components |
- Returns
- status, EC_Normal if successful, an error code otherwise
◆ getChannelSourceSequence() [1/2]
get ChannelSourceSequence (003a,0208)
- Returns
- reference to sequence element
◆ getChannelSourceSequence() [2/2]
const DRTChannelSourceSequence& DRTMultiplexedAudioChannelsDescriptionCodeSequence::Item::getChannelSourceSequence |
( |
| ) |
const |
|
inline |
get ChannelSourceSequence (003a,0208)
- Returns
- const reference to sequence element
◆ isEmpty()
OFBool DRTMultiplexedAudioChannelsDescriptionCodeSequence::Item::isEmpty |
( |
| ) |
|
check if item is empty
- Returns
- OFTrue if item is empty, OFFalse otherwise
◆ isValid()
OFBool DRTMultiplexedAudioChannelsDescriptionCodeSequence::Item::isValid |
( |
| ) |
const |
check if item is valid, i.e. not the empty default item
- Returns
- OFTrue if item is valid, OFFalse otherwise
◆ operator=()
Item& DRTMultiplexedAudioChannelsDescriptionCodeSequence::Item::operator= |
( |
const Item & |
copy | ) |
|
assigment operator
- Parameters
-
copy | item object to be copied |
- Returns
- reference to this object
◆ read()
OFCondition DRTMultiplexedAudioChannelsDescriptionCodeSequence::Item::read |
( |
DcmItem & |
item | ) |
|
read elements from sequence item
- Parameters
-
item | reference to DICOM sequence item from which the elements should be read |
- Returns
- status, EC_Normal if successful, an error code otherwise
◆ setChannelIdentificationCode()
OFCondition DRTMultiplexedAudioChannelsDescriptionCodeSequence::Item::setChannelIdentificationCode |
( |
const OFString & |
value, |
|
|
const OFBool |
check = OFTrue |
|
) |
| |
set ChannelIdentificationCode (003a,0301)
- Parameters
-
value | value to be set (single value only) or "" for no value |
check | check 'value' for conformance with VR (IS) and VM (1) if enabled |
- Returns
- status, EC_Normal if successful, an error code otherwise
◆ setChannelMode()
OFCondition DRTMultiplexedAudioChannelsDescriptionCodeSequence::Item::setChannelMode |
( |
const OFString & |
value, |
|
|
const OFBool |
check = OFTrue |
|
) |
| |
set ChannelMode (003a,0302)
- Parameters
-
value | value to be set (single value only) or "" for no value |
check | check 'value' for conformance with VR (CS) and VM (1) if enabled |
- Returns
- status, EC_Normal if successful, an error code otherwise
◆ write()
OFCondition DRTMultiplexedAudioChannelsDescriptionCodeSequence::Item::write |
( |
DcmItem & |
item | ) |
|
write elements to sequence item
- Parameters
-
item | reference to DICOM sequence item to which the elements should be written |
- Returns
- status, EC_Normal if successful, an error code otherwise
The documentation for this class was generated from the following file:
- dcmrt/include/dcmtk/dcmrt/seq/drtmacds.h