DCMTK
Version 3.6.1 20170228
OFFIS DICOM Toolkit
|
Class representing a single rule, that refers to a single attribute. More...
Public Member Functions | |
IODRule (const DcmTagKey &key, const OFString &VM, const OFString &type, const OFString &module, const DcmIODTypes::IOD_IE ie, const OFString &defaultValue="", const OFString &privateCreator="") | |
Constructor to create a new attribute rule. More... | |
IODRule * | clone () |
Return deep copy of this object. More... | |
virtual DcmTagKey | getTagKey () const |
Get tag key of the attribute rule. More... | |
virtual OFString | getPrivateCreator () const |
Get private creator of the related attribute. More... | |
virtual OFString | getType () const |
The requirement type of the attribute (1, 1C, 2, 2C or 3) More... | |
virtual OFString | getVM () const |
The VM of the attribute as noted in the DICOM standard part 6, e.g. "1-n" or "2". More... | |
virtual OFString | getModule () const |
Get module (or component name) the related attribute belongs to. More... | |
virtual OFString | getDefaultValue () const |
Get default value of this attribute. More... | |
virtual DcmIODTypes::IOD_IE | getIE () const |
Get Information Entity the related attribute belongs to. More... | |
virtual OFCondition | check (DcmItem &item, const OFBool quiet=OFFalse) |
Check whether the given item fulfills the requirements of this rule, i.e. the related attribute is checked within the given item. More... | |
virtual | ~IODRule () |
Virtual Destructor. | |
Private Member Functions | |
IODRule () | |
Private undefined default constructor. | |
IODRule (const IODRule &rhs) | |
Private undefined copy constructor. | |
Private Attributes | |
DcmTagKey | m_Key |
Tag key. | |
OFString | m_VM |
VM, see DcmElement::checkVM() for permitted values (e.g. "1-n") | |
OFString | m_Type |
Requirement type: 1, 1C, 2, 2C or 3. | |
OFString | m_Module |
Module (e.g. "PatientModule" or "component name", e.g. "CodeSequenceMacro". | |
DcmIODTypes::IOD_IE | m_IE |
The Information Entity the related attribute belongs to according to the DICOM Model of the Real World, e.g. "Patient" for the attribute "Patient Name". | |
OFString | m_DefaultValue |
Default value for attribute. | |
OFString | m_PrivateCreator |
Private Creator (if private attribute) | |
Class representing a single rule, that refers to a single attribute.
Each rule is uniquely identified by the attribute's tag key and includes information on the Value Multiplicity (VM) of the attribute, its type (1, 1C, 2,...), the module (e.g. "PatientModule") or structure (e.g. "CodeSequenceMacro") it belongs to, a default value and its private creator if it is a private attribute. On top, the Information Entity according to the DICOM Model of the Real World can be stored, e.g. "Patient" for the "PatientModule".
IODRule::IODRule | ( | const DcmTagKey & | key, |
const OFString & | VM, | ||
const OFString & | type, | ||
const OFString & | module, | ||
const DcmIODTypes::IOD_IE | ie, | ||
const OFString & | defaultValue = "" , |
||
const OFString & | privateCreator = "" |
||
) |
Constructor to create a new attribute rule.
key | The tag key of the attribute |
VM | The VM of the attribute (notation like in DICOM part 6, e.g. "1-n") |
type | The "IOD type" of the attribute. Allowed values "1", "1C", "2", "2C" and "3" |
module | The module or "component" this attribute belongs to |
ie | The Information Entity the module belongs to |
defaultValue | The default value (default: empty) |
privateCreator | The private creator of the attribute if attribute (default: No private creator) |
|
virtual |
Check whether the given item fulfills the requirements of this rule, i.e. the related attribute is checked within the given item.
item | The item to check the attribute in |
quiet | If OFTrue, no error or warning messages will be produced but only the return code will indicate OK or error. |
IODRule* IODRule::clone | ( | ) |
Return deep copy of this object.
|
virtual |
Get default value of this attribute.
|
virtual |
Get Information Entity the related attribute belongs to.
|
virtual |
Get module (or component name) the related attribute belongs to.
Referenced by DcmIODUtil::readSingleItem(), DcmIODUtil::readSubSequence(), DcmIODUtil::writeSingleItem(), and DcmIODUtil::writeSubSequence().
|
virtual |
Get private creator of the related attribute.
|
virtual |
Get tag key of the attribute rule.
Referenced by DcmIODUtil::writeSubSequence().
|
virtual |
The requirement type of the attribute (1, 1C, 2, 2C or 3)
Referenced by DcmIODUtil::readSingleItem(), DcmIODUtil::readSubSequence(), DcmIODUtil::writeSingleItem(), and DcmIODUtil::writeSubSequence().
|
virtual |
The VM of the attribute as noted in the DICOM standard part 6, e.g. "1-n" or "2".
Referenced by DcmIODUtil::readSubSequence(), and DcmIODUtil::writeSubSequence().