DCMTK Version 3.6.9
OFFIS DICOM Toolkit
Loading...
Searching...
No Matches
Public Member Functions | Private Attributes | List of all members
DRTConceptualVolumeIdentificationSequence::Item Class Reference

Item class. More...

+ Inheritance diagram for DRTConceptualVolumeIdentificationSequence::Item:

Public Member Functions

 Item (const OFBool emptyDefaultItem=OFFalse)
 (default) constructor
 
 Item (const Item &copy)
 copy constructor
 
virtual ~Item ()
 destructor
 
Itemoperator= (const Item &copy)
 assignment operator
 
void clear ()
 clear all internal member variables
 
OFBool isEmpty ()
 check if item is empty
 
OFBool isValid () const
 check if item is valid, i.e. not the empty default item
 
OFCondition read (DcmItem &item)
 read elements from sequence item
 
OFCondition write (DcmItem &item)
 write elements to sequence item
 
OFCondition getConceptualVolumeUID (OFString &value, const signed long pos=0) const
 get ConceptualVolumeUID (3010,0006)
 
DRTDerivationConceptualVolumeSequencegetDerivationConceptualVolumeSequence ()
 get DerivationConceptualVolumeSequence (3010,0014)
 
const DRTDerivationConceptualVolumeSequencegetDerivationConceptualVolumeSequence () const
 get DerivationConceptualVolumeSequence (3010,0014)
 
DRTEquivalentConceptualVolumesSequencegetEquivalentConceptualVolumesSequence ()
 get EquivalentConceptualVolumesSequence (3010,000a)
 
const DRTEquivalentConceptualVolumesSequencegetEquivalentConceptualVolumesSequence () const
 get EquivalentConceptualVolumesSequence (3010,000a)
 
DRTOriginatingSOPInstanceReferenceSequencegetOriginatingSOPInstanceReferenceSequence ()
 get OriginatingSOPInstanceReferenceSequence (3010,0007)
 
const DRTOriginatingSOPInstanceReferenceSequencegetOriginatingSOPInstanceReferenceSequence () const
 get OriginatingSOPInstanceReferenceSequence (3010,0007)
 
OFCondition setConceptualVolumeUID (const OFString &value, const OFBool check=OFTrue)
 set ConceptualVolumeUID (3010,0006)
 

Private Attributes

OFBool EmptyDefaultItem
 internal flag used to mark the empty default item
 
DcmUniqueIdentifier ConceptualVolumeUID
 ConceptualVolumeUID (3010,0006) vr=UI, vm=1, type=1.
 
DRTDerivationConceptualVolumeSequence DerivationConceptualVolumeSequence
 DerivationConceptualVolumeSequence (3010,0014) vr=SQ, vm=1, type=3.
 
DRTEquivalentConceptualVolumesSequence EquivalentConceptualVolumesSequence
 EquivalentConceptualVolumesSequence (3010,000a) vr=SQ, vm=1, type=3.
 
DRTOriginatingSOPInstanceReferenceSequence OriginatingSOPInstanceReferenceSequence
 OriginatingSOPInstanceReferenceSequence (3010,0007) vr=SQ, vm=1, type=1C.
 

Additional Inherited Members

- Protected Member Functions inherited from DRTTypes
virtual ~DRTTypes ()
 destructor.
 
- 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.
 
static OFCondition getElementFromDataset (DcmItem &dataset, DcmElement &element)
 get element from dataset
 
static OFCondition getStringValueFromElement (const DcmElement &element, OFString &stringValue, const signed long pos=0)
 get string value from element
 
static OFCondition getStringValueFromDataset (DcmItem &dataset, const DcmTagKey &tagKey, OFString &stringValue)
 get string value from dataset
 
static OFCondition putStringValueToDataset (DcmItem &dataset, const DcmTag &tag, const OFString &stringValue, const OFBool allowEmpty=OFTrue)
 put string value to dataset
 
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
 
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.
 
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.
 

