Class representing the "Irradiation Event Identification" Functional Group Macro. More...

Inheritance diagram for FGIrradiationEventIdentification:

Public Member Functions
	FGIrradiationEventIdentification ()
	Constructor, creates empty functional group.

virtual	~FGIrradiationEventIdentification ()
	Virtual destructor.

virtual FGBase *	clone () const
	Returns a deep copy of this object. More...

virtual DcmFGTypes::E_FGSharedType	getSharedType () const
	Returns shared functional group type (always "per-frame") More...

virtual void	clearData ()
	Clear all data.

virtual OFCondition	check () const
	Check whether the current content of this group is consistent and complete. More...

virtual OFCondition	read (DcmItem &item)
	Read Frame Content Sequence from given item. More...

virtual OFCondition	write (DcmItem &item)
	Writes the content of this class into Frame Content Sequence (newly created) into given item. More...

virtual int	compare (const FGBase &rhs) const
	Comparison operator that compares the normalized value of this object with a given object of the same type, i.e. the elements within both functional groups (this and rhs parameter) are compared by value! Both objects (this and rhs) need to have the same type (i.e. both FGUnknown) to be comparable. More...

virtual OFCondition	getIrradiationEventUID (OFString &value, const signed long pos=0)
	Get Irradiation Event UID. More...

virtual OFCondition	setIrradiationEventUID (const OFString &value, const OFBool checkValue=OFTrue)
	Set Irradiation Event UID. More...

Public Member Functions inherited from FGBase
	FGBase (const DcmFGTypes::E_FGType fgType)
	Constructor, creates new functional group of given type. More...

virtual OFCondition	check () const =0
	Check whether functional group has valid and complete data. More...

virtual OFCondition	read (DcmItem &item)=0
	Read functional group from given item. More...

virtual OFCondition	write (DcmItem &item)=0
	Write functional group to given item. More...

virtual DcmFGTypes::E_FGSharedType	getSharedType () const =0
	Find out whether functional group is potentially only shared, only per-frame or can be both. More...

virtual DcmFGTypes::E_FGType	getType () const
	Return the type of this functional group. More...

virtual void	clearData ()=0
	Clear any data in the group.

virtual	~FGBase ()
	Virtual destructor.

virtual int	compare (const FGBase &rhs) const =0
	Comparison operator that compares the normalized value of this object with a given object of the same type, i.e. the elements within both functional groups (this and rhs parameter) are compared by value! Both objects (this and rhs) need to have the same type (e.g. both FGDerivationImage) to be comparable. More...

virtual FGBase *	clone () const =0
	Returns a deep copy of this object. More...

Private Attributes
DcmUniqueIdentifier	m_IrraditionEventUID
	Irradiation Event UID (UI, VM 1, Required type 1)

Additional Inherited Members
Protected Member Functions inherited from FGBase
virtual OFCondition	getItemFromFGSequence (DcmItem &source, const DcmTagKey &seqKey, const unsigned long itemNum, DcmItem *&result)
	Get the item containing the payload of a functional group sequence, identified by the functional group's sequence key provided and the desired item number. More...

virtual OFCondition	getNumItemsFromFGSequence (DcmItem &source, const DcmTagKey &seqKey, unsigned long &result)
	Get number of items in a functional group sequence, identified by the functional group's sequence key. More...

virtual OFCondition	createNewFGSequence (DcmItem &destination, const DcmTagKey &seqKey, const unsigned long numItems, DcmItem *&firstItem)
	Create functional group sequence specified by given sequence tag key. More...

Detailed Description

Class representing the "Irradiation Event Identification" Functional Group Macro.

Member Function Documentation

◆ check()

virtual OFCondition FGIrradiationEventIdentification::check ( ) const

virtual

Check whether the current content of this group is consistent and complete.

Returns: EC_Normal, if no errors are found, error otherwise

Implements FGBase.

◆ clone()

virtual FGBase * FGIrradiationEventIdentification::clone ( ) const

virtual

Returns a deep copy of this object.

Returns: Deep copy of this object

Implements FGBase.

◆ compare()

virtual int FGIrradiationEventIdentification::compare ( const FGBase & rhs ) const

virtual

Comparison operator that compares the normalized value of this object with a given object of the same type, i.e. the elements within both functional groups (this and rhs parameter) are compared by value! Both objects (this and rhs) need to have the same type (i.e. both FGUnknown) to be comparable.

This function is used in order to decide whether a functional group already exists, or is new. This is used in particular to find out whether a given functional group can be shared (i.e. the same information already exists as shared functional group) or is different from the same shared group. In that case the shared functional group must be distributed into per-frame functional groups, instead. The exact implementation for implementing the comparison is not relevant. However, it must be a comparison by value.

Parameters

rhs	the right hand side of the comparison

Returns: 0 if the object values are equal. -1 if either the value of the first component that does not match is lower in the this object, or all compared components match but this component is shorter. Also returned if this type and rhs type (DcmFGTypes::E_FGType) do not match. 1 if either the value of the first component that does not match is greater in this object, or all compared components match but this component is longer.

Implements FGBase.

◆ getIrradiationEventUID()

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

virtual

Get Irradiation Event UID.

Parameters

value	Reference to variable that should hold the result
pos	Index of the value to get (0..vm-1), -1 for all components

Returns: EC_Normal, if value could be returned, error otherwise

◆ getSharedType()

virtual DcmFGTypes::E_FGSharedType FGIrradiationEventIdentification::getSharedType ( ) const

inlinevirtual

Returns shared functional group type (always "per-frame")

Returns: The functional group type (DcmFGTypes::EFGS_ONLYPERFRAME)

Implements FGBase.

References DcmFGTypes::EFGS_BOTH.

◆ read()

virtual OFCondition FGIrradiationEventIdentification::read ( DcmItem & item )

virtual

Read Frame Content Sequence from given item.

Parameters

item	The item to read from

Returns: EC_Normal if reading was successful, error otherwise

Implements FGBase.

◆ setIrradiationEventUID()

virtual OFCondition FGIrradiationEventIdentification::setIrradiationEventUID	(	const OFString &	value,
		const OFBool	checkValue = `OFTrue`
	)

virtual

Set Irradiation Event UID.

Parameters

value	Value that should be set
checkValue	If OFTrue, basic checks are performed whether the value is valid for this attribute

Returns: EC_Normal, if value was set, error otherwise

◆ write()

virtual OFCondition FGIrradiationEventIdentification::write ( DcmItem & item )

virtual

Writes the content of this class into Frame Content Sequence (newly created) into given item.

Parameters

item	The item to write to

Returns: EC_Normal if writing was successful, error otherwise

Implements FGBase.

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

dcmfg/include/dcmtk/dcmfg/fgirradiationeventid.h

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ check()

◆ clone()

◆ compare()

◆ getIrradiationEventUID()

◆ getSharedType()

◆ read()

◆ setIrradiationEventUID()

◆ write()