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

Item class. More...

+ Inheritance diagram for DRTRequestAttributesSequence::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 getAccessionNumber (OFString &value, const signed long pos=0) const
 get AccessionNumber (0008,0050)
OFCondition getReasonForTheRequestedProcedure (OFString &value, const signed long pos=0) const
 get ReasonForTheRequestedProcedure (0040,1002)
OFCondition getRequestedProcedureDescription (OFString &value, const signed long pos=0) const
 get RequestedProcedureDescription (0032,1060)
OFCondition getRequestedProcedureID (OFString &value, const signed long pos=0) const
 get RequestedProcedureID (0040,1001)
OFCondition getScheduledProcedureStepDescription (OFString &value, const signed long pos=0) const
 get ScheduledProcedureStepDescription (0040,0007)
OFCondition getScheduledProcedureStepID (OFString &value, const signed long pos=0) const
 get ScheduledProcedureStepID (0040,0009)
OFCondition getStudyInstanceUID (OFString &value, const signed long pos=0) const
 get StudyInstanceUID (0020,000d)
DRTReasonForRequestedProcedureCodeSequencegetReasonForRequestedProcedureCodeSequence ()
 get ReasonForRequestedProcedureCodeSequence (0040,100a)
const
DRTReasonForRequestedProcedureCodeSequence
getReasonForRequestedProcedureCodeSequence () const
 get ReasonForRequestedProcedureCodeSequence (0040,100a)
DRTReferencedStudySequencegetReferencedStudySequence ()
 get ReferencedStudySequence (0008,1110)
const DRTReferencedStudySequencegetReferencedStudySequence () const
 get ReferencedStudySequence (0008,1110)
DRTRequestedProcedureCodeSequencegetRequestedProcedureCodeSequence ()
 get RequestedProcedureCodeSequence (0032,1064)
const
DRTRequestedProcedureCodeSequence
getRequestedProcedureCodeSequence () const
 get RequestedProcedureCodeSequence (0032,1064)
DRTScheduledProtocolCodeSequencegetScheduledProtocolCodeSequence ()
 get ScheduledProtocolCodeSequence (0040,0008)
const
DRTScheduledProtocolCodeSequence
getScheduledProtocolCodeSequence () const
 get ScheduledProtocolCodeSequence (0040,0008)
OFCondition setAccessionNumber (const OFString &value, const OFBool check=OFTrue)
 set AccessionNumber (0008,0050)
OFCondition setReasonForTheRequestedProcedure (const OFString &value, const OFBool check=OFTrue)
 set ReasonForTheRequestedProcedure (0040,1002)
OFCondition setRequestedProcedureDescription (const OFString &value, const OFBool check=OFTrue)
 set RequestedProcedureDescription (0032,1060)
OFCondition setRequestedProcedureID (const OFString &value, const OFBool check=OFTrue)
 set RequestedProcedureID (0040,1001)
OFCondition setScheduledProcedureStepDescription (const OFString &value, const OFBool check=OFTrue)
 set ScheduledProcedureStepDescription (0040,0007)
OFCondition setScheduledProcedureStepID (const OFString &value, const OFBool check=OFTrue)
 set ScheduledProcedureStepID (0040,0009)
OFCondition setStudyInstanceUID (const OFString &value, const OFBool check=OFTrue)
 set StudyInstanceUID (0020,000d)

Private Attributes

OFBool EmptyDefaultItem
 internal flag used to mark the empty default item
DcmShortString AccessionNumber
 AccessionNumber (0008,0050) vr=SH, vm=1, type=3.
DRTReasonForRequestedProcedureCodeSequence ReasonForRequestedProcedureCodeSequence
 ReasonForRequestedProcedureCodeSequence (0040,100a) vr=SQ, vm=1, type=3.
DcmLongString ReasonForTheRequestedProcedure
 ReasonForTheRequestedProcedure (0040,1002) vr=LO, vm=1, type=3.
DRTReferencedStudySequence ReferencedStudySequence
 ReferencedStudySequence (0008,1110) vr=SQ, vm=1, type=3.
DRTRequestedProcedureCodeSequence RequestedProcedureCodeSequence
 RequestedProcedureCodeSequence (0032,1064) vr=SQ, vm=1, type=3.
DcmLongString RequestedProcedureDescription
 RequestedProcedureDescription (0032,1060) vr=LO, vm=1, type=3.
DcmShortString RequestedProcedureID
 RequestedProcedureID (0040,1001) vr=SH, vm=1, type=1.
DcmLongString ScheduledProcedureStepDescription
 ScheduledProcedureStepDescription (0040,0007) vr=LO, vm=1, type=3.
DcmShortString ScheduledProcedureStepID
 ScheduledProcedureStepID (0040,0009) vr=SH, vm=1, type=1.
DRTScheduledProtocolCodeSequence ScheduledProtocolCodeSequence
 ScheduledProtocolCodeSequence (0040,0008) vr=SQ, vm=1, type=3.
DcmUniqueIdentifier StudyInstanceUID
 StudyInstanceUID (0020,000d) vr=UI, vm=1, type=3.

Detailed Description

Item class.


Constructor & Destructor Documentation

DRTRequestAttributesSequence::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

OFCondition DRTRequestAttributesSequence::Item::getAccessionNumber ( OFString value,
const signed long  pos = 0 
) const

get AccessionNumber (0008,0050)

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 ReasonForRequestedProcedureCodeSequence (0040,100a)

Returns:
reference to sequence element

get ReasonForRequestedProcedureCodeSequence (0040,100a)

Returns:
const reference to sequence element

get ReasonForTheRequestedProcedure (0040,1002)

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 ReferencedStudySequence (0008,1110)

Returns:
reference to sequence element

get ReferencedStudySequence (0008,1110)

Returns:
const reference to sequence element

get RequestedProcedureCodeSequence (0032,1064)

Returns:
reference to sequence element

get RequestedProcedureCodeSequence (0032,1064)

Returns:
const reference to sequence element

get RequestedProcedureDescription (0032,1060)

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

get RequestedProcedureID (0040,1001)

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 ScheduledProcedureStepDescription (0040,0007)

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

get ScheduledProcedureStepID (0040,0009)

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 ScheduledProtocolCodeSequence (0040,0008)

Returns:
reference to sequence element

get ScheduledProtocolCodeSequence (0040,0008)

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

get StudyInstanceUID (0020,000d)

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

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& DRTRequestAttributesSequence::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 DRTRequestAttributesSequence::Item::setAccessionNumber ( const OFString value,
const OFBool  check = OFTrue 
)

set AccessionNumber (0008,0050)

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

set ReasonForTheRequestedProcedure (0040,1002)

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

set RequestedProcedureDescription (0032,1060)

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

set RequestedProcedureID (0040,1001)

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

set ScheduledProcedureStepDescription (0040,0007)

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

set ScheduledProcedureStepID (0040,0009)

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

set StudyInstanceUID (0020,000d)

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 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