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

Item class. More...

+ Inheritance diagram for DRTOverrideSequence::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 getOperatorsName (OFString &value, const signed long pos=0) const
 get OperatorsName (0008,1070)
OFCondition getOverrideParameterPointer (OFString &value, const signed long pos=0) const
 get OverrideParameterPointer (3008,0062)
OFCondition getOverrideReason (OFString &value, const signed long pos=0) const
 get OverrideReason (3008,0066)
OFCondition getParameterItemIndex (OFString &value, const signed long pos=0) const
 get ParameterItemIndex (3008,0063)
OFCondition getParameterItemIndex (Sint32 &value, const unsigned long pos=0) const
 get ParameterItemIndex (3008,0063)
OFCondition getParameterSequencePointer (OFString &value, const signed long pos=0) const
 get ParameterSequencePointer (3008,0061)
OFCondition setOperatorsName (const OFString &value, const OFBool check=OFTrue)
 set OperatorsName (0008,1070)
OFCondition setOverrideParameterPointer (const OFString &value, const OFBool check=OFTrue)
 set OverrideParameterPointer (3008,0062)
OFCondition setOverrideReason (const OFString &value, const OFBool check=OFTrue)
 set OverrideReason (3008,0066)
OFCondition setParameterItemIndex (const OFString &value, const OFBool check=OFTrue)
 set ParameterItemIndex (3008,0063)
OFCondition setParameterSequencePointer (const OFString &value, const OFBool check=OFTrue)
 set ParameterSequencePointer (3008,0061)

Private Attributes

OFBool EmptyDefaultItem
 internal flag used to mark the empty default item
DcmPersonName OperatorsName
 OperatorsName (0008,1070) vr=PN, vm=1-n, type=2.
DcmAttributeTag OverrideParameterPointer
 OverrideParameterPointer (3008,0062) vr=AT, vm=1, type=1.
DcmShortText OverrideReason
 OverrideReason (3008,0066) vr=ST, vm=1, type=3.
DcmIntegerString ParameterItemIndex
 ParameterItemIndex (3008,0063) vr=IS, vm=1, type=1.
DcmAttributeTag ParameterSequencePointer
 ParameterSequencePointer (3008,0061) vr=AT, vm=1, type=1.

Detailed Description

Item class.


Constructor & Destructor Documentation

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

get OperatorsName (0008,1070)

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

get OverrideParameterPointer (3008,0062)

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

get OverrideReason (3008,0066)

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

get ParameterItemIndex (3008,0063)

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

get ParameterItemIndex (3008,0063)

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

get ParameterSequencePointer (3008,0061)

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

set OperatorsName (0008,1070)

Parameters:
valuevalue to be set (possibly multi-valued) or "" for no value
checkcheck 'value' for conformance with VR (PN) and VM (1-n) if enabled
Returns:
status, EC_Normal if successful, an error code otherwise
OFCondition DRTOverrideSequence::Item::setOverrideParameterPointer ( const OFString value,
const OFBool  check = OFTrue 
)

set OverrideParameterPointer (3008,0062)

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

set OverrideReason (3008,0066)

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

set ParameterItemIndex (3008,0063)

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

set ParameterSequencePointer (3008,0061)

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