DCMTK  Version 3.6.2
OFFIS DICOM Toolkit
Public Member Functions | List of all members
CodeSequenceMacro Class Reference

Class representing a Code Sequence Macro. More...

+ Inheritance diagram for CodeSequenceMacro:

Public Member Functions

 CodeSequenceMacro (OFshared_ptr< DcmItem > item, OFshared_ptr< IODRules > rules, IODComponent *parent=NULL)
 Constructor. More...
 
 CodeSequenceMacro (IODComponent *parent=NULL)
 Constructor. More...
 
 CodeSequenceMacro (const CodeSequenceMacro &rhs)
 Copy Constructor, performs deep copy. More...
 
 CodeSequenceMacro (OFshared_ptr< DcmItem > item, OFshared_ptr< IODRules > rules, IODComponent *parent, const OFString &codeValue, const OFString &codingSchemeDesignator, const OFString &codeMeaning, const OFString &codingSchemeVersion="")
 Convenience constructor to set initial values. More...
 
 CodeSequenceMacro (const OFString &codeValue, const OFString &codingSchemeDesignator, const OFString &codeMeaning, const OFString &codingSchemeVersion="", IODComponent *parent=NULL)
 Convenience constructor to set initial values. More...
 
virtual void resetRules ()
 Resets rules to their original values.
 
virtual OFString getName () const
 Get name of macro. More...
 
virtual ~CodeSequenceMacro ()
 Virtual Destructor.
 
virtual OFCondition getCodeValue (OFString &value, const signed long pos=0)
 Get Code Value. More...
 
virtual OFCondition getCodingSchemeDesignator (OFString &value, const signed long pos=0)
 Get Coding Scheme Designator. More...
 
virtual OFCondition getCodingSchemeVersion (OFString &value, const signed long pos=0)
 Get Coding Scheme Version. More...
 
virtual OFCondition getCodeMeaning (OFString &value, const signed long pos=0)
 Get Code Meaning. More...
 
virtual OFBool empty ()
 Returns whether code is empty, i.e. More...
 
virtual OFCondition setCodeValue (const OFString &value, const OFBool checkValue=OFTrue)
 Set Code Value. More...
 
virtual OFCondition setCodingSchemeDesignator (const OFString &value, const OFBool checkValue=OFTrue)
 Set Coding Scheme Designator. More...
 
virtual OFCondition setCodingSchemeVersion (const OFString &value, const OFBool checkValue=OFTrue)
 Set Coding Scheme Version. More...
 
virtual OFCondition setCodeMeaning (const OFString &value, const OFBool checkValue=OFTrue)
 Set Code Meaning. More...
 
virtual OFCondition set (const OFString &value, const OFString &scheme, const OFString &meaning, const OFString &schemeVersion="", const OFBool checkValue=OFTrue)
 Set all values in this class conveniently. More...
 
- Public Member Functions inherited from IODComponent
 IODComponent (OFshared_ptr< DcmItem > item, OFshared_ptr< IODRules > rules, IODComponent *parent=NULL)
 Constructor. More...
 
 IODComponent (IODComponent *parent=NULL)
 Constructor, creates rules and item from scratch. More...
 
IODComponentoperator= (const IODComponent &rhs)
 Assignment operator, copies contained item and rule set from rhs to "this" attribute set. More...
 
 IODComponent (const IODComponent &rhs)
 Copy constructor, copies reference to contained item and rule set to "this" attribute set. More...
 
virtual ~IODComponent ()
 Virtual Destructor.
 
void clearData ()
 Clear all attributes from the data that are handled by this module. More...
 
virtual void inventMissing ()
 Set missing values by inventing "default values". More...
 
OFshared_ptr< IODRulesgetRules ()
 Get rules handled by this module. More...
 
virtual void makeOptional ()
 Make component optional by turning all attributes requirement types of it to type 3. More...
 
DcmItemgetData ()
 Get the data handled by this module. More...
 
virtual OFCondition read (DcmItem &source, const OFBool clearOldData=OFTrue)
 Read attributes from given item into this class. More...
 
virtual OFCondition write (DcmItem &destination)
 Write attributes from this class into given item. More...
 
virtual OFCondition check (const OFBool quiet=OFFalse)
 Check whether this component's data satisfies the underlying rules. More...
 
virtual int compare (const IODComponent &rhs) const
 Comparison operator for IOD Components. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from IODComponent
static OFCondition read (DcmItem &source, IODRules &rules, DcmItem &destination, const OFString &componentName)
 Static helper function that reads attributes from given item into destination item, as determined by the provided rules and component name. More...
 
static OFCondition write (DcmItem &source, IODRules &rules, DcmItem &destination, const OFString &componentName)
 Static helper function that writes attributes from given item into destination item, as determined by the provided rules and component name. More...
 
- Protected Attributes inherited from IODComponent
OFshared_ptr< DcmItemm_Item
 Shared pointer to the data handled by this class. More...
 
OFshared_ptr< IODRulesm_Rules
 Rules describing the attributes governed by this class.
 
IODComponentm_Parent
 The parent component (may be NULL) of this class.
 

Detailed Description

Class representing a Code Sequence Macro.

Constructor & Destructor Documentation

◆ CodeSequenceMacro() [1/5]

CodeSequenceMacro::CodeSequenceMacro ( OFshared_ptr< DcmItem item,
OFshared_ptr< IODRules rules,
IODComponent parent = NULL 
)

Constructor.

Parameters
itemThe item to be used for data storage. If NULL, the class creates an empty data container.
rulesThe rule set for this class. If NULL, the class creates one from scratch and adds its values.
parentThe parent of the IOD component (NULL if none or unknown)

