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

	IODGeneralEquipmentModule ()
	Constructor.

virtual	~IODGeneralEquipmentModule ()
	Destructor.

virtual void	resetRules ()
	Resets rules to their original values.

virtual OFString	getName () const
	Get name of module. More...

virtual OFCondition	getManufacturer (OFString &value, const signed long pos=0) const
	Get Manufacturer. More...

virtual OFCondition	getInstitutionName (OFString &value, const signed long pos=0) const
	Get Institution Name. More...

virtual OFCondition	getInstitutionAddress (OFString &value, const signed long pos=0) const
	Get Institution Address. More...

virtual OFCondition	getStationName (OFString &value, const signed long pos=0) const
	Get Station Name. More...

virtual OFCondition	getInstitutionalDepartmentName (OFString &value, const signed long pos=0) const
	Get Institutional Department Name. More...

virtual OFCondition	getManufacturerModelName (OFString &value, const signed long pos=0) const
	Get Manufacturer's Model Name. More...

virtual OFCondition	getDeviceSerialNumber (OFString &value, const signed long pos=0) const
	Get Device Serial Number. More...

virtual OFCondition	getSoftwareVersions (OFString &value, const signed long pos=0) const
	Get Software Version(s) More...

virtual OFCondition	setManufacturer (const OFString &value, const OFBool checkValue=OFTrue)
	Set Manufacturer. More...

virtual OFCondition	setInstitutionName (const OFString &value, const OFBool checkValue=OFTrue)
	Set Institution Name. More...

virtual OFCondition	setInstitutionAddress (const OFString &value, const OFBool checkValue=OFTrue)
	Set Institution Address. More...

virtual OFCondition	setStationName (const OFString &value, const OFBool checkValue=OFTrue)
	Set Station Name. More...

virtual OFCondition	setInstutionalDepartmentName (const OFString &value, const OFBool checkValue=OFTrue)
	Set Institutional Department Name. More...

virtual OFCondition	setManufacturerModelName (const OFString &value, const OFBool checkValue=OFTrue)
	Set Manufacturer's Model Name. More...

virtual OFCondition	setDeviceSerialNumber (const OFString &value, const OFBool checkValue=OFTrue)
	Set Device Serial Number. More...

virtual OFCondition	setSoftwareVersions (const OFString &value, const OFBool checkValue=OFTrue)
	Set Software Version(s) More...

Public Member Functions inherited from IODModule
	IODModule (OFshared_ptr< DcmItem > item, OFshared_ptr< IODRules > rules)
	Constructor. More...

	IODModule ()
	Constructor. More...

	IODModule (const IODModule &rhs)
	Copy constructor, creates shallow copy. More...

IODModule &	operator= (const IODModule &rhs)
	Assignment operator, creates shallow copy. More...

	~IODModule ()
	Desctructor.

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

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

Constructor & Destructor Documentation

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

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

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

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

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

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

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

virtual OFString IODGeneralEquipmentModule::getName ( ) const

virtual

Get name of module.

Returns: Name of the module ("GeneralEquipmentModule")

Implements IODComponent.

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

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

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

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

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

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

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

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

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

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

Member Function Documentation