Item class.
More...
|
| | Item (const OFBool emptyDefaultItem=OFFalse) |
| | (default) constructor
|
| |
| | Item (const Item ©) |
| | copy constructor
|
| |
|
virtual | ~Item () |
| | destructor
|
| |
| Item & | operator= (const Item ©) |
| | assignment 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 | getApplicatorApertureShape (OFString &value, const signed long pos=0) const |
| | get ApplicatorApertureShape (300a,0432)
|
| |
| OFCondition | getApplicatorOpening (Float32 &value, const unsigned long pos=0) const |
| | get ApplicatorOpening (300a,0433)
|
| |
| OFCondition | getApplicatorOpeningX (Float32 &value, const unsigned long pos=0) const |
| | get ApplicatorOpeningX (300a,0434)
|
| |
| OFCondition | getApplicatorOpeningY (Float32 &value, const unsigned long pos=0) const |
| | get ApplicatorOpeningY (300a,0435)
|
| |
| OFCondition | setApplicatorApertureShape (const OFString &value, const OFBool check=OFTrue) |
| | set ApplicatorApertureShape (300a,0432)
|
| |
| OFCondition | setApplicatorOpening (const Float32 value, const unsigned long pos=0) |
| | set ApplicatorOpening (300a,0433)
|
| |
| OFCondition | setApplicatorOpeningX (const Float32 value, const unsigned long pos=0) |
| | set ApplicatorOpeningX (300a,0434)
|
| |
| OFCondition | setApplicatorOpeningY (const Float32 value, const unsigned long pos=0) |
| | set ApplicatorOpeningY (300a,0435)
|
| |
|
|
OFBool | EmptyDefaultItem |
| | internal flag used to mark the empty default item
|
| |
|
DcmCodeString | ApplicatorApertureShape |
| | ApplicatorApertureShape (300a,0432) vr=CS, vm=1, type=1.
|
| |
|
DcmFloatingPointSingle | ApplicatorOpening |
| | ApplicatorOpening (300a,0433) vr=FL, vm=1, type=1C.
|
| |
|
DcmFloatingPointSingle | ApplicatorOpeningX |
| | ApplicatorOpeningX (300a,0434) vr=FL, vm=1, type=1C.
|
| |
|
DcmFloatingPointSingle | ApplicatorOpeningY |
| | ApplicatorOpeningY (300a,0435) vr=FL, vm=1, type=1C.
|
| |
|
| virtual | ~DRTTypes () |
| | destructor.
|
| |
| 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.
|
| |
| static OFCondition | getElementFromDataset (DcmItem &dataset, DcmElement &element) |
| | get element from dataset
|
| |
| static OFCondition | getStringValueFromElement (const DcmElement &element, OFString &stringValue, const signed long pos=0) |
| | get string value from element
|
| |
| static OFCondition | getStringValueFromDataset (DcmItem &dataset, const DcmTagKey &tagKey, OFString &stringValue) |
| | get string value from dataset
|
| |
| static OFCondition | putStringValueToDataset (DcmItem &dataset, const DcmTag &tag, const OFString &stringValue, const OFBool allowEmpty=OFTrue) |
| | put string value to dataset
|
| |
| 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
|
| |
| 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.
|
| |
| 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.
|
| |
◆ Item() [1/2]
| DRTApplicatorGeometrySequence::Item::Item |
( |
const OFBool | emptyDefaultItem = OFFalse | ) |
|
(default) constructor
- Parameters
-
| emptyDefaultItem | flag used to mark the empty default item |
Referenced by Item(), and operator=().
◆ Item() [2/2]
| DRTApplicatorGeometrySequence::Item::Item |
( |
const Item & | copy | ) |
|
copy constructor
- Parameters
-
| copy | item object to be copied |
References Item().
◆ getApplicatorApertureShape()
| OFCondition DRTApplicatorGeometrySequence::Item::getApplicatorApertureShape |
( |
OFString & | value, |
|
|
const signed long | pos = 0 ) const |
get ApplicatorApertureShape (300a,0432)
- Parameters
-
| value | reference to variable in which the value should be stored |
| pos | index of the value to get (0..vm-1), -1 for all components |
- Returns
- status, EC_Normal if successful, an error code otherwise
◆ getApplicatorOpening()
| OFCondition DRTApplicatorGeometrySequence::Item::getApplicatorOpening |
( |
Float32 & | value, |
|
|
const unsigned long | pos = 0 ) const |
get ApplicatorOpening (300a,0433)
- Parameters
-
| value | reference to variable in which the value should be stored |
| pos | index of the value to get (0..vm-1) |
- Returns
- status, EC_Normal if successful, an error code otherwise
◆ getApplicatorOpeningX()
| OFCondition DRTApplicatorGeometrySequence::Item::getApplicatorOpeningX |
( |
Float32 & | value, |
|
|
const unsigned long | pos = 0 ) const |
get ApplicatorOpeningX (300a,0434)
- Parameters
-
| value | reference to variable in which the value should be stored |
| pos | index of the value to get (0..vm-1) |
- Returns
- status, EC_Normal if successful, an error code otherwise
◆ getApplicatorOpeningY()
| OFCondition DRTApplicatorGeometrySequence::Item::getApplicatorOpeningY |
( |
Float32 & | value, |
|
|
const unsigned long | pos = 0 ) const |
get ApplicatorOpeningY (300a,0435)
- Parameters
-
| value | reference to variable in which the value should be stored |
| pos | index of the value to get (0..vm-1) |
- Returns
- status, EC_Normal if successful, an error code otherwise
◆ isEmpty()
| OFBool DRTApplicatorGeometrySequence::Item::isEmpty |
( |
| ) |
|
check if item is empty
- Returns
- OFTrue if item is empty, OFFalse otherwise
◆ isValid()
| OFBool DRTApplicatorGeometrySequence::Item::isValid |
( |
| ) |
const |
check if item is valid, i.e. not the empty default item
- Returns
- OFTrue if item is valid, OFFalse otherwise
◆ operator=()
| Item & DRTApplicatorGeometrySequence::Item::operator= |
( |
const Item & | copy | ) |
|
assignment operator
- Parameters
-
| copy | item object to be copied |
- Returns
- reference to this object
References Item().
◆ read()
read elements from sequence item
- Parameters
-
| item | reference to DICOM sequence item from which the elements should be read |
- Returns
- status, EC_Normal if successful, an error code otherwise
◆ setApplicatorApertureShape()
| OFCondition DRTApplicatorGeometrySequence::Item::setApplicatorApertureShape |
( |
const OFString & | value, |
|
|
const OFBool | check = OFTrue ) |
set ApplicatorApertureShape (300a,0432)
- Parameters
-
| value | value to be set (single value only) or "" for no value |
| check | check 'value' for conformance with VR (CS) and VM (1) if enabled |
- Returns
- status, EC_Normal if successful, an error code otherwise
◆ setApplicatorOpening()
| OFCondition DRTApplicatorGeometrySequence::Item::setApplicatorOpening |
( |
const Float32 | value, |
|
|
const unsigned long | pos = 0 ) |
set ApplicatorOpening (300a,0433)
- Parameters
-
| value | value to be set (should be valid for this VR) |
| pos | index of the value to be set (0..vm-1), vm=1 |
- Returns
- status, EC_Normal if successful, an error code otherwise
◆ setApplicatorOpeningX()
| OFCondition DRTApplicatorGeometrySequence::Item::setApplicatorOpeningX |
( |
const Float32 | value, |
|
|
const unsigned long | pos = 0 ) |
set ApplicatorOpeningX (300a,0434)
- Parameters
-
| value | value to be set (should be valid for this VR) |
| pos | index of the value to be set (0..vm-1), vm=1 |
- Returns
- status, EC_Normal if successful, an error code otherwise
◆ setApplicatorOpeningY()
| OFCondition DRTApplicatorGeometrySequence::Item::setApplicatorOpeningY |
( |
const Float32 | value, |
|
|
const unsigned long | pos = 0 ) |
set ApplicatorOpeningY (300a,0435)
- Parameters
-
| value | value to be set (should be valid for this VR) |
| pos | index of the value to be set (0..vm-1), vm=1 |
- Returns
- status, EC_Normal if successful, an error code otherwise
◆ write()
write elements to sequence item
- Parameters
-
| item | reference 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:
- dcmrt/include/dcmtk/dcmrt/seq/drtags.h