DCMTK  Version 3.6.3
OFFIS DICOM Toolkit
Public Member Functions | Private Attributes | List of all members
DRTMultiplexedAudioChannelsDescriptionCodeSequence::Item Class Reference

Item class. More...

+ Inheritance diagram for DRTMultiplexedAudioChannelsDescriptionCodeSequence::Item:

Public Member Functions

 Item (const OFBool emptyDefaultItem=OFFalse)
 (default) constructor More...
 
 Item (const Item &copy)
 copy constructor More...
 
virtual ~Item ()
 destructor
 
Itemoperator= (const Item &copy)
 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...
 
DRTChannelSourceSequencegetChannelSourceSequence ()
 get ChannelSourceSequence (003a,0208) More...
 
const DRTChannelSourceSequencegetChannelSourceSequence () 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...
 

Private Attributes

OFBool EmptyDefaultItem
 internal flag used to mark the empty default item
 
DcmIntegerString ChannelIdentificationCode
 ChannelIdentificationCode (003a,0301) vr=IS, vm=1, type=1.
 
DcmCodeString ChannelMode
 ChannelMode (003a,0302) vr=CS, vm=1, type=1.
 
DRTChannelSourceSequence ChannelSourceSequence
 ChannelSourceSequence (003a,0208) vr=SQ, vm=1, type=1.
 

Additional Inherited Members

- Protected Member Functions inherited from DRTTypes
virtual ~DRTTypes ()
 destructor. More...
 
- Static Protected Member Functions inherited from DRTTypes
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...
 

Detailed Description

Item class.

Constructor & Destructor Documentation

◆ Item() [1/2]

DRTMultiplexedAudioChannelsDescriptionCodeSequence::Item::Item ( const OFBool  emptyDefaultItem = OFFalse)

(default) constructor

Parameters
emptyDefaultItemflag used to mark the empty default item

◆ Item() [2/2]

DRTMultiplexedAudioChannelsDescriptionCodeSequence::Item::Item ( const Item copy)

copy constructor

Parameters
copyitem object to be copied

Member Function Documentation

◆ getChannelIdentificationCode() [1/2]

OFCondition DRTMultiplexedAudioChannelsDescriptionCodeSequence::Item::getChannelIdentificationCode ( OFString value,
const signed long  pos = 0 
) const

get ChannelIdentificationCode (003a,0301)

Parameters
valuereference to variable in which the value should be stored
posindex 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
valuereference to variable in which the value should be stored
posindex 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
valuereference to variable in which the value should be stored
posindex 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]

DRTChannelSourceSequence& DRTMultiplexedAudioChannelsDescriptionCodeSequence::Item::getChannelSourceSequence ( )
inline

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
copyitem object to be copied
Returns
reference to this object

◆ read()

OFCondition DRTMultiplexedAudioChannelsDescriptionCodeSequence::Item::read ( DcmItem item)

read elements from sequence item

Parameters
itemreference 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
valuevalue to be set (single value only) or "" for no value
checkcheck '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
valuevalue to be set (single value only) or "" for no value
checkcheck '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
itemreference 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:


Generated on Mon Feb 5 2018 for DCMTK Version 3.6.3 by Doxygen 1.8.14