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	check (const OFBool quiet=OFFalse)
	Check whether this component's data satisfies the underlying rules. More...

virtual OFCondition	getCodeValue (OFString &value, const signed long pos=0, const OFBool autoTag=OFTrue)
	Get Code Value, URL Code Value or Long Code Value. More...

virtual OFCondition	getURNCodeValue (OFString &value, const signed long pos=0)
	Get URN Code Value. More...

virtual OFCondition	getLongCodeValue (OFString &value, const signed long pos=0)
	Get Long 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, const OFBool autoTag=OFTrue)
	Set Code Value. More...

virtual OFCondition	setURNCodeValue (const OFString &value, const OFBool checkValue=OFTrue)
	Set URN Code Value. More...

virtual OFCondition	setLongCodeValue (const OFString &value, const OFBool checkValue=OFTrue)
	Set Long 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, const OFBool autoTag=OFTrue)
	Set all values in this class conveniently. More...

virtual OFString	toString ()
	Returns string representation reflecting the coded value. 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...

IODComponent &	operator= (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< IODRules >	getRules ()
	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...

DcmItem &	getData ()
	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 int	compare (const IODComponent &rhs) const
	Comparison operator for IOD Components. More...

Protected Member Functions
void	deleteUnusedCodeValues (const DcmTagKey &keepTag)
	Deletes all out of the the following list of tags: Code Value, Long Code Value and URN Code Value. 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< DcmItem >	m_Item
	Shared pointer to the data handled by this class. More...

OFshared_ptr< IODRules >	m_Rules
	Rules describing the attributes governed by this class.

IODComponent *	m_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

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

◆ CodeSequenceMacro() [2/5]

CodeSequenceMacro::CodeSequenceMacro ( IODComponent * parent = NULL )

Constructor.

Parameters

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

◆ CodeSequenceMacro() [3/5]

CodeSequenceMacro::CodeSequenceMacro ( const CodeSequenceMacro & rhs )

Copy Constructor, performs deep copy.

Parameters

rhs	The 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

item	The item to be used for data storage. If NULL, the class creates an empty data container.
rules	The rule set for this class. If NULL, the class creates one from scratch and adds its values.
parent	The parent of the IOD component (NULL if none or unknown)
codeValue	The code value
codingSchemeDesignator	The coding scheme designator
codeMeaning	The code meaning
codingSchemeVersion	The 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

codeValue	The code value
codingSchemeDesignator	The coding scheme designator
codeMeaning	The code meaning
codingSchemeVersion	The coding scheme version (might be empty if coding scheme is unique)
parent	The parent of the IOD component (NULL if none or unknown)

Member Function Documentation

◆ check()

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

virtual

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

In this case, it is only checked that Designator, Value and Meaning of the code are set.

Parameters

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).

Returns: EC_Normal if rules are satisfied, error otherwise

Reimplemented from IODComponent.

Reimplemented in CodeWithModifiers.

◆ deleteUnusedCodeValues()

void CodeSequenceMacro::deleteUnusedCodeValues ( const DcmTagKey & keepTag )

protected

Deletes all out of the the following list of tags: Code Value, Long Code Value and URN Code Value.

Parameters

keepTag The tag to be keep

◆ 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

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

◆ getCodeValue()

virtual OFCondition CodeSequenceMacro::getCodeValue	(	OFString &	value,
		const signed long	pos = `0`,
		const OFBool	autoTag = `OFTrue`
	)

virtual

Get Code Value, URL Code Value or Long Code Value.

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
autoTag	If OFTrue, this method will consider tags Code Value (0008,0100) URN Code Code Value (0008,0120) and Long Code Value (0008,0119) and in this order and will return once it finds that tag, even if the related value is empty. If OFFalse, getCodeValue() only returns the value found in Code Value (0008,0100).

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

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: 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

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

◆ getLongCodeValue()

virtual OFCondition CodeSequenceMacro::getLongCodeValue	(	OFString &	value,
		const signed long	pos = `0`
	)

virtual

Get Long Code Value.

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: 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.

◆ getURNCodeValue()

virtual OFCondition CodeSequenceMacro::getURNCodeValue	(	OFString &	value,
		const signed long	pos = `0`
	)

virtual

Get URN Code Value.

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

◆ set()

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

virtual

Set all values in this class conveniently.

Parameters

value	Code Value to set
scheme	Coding Scheme Designator to set
meaning	Code Meaning to set
schemeVersion	The Coding Scheme Designator version to set (optional)
checkValue	If OFTrue, VM and VR of values is checked
autoTag	If OFTrue, it is determined automatically if tag Code Value, URN Code Value or Long Code Value is used. If OFFalse, the classic Code Value is used. Default is OFTrue.

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

value	The value to set
checkValue	If 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`,
		const OFBool	autoTag = `OFTrue`
	)

virtual

Set Code Value.

Parameters

value	The value to set
checkValue	If OFTrue, VM and VR of value are checked
autoTag	If OFTrue, it is determined automatically if tag Code Value, URN Code Value or Long Code Value is used. If OFFalse, the classic Code Value is used. Default is OFTrue.

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

value	The value to set
checkValue	If 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

value	The value to set
checkValue	If OFTrue, VM and VR of value are checked

Returns: EC_Normal if setting was successful, error otherwise

◆ setLongCodeValue()

virtual OFCondition CodeSequenceMacro::setLongCodeValue	(	const OFString &	value,
		const OFBool	checkValue = `OFTrue`
	)

virtual

Set Long Code Value.

Parameters

value	The value to set
checkValue	If OFTrue, VM and VR of value are checked

Returns: EC_Normal if setting was successful, error otherwise

◆ setURNCodeValue()

virtual OFCondition CodeSequenceMacro::setURNCodeValue	(	const OFString &	value,
		const OFBool	checkValue = `OFTrue`
	)

virtual

Set URN Code Value.

Parameters

value	The value to set
checkValue	If OFTrue, VM and VR of value are checked

Returns: EC_Normal if setting was successful, error otherwise

◆ toString()

virtual OFString CodeSequenceMacro::toString ( )

virtual

Returns string representation reflecting the coded value.

Mostly useful for debugging purposes.

Returns: String representing the coded value

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

dcmiod/include/dcmtk/dcmiod/iodmacro.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CodeSequenceMacro() [1/5]

◆ CodeSequenceMacro() [2/5]

◆ CodeSequenceMacro() [3/5]

◆ CodeSequenceMacro() [4/5]

◆ CodeSequenceMacro() [5/5]

Member Function Documentation

◆ check()

◆ deleteUnusedCodeValues()

◆ empty()

◆ getCodeMeaning()

◆ getCodeValue()

◆ getCodingSchemeDesignator()

◆ getCodingSchemeVersion()

◆ getLongCodeValue()

◆ getName()

◆ getURNCodeValue()

◆ set()

◆ setCodeMeaning()

◆ setCodeValue()

◆ setCodingSchemeDesignator()

◆ setCodingSchemeVersion()

◆ setLongCodeValue()

◆ setURNCodeValue()

◆ toString()