Class representing the General Equipment Module: More...

Inheritance diagram for IODGeneralEquipmentModule:

Classes
struct	EquipmentInfo
	Convenient struct containing commonly used equipment information (for use by external code). More...

Public Member Functions
	IODGeneralEquipmentModule (OFshared_ptr< DcmItem > item, OFshared_ptr< IODRules > rules)
	Constructor.
	IODGeneralEquipmentModule ()
	Constructor.
virtual	~IODGeneralEquipmentModule ()
	Destructor.
virtual void	resetRules ()
	Resets rules to their original values.
virtual OFString	getName () const
	Get name of module.
virtual OFCondition	getManufacturer (OFString &value, const signed long pos=0) const
	Get Manufacturer.
virtual OFCondition	getInstitutionName (OFString &value, const signed long pos=0) const
	Get Institution Name.
virtual OFCondition	getInstitutionAddress (OFString &value, const signed long pos=0) const
	Get Institution Address.
virtual OFCondition	getStationName (OFString &value, const signed long pos=0) const
	Get Station Name.
virtual OFCondition	getInstitutionalDepartmentName (OFString &value, const signed long pos=0) const
	Get Institutional Department Name.
virtual OFCondition	getManufacturerModelName (OFString &value, const signed long pos=0) const
	Get Manufacturer's Model Name.
virtual OFCondition	getDeviceSerialNumber (OFString &value, const signed long pos=0) const
	Get Device Serial Number.
virtual OFCondition	getSoftwareVersions (OFString &value, const signed long pos=0) const
	Get Software Version(s).
virtual OFCondition	getPixelPaddingValue (Uint16 &value, const unsigned long pos=0) const
	Get Pixel Padding Value.
virtual OFCondition	getPixelPaddingValue (Sint16 &value, const unsigned long pos=0) const
	Get Pixel Padding Value, signed (SS) interpretation.
virtual OFCondition	getPixelPaddingValueVR (DcmEVR &vr) const
	Get the Value Representation actually used to store Pixel Padding Value (0028,0120), which has VR "US or SS".
virtual OFBool	isPixelPaddingValueSigned () const
	Check whether Pixel Padding Value (0028,0120) is present and stored with a signed (SS) Value Representation.
virtual IODGeneralEquipmentModule::EquipmentInfo	getEquipmentInfo () const
	Get a copy altogether as EquipmentInfo.
virtual OFCondition	setManufacturer (const OFString &value, const OFBool checkValue=OFTrue)
	Set Manufacturer.
virtual OFCondition	setInstitutionName (const OFString &value, const OFBool checkValue=OFTrue)
	Set Institution Name.
virtual OFCondition	setInstitutionAddress (const OFString &value, const OFBool checkValue=OFTrue)
	Set Institution Address.
virtual OFCondition	setStationName (const OFString &value, const OFBool checkValue=OFTrue)
	Set Station Name.
virtual OFCondition	setInstutionalDepartmentName (const OFString &value, const OFBool checkValue=OFTrue)
	Set Institutional Department Name.
virtual OFCondition	setManufacturerModelName (const OFString &value, const OFBool checkValue=OFTrue)
	Set Manufacturer's Model Name.
virtual OFCondition	setDeviceSerialNumber (const OFString &value, const OFBool checkValue=OFTrue)
	Set Device Serial Number.
virtual OFCondition	setSoftwareVersions (const OFString &value, const OFBool checkValue=OFTrue)
	Set Software Version(s).
virtual OFCondition	setPixelPaddingValue (const Uint16 value, const OFBool checkValue=OFTrue)
	Set Pixel Padding Value.
virtual OFCondition	setPixelPaddingValue (const Sint16 value, const OFBool checkValue=OFTrue)
	Set Pixel Padding Value, signed (SS).
Public Member Functions inherited from IODModule
	IODModule (OFshared_ptr< DcmItem > item, OFshared_ptr< IODRules > rules)
	Constructor.
	IODModule ()
	Constructor.
	IODModule (const IODModule &rhs)
	Copy constructor, creates shallow copy.
IODModule &	operator= (const IODModule &rhs)
	Assignment operator, creates shallow copy.
	~IODModule ()
	Destructor.
Public Member Functions inherited from IODComponent
	IODComponent (OFshared_ptr< DcmItem > item, OFshared_ptr< IODRules > rules, IODComponent *parent=NULL)
	Constructor.
	IODComponent (IODComponent *parent=NULL)
	Constructor, creates rules and item from scratch.
