DCMTK  Version 3.6.1 20120515
OFFIS DICOM Toolkit
Public Member Functions | Private Attributes
DRTApplicationSetupSequence::Item Class Reference

Item class. More...

+ Inheritance diagram for DRTApplicationSetupSequence::Item:

List of all members.

Public Member Functions

 Item (const OFBool emptyDefaultItem=OFFalse)
 (default) constructor
 Item (const Item &copy)
 copy constructor
virtual ~Item ()
 destructor
Itemoperator= (const Item &copy)
 assigment 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 getApplicationSetupManufacturer (OFString &value, const signed long pos=0) const
 get ApplicationSetupManufacturer (300a,0238)
OFCondition getApplicationSetupName (OFString &value, const signed long pos=0) const
 get ApplicationSetupName (300a,0236)
OFCondition getApplicationSetupNumber (OFString &value, const signed long pos=0) const
 get ApplicationSetupNumber (300a,0234)
OFCondition getApplicationSetupNumber (Sint32 &value, const unsigned long pos=0) const
 get ApplicationSetupNumber (300a,0234)
OFCondition getApplicationSetupType (OFString &value, const signed long pos=0) const
 get ApplicationSetupType (300a,0232)
OFCondition getTemplateName (OFString &value, const signed long pos=0) const
 get TemplateName (300a,0244)
OFCondition getTemplateNumber (OFString &value, const signed long pos=0) const
 get TemplateNumber (300a,0240)
OFCondition getTemplateNumber (Sint32 &value, const unsigned long pos=0) const
 get TemplateNumber (300a,0240)
OFCondition getTemplateType (OFString &value, const signed long pos=0) const
 get TemplateType (300a,0242)
OFCondition getTotalReferenceAirKerma (OFString &value, const signed long pos=0) const
 get TotalReferenceAirKerma (300a,0250)
OFCondition getTotalReferenceAirKerma (Float64 &value, const unsigned long pos=0) const
 get TotalReferenceAirKerma (300a,0250)
DRTBrachyAccessoryDeviceSequencegetBrachyAccessoryDeviceSequence ()
 get BrachyAccessoryDeviceSequence (300a,0260)
const
DRTBrachyAccessoryDeviceSequence
getBrachyAccessoryDeviceSequence () const
 get BrachyAccessoryDeviceSequence (300a,0260)
DRTChannelSequencegetChannelSequence ()
 get ChannelSequence (300a,0280)
const DRTChannelSequencegetChannelSequence () const
 get ChannelSequence (300a,0280)
DRTReferencedReferenceImageSequenceInRTBrachyApplicationSetupsModulegetReferencedReferenceImageSequence ()
 get ReferencedReferenceImageSequence (300c,0042)
const
DRTReferencedReferenceImageSequenceInRTBrachyApplicationSetupsModule
getReferencedReferenceImageSequence () const
 get ReferencedReferenceImageSequence (300c,0042)
OFCondition setApplicationSetupManufacturer (const OFString &value, const OFBool check=OFTrue)
 set ApplicationSetupManufacturer (300a,0238)
OFCondition setApplicationSetupName (const OFString &value, const OFBool check=OFTrue)
 set ApplicationSetupName (300a,0236)
OFCondition setApplicationSetupNumber (const OFString &value, const OFBool check=OFTrue)
 set ApplicationSetupNumber (300a,0234)
OFCondition setApplicationSetupType (const OFString &value, const OFBool check=OFTrue)
 set ApplicationSetupType (300a,0232)
OFCondition setTemplateName (const OFString &value, const OFBool check=OFTrue)
 set TemplateName (300a,0244)
OFCondition setTemplateNumber (const OFString &value, const OFBool check=OFTrue)
 set TemplateNumber (300a,0240)
OFCondition setTemplateType (const OFString &value, const OFBool check=OFTrue)
 set TemplateType (300a,0242)
OFCondition setTotalReferenceAirKerma (const OFString &value, const OFBool check=OFTrue)
 set TotalReferenceAirKerma (300a,0250)

Private Attributes

OFBool EmptyDefaultItem
 internal flag used to mark the empty default item
DcmLongString ApplicationSetupManufacturer
 ApplicationSetupManufacturer (300a,0238) vr=LO, vm=1, type=3.
DcmLongString ApplicationSetupName
 ApplicationSetupName (300a,0236) vr=LO, vm=1, type=3.
DcmIntegerString ApplicationSetupNumber
 ApplicationSetupNumber (300a,0234) vr=IS, vm=1, type=1.
DcmCodeString ApplicationSetupType
 ApplicationSetupType (300a,0232) vr=CS, vm=1, type=1.
DRTBrachyAccessoryDeviceSequence BrachyAccessoryDeviceSequence
 BrachyAccessoryDeviceSequence (300a,0260) vr=SQ, vm=1, type=3.
DRTChannelSequence ChannelSequence
 ChannelSequence (300a,0280) vr=SQ, vm=1, type=1.
DRTReferencedReferenceImageSequenceInRTBrachyApplicationSetupsModule ReferencedReferenceImageSequence
 ReferencedReferenceImageSequence (300c,0042) vr=SQ, vm=1, type=3.
DcmLongString TemplateName
 TemplateName (300a,0244) vr=LO, vm=1, type=3.
DcmIntegerString TemplateNumber
 TemplateNumber (300a,0240) vr=IS, vm=1, type=3.
DcmShortString TemplateType
 TemplateType (300a,0242) vr=SH, vm=1, type=3.
DcmDecimalString TotalReferenceAirKerma
 TotalReferenceAirKerma (300a,0250) vr=DS, vm=1, type=1.

