Class representing the Frame Anatomy Functional Group Macro. More...

Inheritance diagram for FGFrameAnatomy:

Public Types
enum	LATERALITY { LATERALITY_UNDEFINED , LATERALITY_INVALID , LATERALITY_R , LATERALITY_L , LATERALITY_UNPAIRED , LATERALITY_BOTH }
	Enumerated values for attribute "Laterality". More...

Public Member Functions
	FGFrameAnatomy ()
	Constructor, creates empty Frame Anatomy Functional Group.

virtual	~FGFrameAnatomy ()
	Virtual destructor, frees memory.

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

virtual DcmFGTypes::E_FGSharedType	getSharedType () const
	Returns shared type of this group (can be shared or per-frame) More...

virtual void	clearData ()
	Clear all data.

virtual OFCondition	check () const
	Check whether data in functional group is valid. More...

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

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

virtual OFCondition	getLaterality (LATERALITY &value)
	Get Laterality. More...

virtual GeneralAnatomyMacro &	getAnatomy ()
	Get anatomy information. More...

virtual OFCondition	setLaterality (const LATERALITY &value)
	Set Laterality. 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...

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

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

virtual	~FGBase ()
	Virtual destructor.

Private Attributes
LATERALITY	m_FrameLaterality
	Frame Laterality (DS, VM 1, Required type 1)

GeneralAnatomyMacro	m_Anatomy
	General Anatomy Mandatory Macro.

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 Frame Anatomy Functional Group Macro.

Member Enumeration Documentation

◆ LATERALITY

enum FGFrameAnatomy::LATERALITY

Enumerated values for attribute "Laterality".

Enumerator
LATERALITY_UNDEFINED	Undefined (e.g. value not set)
LATERALITY_INVALID	Invalid Laterality, e.g. when invalid value is read from file.
LATERALITY_R	Right body part.
LATERALITY_L	Left body part.
LATERALITY_UNPAIRED	Unpaired body part.
LATERALITY_BOTH	Both, left and right.

Member Function Documentation

◆ check()

virtual OFCondition FGFrameAnatomy::check ( ) const

virtual

Check whether data in functional group is valid.

Returns: EC_Normal if data is valid, error otherwise

Implements FGBase.

◆ clone()

virtual FGBase* FGFrameAnatomy::clone ( ) const

virtual

Returns a deep copy of this object.

Returns: Deep copy of this object

Implements FGBase.

◆ compare()

virtual int FGFrameAnatomy::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.

◆ getAnatomy()

virtual GeneralAnatomyMacro& FGFrameAnatomy::getAnatomy ( )

virtual

Get anatomy information.

Returns: Reference to anatomic information

◆ getLaterality()

virtual OFCondition FGFrameAnatomy::getLaterality ( LATERALITY & value )

virtual

Get Laterality.

Parameters

value Reference to variable in which the value should be stored

Returns: EC_Normal if successful, an error code otherwise (i.e. if value is LATERALITY_INVALID).

◆ getSharedType()

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

inlinevirtual

Returns shared type of this group (can be shared or per-frame)

Returns: Always returns DcmFGTypes::EFGS_BOTH;

Implements FGBase.

References DcmFGTypes::EFGS_BOTH.

◆ read()

virtual OFCondition FGFrameAnatomy::read ( DcmItem & item )

virtual

Read functional group from given item.

Parameters

item	The item to read from, must contain Frame Anatomy Sequence

Returns: EC_Normal if reading was successful, error otherwise

Implements FGBase.

◆ setLaterality()

virtual OFCondition FGFrameAnatomy::setLaterality ( const LATERALITY & value )

virtual

Set Laterality.

Parameters

value Value to be set

Returns: EC_Normal if successful, an error code otherwise

◆ write()

virtual OFCondition FGFrameAnatomy::write ( DcmItem & item )

virtual

Write functional group to given item.

Parameters

item	The item to write Frame Anatomy Sequence 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/fgframeanatomy.h

Public Types

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ LATERALITY

Member Function Documentation

◆ check()

◆ clone()

◆ compare()

◆ getAnatomy()

◆ getLaterality()

◆ getSharedType()

◆ read()

◆ setLaterality()

◆ write()