IODComponent &	operator= (const IODComponent &rhs)
	Assignment operator, copies contained item and rule set from rhs to "this" attribute set.
	IODComponent (const IODComponent &rhs)
	Copy constructor, copies reference to contained item and rule set to "this" attribute set.
virtual	~IODComponent ()
	Virtual Destructor.
virtual void	clearData ()
	Clear all attributes from the data that are handled by this module.
virtual void	inventMissing ()
	Set missing values by inventing "default values".
OFshared_ptr< IODRules >	getRules ()
	Get rules handled by this module.
virtual void	makeOptional ()
	Make component optional by turning all attributes requirement types of it to type 3.
DcmItem &	getData ()
	Get the data handled by this module.
virtual OFCondition	read (DcmItem &source, const OFBool clearOldData=OFTrue)
	Read attributes from given item into this class.
virtual OFCondition	write (DcmItem &destination)
	Write attributes from this class into given item.
virtual OFCondition	check (const OFBool quiet=OFFalse)
	Check whether this component's data satisfies the underlying rules.
virtual int	compare (const IODComponent &rhs) const
	Comparison operator for IOD Components.
virtual bool	getValueCheckOnWrite () const
	Get whether attribute value errors will be handled as errors on writing.
virtual void	setValueCheckOnWrite (const OFBool checkValue)
	Set whether attribute values should be checked on writing, i.e.

Private Attributes
OFString	m_ModuleName
	Name of the module ("GeneralEquipmentModule").

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.
static OFCondition	write (DcmItem &source, IODRules &rules, DcmItem &destination, const OFString &componentName, const OFBool checkValue)
	Static helper function that writes attributes from given item into destination item, as determined by the provided rules and component name.
Protected Member Functions inherited from IODComponent
void	ensureOwnRules ()
	Ensure this instance has its own private, writable copy of m_Rules.
Protected Attributes inherited from IODComponent
OFshared_ptr< DcmItem >	m_Item
	Shared pointer to the data handled by this class.
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.
OFBool	m_HasOwnRules
	OFTrue if m_Rules is a private copy owned solely by this instance and safe to mutate in place.