◆ CodeSequenceMacro() [2/5]

CodeSequenceMacro::CodeSequenceMacro ( IODComponent parent = NULL)

Constructor.

Parameters
parentThe parent of the IOD component (NULL if none or unknown)

◆ CodeSequenceMacro() [3/5]

CodeSequenceMacro::CodeSequenceMacro ( const CodeSequenceMacro rhs)

Copy Constructor, performs deep copy.

Parameters
rhsThe parent of the IOD component (NULL if none or unknown)

◆ CodeSequenceMacro() [4/5]

CodeSequenceMacro::CodeSequenceMacro ( OFshared_ptr< DcmItem item,
OFshared_ptr< IODRules rules,
IODComponent parent,
const OFString codeValue,
const OFString codingSchemeDesignator,
const OFString codeMeaning,
const OFString codingSchemeVersion = "" 
)

Convenience constructor to set initial values.

Parameters
itemThe item to be used for data storage. If NULL, the class creates an empty data container.
rulesThe rule set for this class. If NULL, the class creates one from scratch and adds its values.
parentThe parent of the IOD component (NULL if none or unknown)
codeValueThe code value
codingSchemeDesignatorThe coding scheme designator
codeMeaningThe code meaning
codingSchemeVersionThe coding scheme version (might be empty if coding scheme is unique)

◆ CodeSequenceMacro() [5/5]

CodeSequenceMacro::CodeSequenceMacro ( const OFString codeValue,
const OFString codingSchemeDesignator,
const OFString codeMeaning,
const OFString codingSchemeVersion = "",
IODComponent parent = NULL 
)

Convenience constructor to set initial values.

Parameters
codeValueThe code value
codingSchemeDesignatorThe coding scheme designator
codeMeaningThe code meaning
codingSchemeVersionThe coding scheme version (might be empty if coding scheme is unique)
parentThe parent of the IOD component (NULL if none or unknown)

Member Function Documentation

◆ empty()

virtual OFBool CodeSequenceMacro::empty ( )
virtual

Returns whether code is empty, i.e.

no component of the Code Sequence Macro is set. This can be used in order to find out whether someone actually wanted to fill in a valid code as opposed of leaving it unset.

Returns
OFTrue if no component of this class is set, OFFalse otherwise.

◆ getCodeMeaning()

virtual OFCondition CodeSequenceMacro::getCodeMeaning ( OFString value,
const signed long  pos = 0 
)
virtual

Get Code Meaning.

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
EC_Normal if successful, an error code otherwise

◆ getCodeValue()

virtual OFCondition CodeSequenceMacro::getCodeValue ( OFString value,
const signed long  pos = 0 
)
virtual

Get Code Value.

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
EC_Normal if successful, an error code otherwise

◆ getCodingSchemeDesignator()

virtual OFCondition CodeSequenceMacro::getCodingSchemeDesignator ( OFString value,
const signed long  pos = 0 
)
virtual

Get Coding Scheme Designator.

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
EC_Normal if successful, an error code otherwise

◆ getCodingSchemeVersion()

virtual OFCondition CodeSequenceMacro::getCodingSchemeVersion ( OFString value,
const signed long  pos = 0 
)
virtual

Get Coding Scheme Version.

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
EC_Normal if successful, an error code otherwise

◆ getName()

virtual OFString CodeSequenceMacro::getName ( ) const
virtual

Get name of macro.

Returns
Name of the component ("CodeSequenceMacro")

Implements IODComponent.

Reimplemented in CodeWithModifiers.

Referenced by CodeWithModifiers::getRules().

◆ set()

virtual OFCondition CodeSequenceMacro::set ( const OFString value,
const OFString scheme,
const OFString meaning,
const OFString schemeVersion = "",
const OFBool  checkValue = OFTrue 
)
virtual

Set all values in this class conveniently.

Parameters
valueCode Value to set
schemeCoding Scheme Designator to set
meaningCode Meaning to set
schemeVersionThe Coding Scheme Designator version to set (optional)
checkValueIf OFTrue, VM and VR of values is checked
Returns
EC_Normal if setting was successful, error otherwise

◆ setCodeMeaning()

virtual OFCondition CodeSequenceMacro::setCodeMeaning ( const OFString value,
const OFBool  checkValue = OFTrue 
)
virtual

Set Code Meaning.

Parameters
valueThe value to set
checkValueIf OFTrue, VM and VR of value are checked
Returns
EC_Normal if setting was successful, error otherwise

◆ setCodeValue()

virtual OFCondition CodeSequenceMacro::setCodeValue ( const OFString value,
const OFBool  checkValue = OFTrue 
)
virtual

Set Code Value.

Parameters
valueThe value to set
checkValueIf OFTrue, VM and VR of value are checked
Returns
EC_Normal if setting was successful, error otherwise

◆ setCodingSchemeDesignator()

virtual OFCondition CodeSequenceMacro::setCodingSchemeDesignator ( const OFString value,
const OFBool  checkValue = OFTrue 
)
virtual

Set Coding Scheme Designator.

Parameters
valueThe value to set
checkValueIf OFTrue, VM and VR of value are checked
Returns
EC_Normal if setting was successful, error otherwise

◆ setCodingSchemeVersion()

virtual OFCondition CodeSequenceMacro::setCodingSchemeVersion ( const OFString value,
const OFBool  checkValue = OFTrue 
)
virtual

Set Coding Scheme Version.

Parameters
valueThe value to set
checkValueIf OFTrue, VM and VR of value are checked
Returns
EC_Normal if setting was successful, error otherwise

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


Generated on Mon Jul 17 2017 for DCMTK Version 3.6.2 by Doxygen 1.8.13