DCMTK
Version 3.6.1 20170228
OFFIS DICOM Toolkit
|
Content Identification Macro. More...
Classes | |
class | AlternateContentDescriptionItem |
Class representing an Alternate Content Description item. More... | |
Public Member Functions | |
ContentIdentificationMacro () | |
Constructor. | |
ContentIdentificationMacro (const OFString &instanceNumber, const OFString &contentLabel, const OFString &contentDescription, const OFString &contentCreatorName) | |
Constructor initializing basic data. More... | |
ContentIdentificationMacro (const ContentIdentificationMacro &rhs) | |
Copy constructor. More... | |
ContentIdentificationMacro & | operator= (const ContentIdentificationMacro &rhs) |
Assignment operator (deep copy) More... | |
virtual | ~ContentIdentificationMacro () |
Virtual destructor. | |
virtual IODRules & | getIODRules () |
Get rules for this data structure. More... | |
virtual void | clearData () |
Clear (removes) all attributes handled by the modules of this component. | |
virtual void | resetRules () |
Resets rules to their original values. | |
virtual OFString | getName () const |
Get name of macro. More... | |
virtual OFCondition | check (const OFBool quiet=OFFalse) |
Check whether this component's data satisfies the underlying rules. More... | |
virtual OFCondition | getInstanceNumber (OFString &value, const signed long pos=0) const |
Get Instance Number. More... | |
virtual OFCondition | getContentLabel (OFString &value, const signed long pos=0) const |
Get Content Label. More... | |
virtual OFCondition | getContentDescription (OFString &value, const signed long pos=0) const |
Get Content Description. More... | |
virtual OFVector < AlternateContentDescriptionItem * > & | getAlternateContentDescription () |
Get Alternate Content Description items. More... | |
virtual OFCondition | getContentCreatorName (OFString &value, const signed long pos=0) const |
Get Content Creator Name. More... | |
virtual CodeSequenceMacro & | getContentCreatorIdentificationCode () |
Get Content Creator Identification Code. More... | |
virtual OFCondition | setInstanceNumber (const OFString &value, const OFBool checkValue=OFTrue) |
Set Instance Number. More... | |
virtual OFCondition | setContentLabel (const OFString &value, const OFBool checkValue=OFTrue) |
Set Content Label. More... | |
virtual OFCondition | setContentDescription (const OFString &value, const OFBool checkValue=OFTrue) |
Set Content Description. More... | |
virtual OFCondition | setContentCreatorName (const OFString &value, const OFBool checkValue=OFTrue) |
Set Content Creator Name. More... | |
virtual OFCondition | read (DcmItem &source, const OFBool clearOldData=OFTrue) |
Reads Content Identification Macro from given item. More... | |
virtual OFCondition | write (DcmItem &item) |
Write Content Identification Macro to given item. More... | |
Static Public Member Functions | |
static OFCondition | create (const OFString &instanceNumber, const OFString &contentLabel, const OFString &contentDescription, const OFString &contentCreatorName, ContentIdentificationMacro *&result) |
Create Content Identification Macro with minimally required data. More... | |
Private Attributes | |
DcmCodeString | m_ContentLabel |
Content Label: (CS, VM 1, Type 1) | |
DcmLongString | m_ContentDescription |
Content Description: (LO, VM 1, Type 1) | |
DcmPersonName | m_ContentCreatorName |
Content Creator's Name: (LO, VM 1, Type 2) | |
CodeSequenceMacro | m_ContentCreatorIdentificationCode |
Content Creator's Identification Code Sequence. | |
IODRules | m_IODRules |
IOD rules for this data structure. | |
Content Identification Macro.
ContentIdentificationMacro::ContentIdentificationMacro | ( | const OFString & | instanceNumber, |
const OFString & | contentLabel, | ||
const OFString & | contentDescription, | ||
const OFString & | contentCreatorName | ||
) |
Constructor initializing basic data.
instanceNumber | Instance Number |
contentLabel | Content Label |
contentDescription | Content Description, may be empty |
contentCreatorName | Content Creator's Name, may be empty |
ContentIdentificationMacro::ContentIdentificationMacro | ( | const ContentIdentificationMacro & | rhs | ) |
Copy constructor.
rhs | The macro to copy from (deep copy) |
|
virtual |
Check whether this component's data satisfies the underlying rules.
quiet | If OFTrue, not error / warning messages will be produced. Only the returned error code will indicate error or OK. Per default, logging output is produced (OFFalse). |
|
static |
Create Content Identification Macro with minimally required data.
instanceNumber | Instance Number |
contentLabel | Content Label |
contentDescription | Content Description, may be empty |
contentCreatorName | Content Creator's Name, may be empty |
result | Returns created macro if successful, NULL otherwise |
|
virtual |
Get Alternate Content Description items.
|
virtual |
Get Content Creator Identification Code.
|
virtual |
Get Content Creator Name.
value | Variable to store the result to |
pos | Index of the value to get (0..vm-1), -1 for all components |
|
virtual |
Get Content Description.
value | Variable to store the result to |
pos | Index of the value to get (0..vm-1), -1 for all components |
|
virtual |
Get Content Label.
value | Variable to store the result to |
pos | Index of the value to get (0..vm-1), -1 for all components |
|
virtual |
Get Instance Number.
value | Variable to store the result to |
pos | Index of the value to get (0..vm-1), -1 for all components |
|
virtual |
Get rules for this data structure.
|
virtual |
Get name of macro.
ContentIdentificationMacro& ContentIdentificationMacro::operator= | ( | const ContentIdentificationMacro & | rhs | ) |
Assignment operator (deep copy)
rhs | The macro to copy from |
|
virtual |
Reads Content Identification Macro from given item.
source | The item to read from |
clearOldData | If OFTrue, old data is cleared before reading, otherwise it is kept/overwritten |
|
virtual |
Set Content Creator Name.
value | Value to be set |
checkValue | If OFTrue, value is checked for validity |
|
virtual |
Set Content Description.
value | Value to be set |
checkValue | If OFTrue, value is checked for validity |
|
virtual |
Set Content Label.
value | Value to be set |
checkValue | If OFTrue, value is checked for validity |
|
virtual |
Set Instance Number.
value | Value to be set |
checkValue | If OFTrue, value is checked for validity |
|
virtual |
Write Content Identification Macro to given item.
item | The item to write to |