Detailed Description

Item class.

Constructor & Destructor Documentation

◆ Item() [1/2]

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

(default) constructor

Parameters
emptyDefaultItemflag used to mark the empty default item

◆ Item() [2/2]

DRTConceptualVolumeIdentificationSequence::Item::Item ( const Item copy)

copy constructor

Parameters
copyitem object to be copied

Member Function Documentation

◆ getConceptualVolumeUID()

OFCondition DRTConceptualVolumeIdentificationSequence::Item::getConceptualVolumeUID ( OFString value,
const signed long  pos = 0 
) const

get ConceptualVolumeUID (3010,0006)

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

◆ getDerivationConceptualVolumeSequence() [1/2]

DRTDerivationConceptualVolumeSequence & DRTConceptualVolumeIdentificationSequence::Item::getDerivationConceptualVolumeSequence ( )
inline

get DerivationConceptualVolumeSequence (3010,0014)

Returns
reference to sequence element

◆ getDerivationConceptualVolumeSequence() [2/2]

const DRTDerivationConceptualVolumeSequence & DRTConceptualVolumeIdentificationSequence::Item::getDerivationConceptualVolumeSequence ( ) const
inline

get DerivationConceptualVolumeSequence (3010,0014)

Returns
const reference to sequence element

◆ getEquivalentConceptualVolumesSequence() [1/2]

DRTEquivalentConceptualVolumesSequence & DRTConceptualVolumeIdentificationSequence::Item::getEquivalentConceptualVolumesSequence ( )
inline

get EquivalentConceptualVolumesSequence (3010,000a)

Returns
reference to sequence element

◆ getEquivalentConceptualVolumesSequence() [2/2]

const DRTEquivalentConceptualVolumesSequence & DRTConceptualVolumeIdentificationSequence::Item::getEquivalentConceptualVolumesSequence ( ) const
inline

get EquivalentConceptualVolumesSequence (3010,000a)

Returns
const reference to sequence element

◆ getOriginatingSOPInstanceReferenceSequence() [1/2]

DRTOriginatingSOPInstanceReferenceSequence & DRTConceptualVolumeIdentificationSequence::Item::getOriginatingSOPInstanceReferenceSequence ( )
inline

get OriginatingSOPInstanceReferenceSequence (3010,0007)

Returns
reference to sequence element

◆ getOriginatingSOPInstanceReferenceSequence() [2/2]

const DRTOriginatingSOPInstanceReferenceSequence & DRTConceptualVolumeIdentificationSequence::Item::getOriginatingSOPInstanceReferenceSequence ( ) const
inline

get OriginatingSOPInstanceReferenceSequence (3010,0007)

Returns
const reference to sequence element

◆ isEmpty()

OFBool DRTConceptualVolumeIdentificationSequence::Item::isEmpty ( )

check if item is empty

Returns
OFTrue if item is empty, OFFalse otherwise

◆ isValid()

OFBool DRTConceptualVolumeIdentificationSequence::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 & DRTConceptualVolumeIdentificationSequence::Item::operator= ( const Item copy)

assignment operator

Parameters
copyitem object to be copied
Returns
reference to this object

◆ read()

OFCondition DRTConceptualVolumeIdentificationSequence::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

◆ setConceptualVolumeUID()

OFCondition DRTConceptualVolumeIdentificationSequence::Item::setConceptualVolumeUID ( const OFString value,
const OFBool  check = OFTrue 
)

set ConceptualVolumeUID (3010,0006)

Parameters
valuevalue to be set (single value only) or "" for no value
checkcheck 'value' for conformance with VR (UI) and VM (1) if enabled
Returns
status, EC_Normal if successful, an error code otherwise

◆ write()

OFCondition DRTConceptualVolumeIdentificationSequence::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 Fri Mar 21 2025 for DCMTK Version 3.6.9 by Doxygen 1.9.8