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

Item class. More...

+ Inheritance diagram for DRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModule::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 getBrachyApplicationSetupDose (OFString &value, const signed long pos=0) const
 get BrachyApplicationSetupDose (300a,00a4)
OFCondition getBrachyApplicationSetupDose (Float64 &value, const unsigned long pos=0) const
 get BrachyApplicationSetupDose (300a,00a4)
OFCondition getBrachyApplicationSetupDoseSpecificationPoint (OFString &value, const signed long pos=0) const
 get BrachyApplicationSetupDoseSpecificationPoint (300a,00a2)
OFCondition getBrachyApplicationSetupDoseSpecificationPoint (Float64 &value, const unsigned long pos=0) const
 get BrachyApplicationSetupDoseSpecificationPoint (300a,00a2)
OFCondition getBrachyApplicationSetupDoseSpecificationPoint (OFVector< Float64 > &value) const
 get BrachyApplicationSetupDoseSpecificationPoint (300a,00a2)
OFCondition getReferencedBrachyApplicationSetupNumber (OFString &value, const signed long pos=0) const
 get ReferencedBrachyApplicationSetupNumber (300c,000c)
OFCondition getReferencedBrachyApplicationSetupNumber (Sint32 &value, const unsigned long pos=0) const
 get ReferencedBrachyApplicationSetupNumber (300c,000c)
OFCondition setBrachyApplicationSetupDose (const OFString &value, const OFBool check=OFTrue)
 set BrachyApplicationSetupDose (300a,00a4)
OFCondition setBrachyApplicationSetupDoseSpecificationPoint (const OFString &value, const OFBool check=OFTrue)
 set BrachyApplicationSetupDoseSpecificationPoint (300a,00a2)
OFCondition setReferencedBrachyApplicationSetupNumber (const OFString &value, const OFBool check=OFTrue)
 set ReferencedBrachyApplicationSetupNumber (300c,000c)

Private Attributes

OFBool EmptyDefaultItem
 internal flag used to mark the empty default item
DcmDecimalString BrachyApplicationSetupDose
 BrachyApplicationSetupDose (300a,00a4) vr=DS, vm=1, type=3.
DcmDecimalString BrachyApplicationSetupDoseSpecificationPoint
 BrachyApplicationSetupDoseSpecificationPoint (300a,00a2) vr=DS, vm=3, type=3.
DcmIntegerString ReferencedBrachyApplicationSetupNumber
 ReferencedBrachyApplicationSetupNumber (300c,000c) vr=IS, vm=1, type=1C.

Detailed Description

Item class.


Constructor & Destructor Documentation

(default) constructor

Parameters:
emptyDefaultItemflag used to mark the empty default item

copy constructor

Parameters:
copyitem object to be copied

Member Function Documentation

get BrachyApplicationSetupDose (300a,00a4)

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 BrachyApplicationSetupDose (300a,00a4)

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

get BrachyApplicationSetupDoseSpecificationPoint (300a,00a2)

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 BrachyApplicationSetupDoseSpecificationPoint (300a,00a2)

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

get BrachyApplicationSetupDoseSpecificationPoint (300a,00a2)

Parameters:
valuereference to variable in which the value(s) should be stored
Returns:
status, EC_Normal if successful, an error code otherwise

get ReferencedBrachyApplicationSetupNumber (300c,000c)

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 ReferencedBrachyApplicationSetupNumber (300c,000c)

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& DRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModule::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

set BrachyApplicationSetupDose (300a,00a4)

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

set BrachyApplicationSetupDoseSpecificationPoint (300a,00a2)

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

set ReferencedBrachyApplicationSetupNumber (300c,000c)

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

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