DCMTK  Version 3.6.1 20170228
OFFIS DICOM Toolkit
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | Private Attributes | List of all members
DRTBeamLimitingDeviceSequenceInRTBeamsModule::Item Class Reference

Item class. More...

+ Inheritance diagram for DRTBeamLimitingDeviceSequenceInRTBeamsModule::Item:

Public Member Functions

 Item (const OFBool emptyDefaultItem=OFFalse)
 (default) constructor More...
 
 Item (const Item &copy)
 copy constructor More...
 
virtual ~Item ()
 destructor
 
Itemoperator= (const Item &copy)
 assigment operator More...
 
void clear ()
 clear all internal member variables
 
OFBool isEmpty ()
 check if item is empty More...
 
OFBool isValid () const
 check if item is valid, i.e. not the empty default item More...
 
OFCondition read (DcmItem &item)
 read elements from sequence item More...
 
OFCondition write (DcmItem &item)
 write elements to sequence item More...
 
OFCondition getLeafPositionBoundaries (OFString &value, const signed long pos=0) const
 get LeafPositionBoundaries (300a,00be) More...
 
OFCondition getLeafPositionBoundaries (Float64 &value, const unsigned long pos=0) const
 get LeafPositionBoundaries (300a,00be) More...
 
OFCondition getLeafPositionBoundaries (OFVector< Float64 > &value) const
 get LeafPositionBoundaries (300a,00be) More...
 
OFCondition getNumberOfLeafJawPairs (OFString &value, const signed long pos=0) const
 get NumberOfLeafJawPairs (300a,00bc) More...
 
OFCondition getNumberOfLeafJawPairs (Sint32 &value, const unsigned long pos=0) const
 get NumberOfLeafJawPairs (300a,00bc) More...
 
OFCondition getRTBeamLimitingDeviceType (OFString &value, const signed long pos=0) const
 get RTBeamLimitingDeviceType (300a,00b8) More...
 
OFCondition getSourceToBeamLimitingDeviceDistance (OFString &value, const signed long pos=0) const
 get SourceToBeamLimitingDeviceDistance (300a,00ba) More...
 
OFCondition getSourceToBeamLimitingDeviceDistance (Float64 &value, const unsigned long pos=0) const
 get SourceToBeamLimitingDeviceDistance (300a,00ba) More...
 
OFCondition setLeafPositionBoundaries (const OFString &value, const OFBool check=OFTrue)
 set LeafPositionBoundaries (300a,00be) More...
 
OFCondition setNumberOfLeafJawPairs (const OFString &value, const OFBool check=OFTrue)
 set NumberOfLeafJawPairs (300a,00bc) More...
 
OFCondition setRTBeamLimitingDeviceType (const OFString &value, const OFBool check=OFTrue)
 set RTBeamLimitingDeviceType (300a,00b8) More...
 
OFCondition setSourceToBeamLimitingDeviceDistance (const OFString &value, const OFBool check=OFTrue)
 set SourceToBeamLimitingDeviceDistance (300a,00ba) More...
 

Private Attributes

OFBool EmptyDefaultItem
 internal flag used to mark the empty default item
 
DcmDecimalString LeafPositionBoundaries
 LeafPositionBoundaries (300a,00be) vr=DS, vm=3-n, type=2C.
 
DcmIntegerString NumberOfLeafJawPairs
 NumberOfLeafJawPairs (300a,00bc) vr=IS, vm=1, type=1.
 
DcmCodeString RTBeamLimitingDeviceType
 RTBeamLimitingDeviceType (300a,00b8) vr=CS, vm=1, type=1.
 
DcmDecimalString SourceToBeamLimitingDeviceDistance
 SourceToBeamLimitingDeviceDistance (300a,00ba) vr=DS, vm=1, type=3.
 

Additional Inherited Members

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

Detailed Description

Item class.

Constructor & Destructor Documentation

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

(default) constructor

Parameters
emptyDefaultItemflag used to mark the empty default item
DRTBeamLimitingDeviceSequenceInRTBeamsModule::Item::Item ( const Item copy)

copy constructor

Parameters
copyitem object to be copied

Member Function Documentation

OFCondition DRTBeamLimitingDeviceSequenceInRTBeamsModule::Item::getLeafPositionBoundaries ( OFString value,
const signed long  pos = 0 
) const

get LeafPositionBoundaries (300a,00be)

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

get LeafPositionBoundaries (300a,00be)

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 DRTBeamLimitingDeviceSequenceInRTBeamsModule::Item::getLeafPositionBoundaries ( OFVector< Float64 > &  value) const

get LeafPositionBoundaries (300a,00be)

Parameters
valuereference to variable in which the value(s) should be stored
Returns
status, EC_Normal if successful, an error code otherwise
OFCondition DRTBeamLimitingDeviceSequenceInRTBeamsModule::Item::getNumberOfLeafJawPairs ( OFString value,
const signed long  pos = 0 
) const

get NumberOfLeafJawPairs (300a,00bc)

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

get NumberOfLeafJawPairs (300a,00bc)

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

get RTBeamLimitingDeviceType (300a,00b8)

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

get SourceToBeamLimitingDeviceDistance (300a,00ba)

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

get SourceToBeamLimitingDeviceDistance (300a,00ba)

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
OFBool DRTBeamLimitingDeviceSequenceInRTBeamsModule::Item::isEmpty ( )

check if item is empty

Returns
OFTrue if item is empty, OFFalse otherwise
OFBool DRTBeamLimitingDeviceSequenceInRTBeamsModule::Item::isValid ( ) const

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

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

assigment operator

Parameters
copyitem object to be copied
Returns
reference to this object
OFCondition DRTBeamLimitingDeviceSequenceInRTBeamsModule::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
OFCondition DRTBeamLimitingDeviceSequenceInRTBeamsModule::Item::setLeafPositionBoundaries ( const OFString value,
const OFBool  check = OFTrue 
)

set LeafPositionBoundaries (300a,00be)

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

set NumberOfLeafJawPairs (300a,00bc)

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

set RTBeamLimitingDeviceType (300a,00b8)

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

set SourceToBeamLimitingDeviceDistance (300a,00ba)

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
OFCondition DRTBeamLimitingDeviceSequenceInRTBeamsModule::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 Tue Feb 28 2017 for DCMTK Version 3.6.1 20170228 by Doxygen 1.8.8