OFBool	m_ExternalRules
	OFTrue if the rules container was supplied externally via the IODComponent(item, rules, parent) constructor (shared-container pattern used e.g.
OFBool	m_CheckValueOnWrite
	Denotes whether attribute values should be checked on writing, i.e.

Detailed Description

Class representing the General Equipment Module:

Manufacturer: (LO, 1, 2) Institution Name: (LO, 1, 3) Institution Address: (ST, 1, 3) Station Name: (SH, 1, 3) Institutional Department Name: (LO, 1, 3) Manufacturer's Model Name: (LO, 1, 3) Device Serial Number: (LO, 1, 3) Software Version(s): (LO, 1-n, 3) Pixel Padding Value: (US or SS, 1, 3)

Constructor & Destructor Documentation

◆ IODGeneralEquipmentModule()

IODGeneralEquipmentModule::IODGeneralEquipmentModule	(	OFshared_ptr< DcmItem >	item,
		OFshared_ptr< IODRules >	rules )

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.

Member Function Documentation

◆ getDeviceSerialNumber()

virtual OFCondition IODGeneralEquipmentModule::getDeviceSerialNumber	(	OFString &	value,
		const signed long	pos = 0 ) const

virtual

Get Device Serial Number.

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

◆ getEquipmentInfo()

virtual IODGeneralEquipmentModule::EquipmentInfo IODGeneralEquipmentModule::getEquipmentInfo ( ) const

virtual

Get a copy altogether as EquipmentInfo.

Returns: EquipmentInfo object containing all relevant information If some data is not available, it will contain an empty string

◆ getInstitutionAddress()

virtual OFCondition IODGeneralEquipmentModule::getInstitutionAddress	(	OFString &	value,
		const signed long	pos = 0 ) const

virtual

Get Institution Address.

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

◆ getInstitutionalDepartmentName()

virtual OFCondition IODGeneralEquipmentModule::getInstitutionalDepartmentName	(	OFString &	value,
		const signed long	pos = 0 ) const

virtual

Get Institutional Department Name.

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

◆ getInstitutionName()

virtual OFCondition IODGeneralEquipmentModule::getInstitutionName	(	OFString &	value,
		const signed long	pos = 0 ) const

virtual

Get Institution Name.

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

◆ getManufacturer()

virtual OFCondition IODGeneralEquipmentModule::getManufacturer	(	OFString &	value,
		const signed long	pos = 0 ) const

virtual

Get Manufacturer.

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

◆ getManufacturerModelName()

virtual OFCondition IODGeneralEquipmentModule::getManufacturerModelName	(	OFString &	value,
		const signed long	pos = 0 ) const

virtual

Get Manufacturer's Model Name.

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 IODGeneralEquipmentModule::getName ( ) const

virtual

Get name of module.

Returns: Name of the module ("GeneralEquipmentModule")

Implements IODComponent.

◆ getPixelPaddingValue() [1/2]

virtual OFCondition IODGeneralEquipmentModule::getPixelPaddingValue	(	Sint16 &	value,
		const unsigned long	pos = 0 ) const

virtual

Get Pixel Padding Value, signed (SS) interpretation.

Note: Use this overload when Pixel Representation (0028,0103) is 1, i.e.\ the pixel data is signed. For unsigned data use the Uint16 overload.

Parameters

value	Reference to variable in which the value should be stored
pos	Index of the value to get (0..vm-1)

Returns: EC_Normal if successful, an error code otherwise

◆ getPixelPaddingValue() [2/2]

virtual OFCondition IODGeneralEquipmentModule::getPixelPaddingValue	(	Uint16 &	value,
		const unsigned long	pos = 0 ) const

virtual

Get Pixel Padding Value.

Note: Pixel Padding Value (0028,0120) has VR "US or SS"; the value representation depends on Pixel Representation (0028,0103). This method returns the unsigned (US) interpretation, which is the correct one whenever Pixel Representation is 0 (e.g. for Segmentation objects). For signed data, retrieve the element directly instead.

Parameters

value	Reference to variable in which the value should be stored
pos	Index of the value to get (0..vm-1)

Returns: EC_Normal if successful, an error code otherwise

◆ getPixelPaddingValueVR()

virtual OFCondition IODGeneralEquipmentModule::getPixelPaddingValueVR ( DcmEVR & vr ) const

virtual

Get the Value Representation actually used to store Pixel Padding Value (0028,0120), which has VR "US or SS".

This lets a caller decide which getPixelPaddingValue() overload applies to a value read from a dataset, rather than probing both.

Parameters

vr	Returns the VR of the stored element (EVR_US or EVR_SS) if Pixel Padding Value is present

Returns: EC_Normal if Pixel Padding Value is present, an error code (e.g.\ EC_TagNotFound) otherwise

◆ getSoftwareVersions()

virtual OFCondition IODGeneralEquipmentModule::getSoftwareVersions	(	OFString &	value,
		const signed long	pos = 0 ) const

virtual

Get Software Version(s).

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

◆ getStationName()

virtual OFCondition IODGeneralEquipmentModule::getStationName	(	OFString &	value,
		const signed long	pos = 0 ) const

virtual

Get Station Name.

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

◆ isPixelPaddingValueSigned()

virtual OFBool IODGeneralEquipmentModule::isPixelPaddingValueSigned ( ) const

virtual

Check whether Pixel Padding Value (0028,0120) is present and stored with a signed (SS) Value Representation.

Convenience wrapper around getPixelPaddingValueVR().

Returns: OFTrue if Pixel Padding Value is present and signed (SS); OFFalse if it is absent or unsigned (US)

◆ setDeviceSerialNumber()

virtual OFCondition IODGeneralEquipmentModule::setDeviceSerialNumber	(	const OFString &	value,
		const OFBool	checkValue = OFTrue )

virtual

Set Device Serial Number.

Parameters

value	Value to be set (single value only) or "" for no value
checkValue	Check 'value' for conformance with VR (LO) and VM (1) if enabled

Returns: EC_Normal if successful, an error code otherwise

◆ setInstitutionAddress()

virtual OFCondition IODGeneralEquipmentModule::setInstitutionAddress	(	const OFString &	value,
		const OFBool	checkValue = OFTrue )

virtual

Set Institution Address.

Parameters

value	Value to be set (single value only) or "" for no value
checkValue	Check 'value'. Not evaluated (here for consistency with other setter functions).

Returns: EC_Normal if successful, an error code otherwise

◆ setInstitutionName()

virtual OFCondition IODGeneralEquipmentModule::setInstitutionName	(	const OFString &	value,
		const OFBool	checkValue = OFTrue )

virtual

Set Institution Name.

Parameters

value	Value to be set (single value only) or "" for no value
checkValue	Check 'value' for conformance with VR (LO) and VM (1) if enabled

Returns: EC_Normal if successful, an error code otherwise

◆ setInstutionalDepartmentName()

virtual OFCondition IODGeneralEquipmentModule::setInstutionalDepartmentName	(	const OFString &	value,
		const OFBool	checkValue = OFTrue )

virtual

Set Institutional Department Name.

Parameters

value	Value to be set (single value only) or "" for no value
checkValue	Check 'value' for conformance with VR (LO) and VM (1) if enabled

Returns: EC_Normal if successful, an error code otherwise

◆ setManufacturer()

virtual OFCondition IODGeneralEquipmentModule::setManufacturer	(	const OFString &	value,
		const OFBool	checkValue = OFTrue )

virtual

Set Manufacturer.

Parameters

value	Value to be set (single value only) or "" for no value
checkValue	Check 'value' for conformance with VR (LO) and VM (1) if enabled

Returns: EC_Normal if successful, an error code otherwise

◆ setManufacturerModelName()

virtual OFCondition IODGeneralEquipmentModule::setManufacturerModelName	(	const OFString &	value,
		const OFBool	checkValue = OFTrue )

virtual

Set Manufacturer's Model Name.

Parameters

value	Value to be set (single value only) or "" for no value
checkValue	Check 'value' for conformance with VR (LO) and VM (1) if enabled

Returns: EC_Normal if successful, an error code otherwise

◆ setPixelPaddingValue() [1/2]

virtual OFCondition IODGeneralEquipmentModule::setPixelPaddingValue	(	const Sint16	value,
		const OFBool	checkValue = OFTrue )

virtual

Set Pixel Padding Value, signed (SS).

Note: Use this overload when Pixel Representation (0028,0103) is 1, i.e.\ the pixel data is signed; the value is stored with VR SS.

Parameters

value	Value to be set (single value only)
checkValue	Check 'value'. Not evaluated (here for consistency with other setter functions).

Returns: EC_Normal if successful, an error code otherwise

◆ setPixelPaddingValue() [2/2]

virtual OFCondition IODGeneralEquipmentModule::setPixelPaddingValue	(	const Uint16	value,
		const OFBool	checkValue = OFTrue )

virtual

Set Pixel Padding Value.

Note: Pixel Padding Value (0028,0120) has VR "US or SS". This method sets the value as US (unsigned), which is correct whenever Pixel Representation (0028,0103) is 0 (e.g. for Labelmap Segmentation objects).

Parameters

value	Value to be set (single value only)
checkValue	Check 'value'. Not evaluated (here for consistency with other setter functions).

Returns: EC_Normal if successful, an error code otherwise

◆ setSoftwareVersions()

virtual OFCondition IODGeneralEquipmentModule::setSoftwareVersions	(	const OFString &	value,
		const OFBool	checkValue = OFTrue )

virtual

Set Software Version(s).

Parameters

value	Value to be set (possibly multi-valued) or "" for no value
checkValue	Check 'value' for conformance with VR (LO) and VM (1-n) if enabled

Returns: EC_Normal if successful, an error code otherwise

◆ setStationName()

virtual OFCondition IODGeneralEquipmentModule::setStationName	(	const OFString &	value,
		const OFBool	checkValue = OFTrue )

virtual

Set Station Name.

Parameters

value	Value to be set (single value only) or "" for no value
checkValue	Check 'value' for conformance with VR (SH) and VM (1) if enabled

Returns: EC_Normal if successful, an error code otherwise

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

dcmiod/include/dcmtk/dcmiod/modequipment.h

Classes

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IODGeneralEquipmentModule()

Member Function Documentation

◆ getDeviceSerialNumber()

◆ getEquipmentInfo()

◆ getInstitutionAddress()

◆ getInstitutionalDepartmentName()

◆ getInstitutionName()

◆ getManufacturer()

◆ getManufacturerModelName()

◆ getName()

◆ getPixelPaddingValue() [1/2]

◆ getPixelPaddingValue() [2/2]

◆ getPixelPaddingValueVR()

◆ getSoftwareVersions()

◆ getStationName()

◆ isPixelPaddingValueSigned()

◆ setDeviceSerialNumber()

◆ setInstitutionAddress()

◆ setInstitutionName()

◆ setInstutionalDepartmentName()

◆ setManufacturer()

◆ setManufacturerModelName()

◆ setPixelPaddingValue() [1/2]

◆ setPixelPaddingValue() [2/2]

◆ setSoftwareVersions()

◆ setStationName()