DCMTK  Version 3.6.1 20150924
OFFIS DICOM Toolkit
Classes | Public Member Functions | Private Attributes | List of all members
ContentIdentificationMacro Class Reference

Content Identification Macro. More...

Classes

class  AlternateContentDescriptionItem
 Class repsenting an Alternate Content Description item. More...
 

Public Member Functions

 ContentIdentificationMacro ()
 Constructor.
 
 ContentIdentificationMacro (const ContentIdentificationMacro &rhs)
 Copy constructor. More...
 
ContentIdentificationMacrooperator= (const ContentIdentificationMacro &rhs)
 Assignment operator (deep copy) More...
 
virtual ~ContentIdentificationMacro ()
 Virtual destructor.
 
virtual IODRulesgetIODRules ()
 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 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 CodeSequenceMacrogetContentCreatorIdentificationCode ()
 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...
 

Private Attributes

DcmCodeString m_ContentLabel
 Content Label: (CS, VM 1, Type 1)
 
DcmLongString m_ContentDescription
 Content Description: (LO, VM1, 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.
 

Detailed Description

Content Identification Macro.

Constructor & Destructor Documentation

ContentIdentificationMacro::ContentIdentificationMacro ( const ContentIdentificationMacro rhs)

Copy constructor.

Parameters
rhsThe macro to copy from (deep copy)

Member Function Documentation

virtual OFCondition ContentIdentificationMacro::check ( const OFBool  quiet = OFFalse)
virtual

Check whether this component's data satisfies the underlying rules.

Parameters
quietIf 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).
Returns
EC_Normal if rules are satisfied, error otherwise
virtual OFVector<AlternateContentDescriptionItem*>& ContentIdentificationMacro::getAlternateContentDescription ( )
virtual

Get Alternate Content Description items.

Returns
Reference to the items
virtual CodeSequenceMacro& ContentIdentificationMacro::getContentCreatorIdentificationCode ( )
virtual

Get Content Creator Identification Code.

Returns
Reference to code
virtual OFCondition ContentIdentificationMacro::getContentCreatorName ( OFString value,
const signed long  pos = 0 
) const
virtual

Get Content Creator Name.

Parameters
valueVariable to store the result to
posIndex of the value to get (0..vm-1), -1 for all components
Returns
EC_Normal if value could be get, error otherwise
virtual OFCondition ContentIdentificationMacro::getContentDescription ( OFString value,
const signed long  pos = 0 
) const
virtual

Get Content Description.

Parameters
valueVariable to store the result to
posIndex of the value to get (0..vm-1), -1 for all components
Returns
EC_Normal if value could be get, error otherwise
virtual OFCondition ContentIdentificationMacro::getContentLabel ( OFString value,
const signed long  pos = 0 
) const
virtual

Get Content Label.

Parameters
valueVariable to store the result to
posIndex of the value to get (0..vm-1), -1 for all components
Returns
EC_Normal if value could be get, error otherwise
virtual OFCondition ContentIdentificationMacro::getInstanceNumber ( OFString value,
const signed long  pos = 0 
) const
virtual

Get Instance Number.

Parameters
valueVariable to store the result to
posIndex of the value to get (0..vm-1), -1 for all components
Returns
EC_Normal if value could be get, error otherwise
virtual IODRules& ContentIdentificationMacro::getIODRules ( )
virtual

Get rules for this data structure.

Returns
Reference to the rules
ContentIdentificationMacro& ContentIdentificationMacro::operator= ( const ContentIdentificationMacro rhs)

Assignment operator (deep copy)

Parameters
rhsThe macro to copy from
Returns
Reference to "this" object
virtual OFCondition ContentIdentificationMacro::read ( DcmItem source,
const OFBool  clearOldData = OFTrue 
)
virtual

Reads Content Identification Macro from given item.

Parameters
sourceThe item to read from
clearOldDataIf OFTrue, old data is cleared before reading, otherwise it is kept/overwritten
virtual OFCondition ContentIdentificationMacro::setContentCreatorName ( const OFString value,
const OFBool  checkValue = OFTrue 
)
virtual

Set Content Creator Name.

Parameters
valueValue to be set
checkValueIf OFTrue, value is checked for validity
Returns
EC_Normal if setting was successful, error otherwise
virtual OFCondition ContentIdentificationMacro::setContentDescription ( const OFString value,
const OFBool  checkValue = OFTrue 
)
virtual

Set Content Description.

Parameters
valueValue to be set
checkValueIf OFTrue, value is checked for validity
Returns
EC_Normal if setting was successful, error otherwise
virtual OFCondition ContentIdentificationMacro::setContentLabel ( const OFString value,
const OFBool  checkValue = OFTrue 
)
virtual

Set Content Label.

Parameters
valueValue to be set
checkValueIf OFTrue, value is checked for validity
Returns
EC_Normal if setting was successful, error otherwise
virtual OFCondition ContentIdentificationMacro::setInstanceNumber ( const OFString value,
const OFBool  checkValue = OFTrue 
)
virtual

Set Instance Number.

Parameters
valueValue to be set
checkValueIf OFTrue, value is checked for validity
Returns
EC_Normal if setting was successful, error otherwise
virtual OFCondition ContentIdentificationMacro::write ( DcmItem item)
virtual

Write Content Identification Macro to given item.

Parameters
itemThe item to write to
Returns
EC_Normal if successul, error otherwise

The documentation for this class was generated from the following file:


Generated on Sun Jan 31 2016 for DCMTK Version 3.6.1 20150924 by Doxygen 1.8.9.1