Detailed Description

Item class.


Constructor & Destructor Documentation

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

(default) constructor

Parameters:
emptyDefaultItemflag used to mark the empty default item

copy constructor

Parameters:
copyitem object to be copied

Member Function Documentation

get ApplicationSetupManufacturer (300a,0238)

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
OFCondition DRTApplicationSetupSequence::Item::getApplicationSetupName ( OFString value,
const signed long  pos = 0 
) const

get ApplicationSetupName (300a,0236)

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
OFCondition DRTApplicationSetupSequence::Item::getApplicationSetupNumber ( OFString value,
const signed long  pos = 0 
) const

get ApplicationSetupNumber (300a,0234)

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
OFCondition DRTApplicationSetupSequence::Item::getApplicationSetupNumber ( Sint32 &  value,
const unsigned long  pos = 0 
) const

get ApplicationSetupNumber (300a,0234)

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
OFCondition DRTApplicationSetupSequence::Item::getApplicationSetupType ( OFString value,
const signed long  pos = 0 
) const

get ApplicationSetupType (300a,0232)

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

get BrachyAccessoryDeviceSequence (300a,0260)

Returns:
reference to sequence element

get BrachyAccessoryDeviceSequence (300a,0260)

Returns:
const reference to sequence element

get ChannelSequence (300a,0280)

Returns:
reference to sequence element

get ChannelSequence (300a,0280)

Returns:
const reference to sequence element

get ReferencedReferenceImageSequence (300c,0042)

Returns:
reference to sequence element

get ReferencedReferenceImageSequence (300c,0042)

Returns:
const reference to sequence element
OFCondition DRTApplicationSetupSequence::Item::getTemplateName ( OFString value,
const signed long  pos = 0 
) const

get TemplateName (300a,0244)

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
OFCondition DRTApplicationSetupSequence::Item::getTemplateNumber ( OFString value,
const signed long  pos = 0 
) const

get TemplateNumber (300a,0240)

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
OFCondition DRTApplicationSetupSequence::Item::getTemplateNumber ( Sint32 &  value,
const unsigned long  pos = 0 
) const

get TemplateNumber (300a,0240)

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
OFCondition DRTApplicationSetupSequence::Item::getTemplateType ( OFString value,
const signed long  pos = 0 
) const

get TemplateType (300a,0242)

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
OFCondition DRTApplicationSetupSequence::Item::getTotalReferenceAirKerma ( OFString value,
const signed long  pos = 0 
) const

get TotalReferenceAirKerma (300a,0250)

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
OFCondition DRTApplicationSetupSequence::Item::getTotalReferenceAirKerma ( Float64 &  value,
const unsigned long  pos = 0 
) const

get TotalReferenceAirKerma (300a,0250)

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

check if item is empty

Returns:
OFTrue if item is empty, OFFalse otherwise

check if item is valid, i.e. not the empty default item

Returns:
OFTrue if item is valid, OFFalse otherwise
Item& DRTApplicationSetupSequence::Item::operator= ( const Item copy)

assigment operator

Parameters:
copyitem object to be copied

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
OFCondition DRTApplicationSetupSequence::Item::setApplicationSetupManufacturer ( const OFString value,
const OFBool  check = OFTrue 
)

set ApplicationSetupManufacturer (300a,0238)

Parameters:
valuevalue to be set (single value only) or "" for no value
checkcheck 'value' for conformance with VR (LO) and VM (1) if enabled
Returns:
status, EC_Normal if successful, an error code otherwise
OFCondition DRTApplicationSetupSequence::Item::setApplicationSetupName ( const OFString value,
const OFBool  check = OFTrue 
)

set ApplicationSetupName (300a,0236)

Parameters:
valuevalue to be set (single value only) or "" for no value
checkcheck 'value' for conformance with VR (LO) and VM (1) if enabled
Returns:
status, EC_Normal if successful, an error code otherwise
OFCondition DRTApplicationSetupSequence::Item::setApplicationSetupNumber ( const OFString value,
const OFBool  check = OFTrue 
)

set ApplicationSetupNumber (300a,0234)

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
OFCondition DRTApplicationSetupSequence::Item::setApplicationSetupType ( const OFString value,
const OFBool  check = OFTrue 
)

set ApplicationSetupType (300a,0232)

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
OFCondition DRTApplicationSetupSequence::Item::setTemplateName ( const OFString value,
const OFBool  check = OFTrue 
)

set TemplateName (300a,0244)

Parameters:
valuevalue to be set (single value only) or "" for no value
checkcheck 'value' for conformance with VR (LO) and VM (1) if enabled
Returns:
status, EC_Normal if successful, an error code otherwise
OFCondition DRTApplicationSetupSequence::Item::setTemplateNumber ( const OFString value,
const OFBool  check = OFTrue 
)

set TemplateNumber (300a,0240)

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
OFCondition DRTApplicationSetupSequence::Item::setTemplateType ( const OFString value,
const OFBool  check = OFTrue 
)

set TemplateType (300a,0242)

Parameters:
valuevalue to be set (single value only) or "" for no value
checkcheck 'value' for conformance with VR (SH) and VM (1) if enabled
Returns:
status, EC_Normal if successful, an error code otherwise
OFCondition DRTApplicationSetupSequence::Item::setTotalReferenceAirKerma ( const OFString value,
const OFBool  check = OFTrue 
)

set TotalReferenceAirKerma (300a,0250)

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

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 Tue May 15 2012 for DCMTK Version 3.6.1 20120515 by Doxygen 1.7.5.1-20111027