Class managing fields fields to show and reference other volumes in a MultiFileVolumeList. More...

Inheritance diagram for ml::RelatedDicomVolumeFieldAddOn:

Public Member Functions
	RelatedDicomVolumeFieldAddOn (FieldContainer &fieldContainerRef)
	Constructor, setting the reference of the FieldContainer managing the fields.

void	addFields () override
	Add fields to field container of module.

void	handleFieldActivationChanges () override
	Do the activateAttachment-like stuff in this method.

FieldAddOnBase::FieldChangeState	handleFieldChanges (Field *field) override
	Handle field notifications.

virtual std::string	checkConsistency () const
	Checks for invalid parameters; return textual description on error, or empty string on success.

virtual void	resetFields ()
	Sets field to default state.

virtual std::string	updateResultFields (DCMTree::Const_TreePtr dcmTree, MultiFileVolumeList *volList)
	Update the field state to new values of dcmTree and volList; if any of them is nullptr then resetFields() is called.)


StringField &	getRelatedSequencesSourceConfigFld () const
	Provide direct access to the fields; see corresponding fields for comments.

BoolField &	getEnableRelatedVolumesFld () const

IntField &	getFirstVolumeIndexDerivedFromFld () const

StringField &	getVolumeIndexesDerivedFromFld () const

IntField &	getFirstSharedFrameOfReferenceVolumeIndexFld () const

StringField &	getSharedFrameOfReferenceVolumeIndexesFld () const

IntField &	getFirstRelatedVolumeIndexFld () const

StringField &	getRelatedVolumeIndexesFld () const

Public Member Functions inherited from ml::FieldAddOnBase
	FieldAddOnBase (FieldContainer &fieldContainerRef)
	Constructor, setting the reference of the FieldContainer managing the fields.

virtual	~FieldAddOnBase ()
	Destructor.

FieldContainer &	getFieldContainer ()
	Returns the referenced container.

const FieldContainer &	getFieldContainer () const
	Returns the referenced container.

std::vector< Field * > &	getFields ()
	Return modification access to the list of managed fields, use at own risk!

const std::vector< Field * > &	getFields () const
	Return constant access to the list of managed fields!

virtual FieldChangeState	getMergedFieldChangeState (FieldChangeState state1, FieldChangeState state2) const
	Returns a FieldChangeState which best represents a merge of the two given states.

virtual bool	hasField (Field *field) const
	Returns true if the passed fieldPtr is in _fieldPointers, otherwise false.

Protected Attributes
BoolField *	_enableRelatedVolumesFld = nullptr
	Enables/disables the functionality of this FieldAddOn since it can be time consuming.

StringField *	_relatedSequencesSourceConfigFld = nullptr
	A string containing the configuration which determines the sequences in which the ReferencedSOPInstanceUIDs shall be searched which shall be used to find volumes considered as "related".

IntField *	_firstVolumeIndexDerivedFromFld = nullptr
	The index into the current MultiFileVolumeList to the first image referenced in DerivedImageSequence or -1 if not found.

StringField *	_volumeIndexesDerivedFromFld = nullptr
	The indexes into the current MultiFileVolumeList to all images referenced in DerivedImageSequence or empty if not found.

IntField *	_firstSharedFrameOfReferenceVolumeIndexFld = nullptr
	The index into the current MultiFileVolumeList to the first found volume which has the same FrameOfReferenceUID as the current volume or -1 if not found.

StringField *	_sharedFrameOfReferenceVolumeIndexesFld = nullptr
	The indexes of all found MultiFileVolumes in the current MultiFileVolumeList which have the same FrameOfReferenceUID as the current volume or empty if not found.

IntField *	_firstRelatedVolumeIndexFld = nullptr
	The first valid index from _firstVolumeIndexDerivedFromFld and _firstSharedFrameOfReferenceVolumeIndexFld.

StringField *	_relatedVolumeIndexesFld = nullptr
	All valid indexes from _volumeIndexesDerivedFromFld and _sharedFrameOfReferenceVolumeIndexesFld.

Additional Inherited Members
Public Types inherited from ml::FieldAddOnBase
enum	FieldChangeState { NoChange = 0 , StatusOnlyChange , RecalculationRequired }
	Describes the type of a field changes detected in handleFieldChanges(Field *field). More...

Protected Member Functions inherited from ml::FieldAddOnBase
void	_addFieldPointer (Field *field)
	Helper routine to add a Field pointer to _fieldPointers, empty pointers and pointers added more than once will be handled fatally.

Detailed Description

Class managing fields fields to show and reference other volumes in a MultiFileVolumeList.

Definition at line 26 of file mlRelatedDicomVolumeFieldAddOn.h.

Constructor & Destructor Documentation

◆ RelatedDicomVolumeFieldAddOn()

ml::RelatedDicomVolumeFieldAddOn::RelatedDicomVolumeFieldAddOn ( FieldContainer & fieldContainerRef )

inline

Constructor, setting the reference of the FieldContainer managing the fields.

Definition at line 30 of file mlRelatedDicomVolumeFieldAddOn.h.

Member Function Documentation

◆ addFields()

void ml::RelatedDicomVolumeFieldAddOn::addFields ( )

overridevirtual

Add fields to field container of module.

Implements ml::FieldAddOnBase.

◆ checkConsistency()

virtual std::string ml::RelatedDicomVolumeFieldAddOn::checkConsistency ( ) const

virtual

Checks for invalid parameters; return textual description on error, or empty string on success.

◆ getEnableRelatedVolumesFld()

BoolField & ml::RelatedDicomVolumeFieldAddOn::getEnableRelatedVolumesFld ( ) const

inline

Definition at line 53 of file mlRelatedDicomVolumeFieldAddOn.h.

◆ getFirstRelatedVolumeIndexFld()

IntField & ml::RelatedDicomVolumeFieldAddOn::getFirstRelatedVolumeIndexFld ( ) const

inline

Definition at line 58 of file mlRelatedDicomVolumeFieldAddOn.h.

◆ getFirstSharedFrameOfReferenceVolumeIndexFld()

IntField & ml::RelatedDicomVolumeFieldAddOn::getFirstSharedFrameOfReferenceVolumeIndexFld ( ) const

inline

Definition at line 56 of file mlRelatedDicomVolumeFieldAddOn.h.

◆ getFirstVolumeIndexDerivedFromFld()

IntField & ml::RelatedDicomVolumeFieldAddOn::getFirstVolumeIndexDerivedFromFld ( ) const

inline

Definition at line 54 of file mlRelatedDicomVolumeFieldAddOn.h.

◆ getRelatedSequencesSourceConfigFld()

StringField & ml::RelatedDicomVolumeFieldAddOn::getRelatedSequencesSourceConfigFld ( ) const

inline

Provide direct access to the fields; see corresponding fields for comments.

Definition at line 52 of file mlRelatedDicomVolumeFieldAddOn.h.

◆ getRelatedVolumeIndexesFld()

StringField & ml::RelatedDicomVolumeFieldAddOn::getRelatedVolumeIndexesFld ( ) const

inline

Definition at line 59 of file mlRelatedDicomVolumeFieldAddOn.h.

◆ getSharedFrameOfReferenceVolumeIndexesFld()

StringField & ml::RelatedDicomVolumeFieldAddOn::getSharedFrameOfReferenceVolumeIndexesFld ( ) const

inline

Definition at line 57 of file mlRelatedDicomVolumeFieldAddOn.h.

◆ getVolumeIndexesDerivedFromFld()

StringField & ml::RelatedDicomVolumeFieldAddOn::getVolumeIndexesDerivedFromFld ( ) const

inline

Definition at line 55 of file mlRelatedDicomVolumeFieldAddOn.h.

◆ handleFieldActivationChanges()

void ml::RelatedDicomVolumeFieldAddOn::handleFieldActivationChanges ( )

overridevirtual

Do the activateAttachment-like stuff in this method.

Reimplemented from ml::FieldAddOnBase.

◆ handleFieldChanges()

FieldAddOnBase::FieldChangeState ml::RelatedDicomVolumeFieldAddOn::handleFieldChanges ( Field * field )

overridevirtual

Handle field notifications.

Reimplemented from ml::FieldAddOnBase.

◆ resetFields()

virtual void ml::RelatedDicomVolumeFieldAddOn::resetFields ( )

virtual

Sets field to default state.

◆ updateResultFields()

virtual std::string ml::RelatedDicomVolumeFieldAddOn::updateResultFields	(	DCMTree::Const_TreePtr	dcmTree,
		MultiFileVolumeList *	volList )

virtual

Update the field state to new values of dcmTree and volList; if any of them is nullptr then resetFields() is called.)

Member Data Documentation

◆ _enableRelatedVolumesFld

BoolField* ml::RelatedDicomVolumeFieldAddOn::_enableRelatedVolumesFld = nullptr

protected

Enables/disables the functionality of this FieldAddOn since it can be time consuming.

Definition at line 67 of file mlRelatedDicomVolumeFieldAddOn.h.

◆ _firstRelatedVolumeIndexFld

IntField* ml::RelatedDicomVolumeFieldAddOn::_firstRelatedVolumeIndexFld = nullptr

protected

The first valid index from _firstVolumeIndexDerivedFromFld and _firstSharedFrameOfReferenceVolumeIndexFld.

Definition at line 103 of file mlRelatedDicomVolumeFieldAddOn.h.

◆ _firstSharedFrameOfReferenceVolumeIndexFld

IntField* ml::RelatedDicomVolumeFieldAddOn::_firstSharedFrameOfReferenceVolumeIndexFld = nullptr

protected

The index into the current MultiFileVolumeList to the first found volume which has the same FrameOfReferenceUID as the current volume or -1 if not found.

Definition at line 95 of file mlRelatedDicomVolumeFieldAddOn.h.

◆ _firstVolumeIndexDerivedFromFld

IntField* ml::RelatedDicomVolumeFieldAddOn::_firstVolumeIndexDerivedFromFld = nullptr

protected

The index into the current MultiFileVolumeList to the first image referenced in DerivedImageSequence or -1 if not found.

Definition at line 87 of file mlRelatedDicomVolumeFieldAddOn.h.

◆ _relatedSequencesSourceConfigFld

StringField* ml::RelatedDicomVolumeFieldAddOn::_relatedSequencesSourceConfigFld = nullptr

protected

A string containing the configuration which determines the sequences in which the ReferencedSOPInstanceUIDs shall be searched which shall be used to find volumes considered as "related".

Entries may be separated with spaces or commas inside lines. If multiple entries are inside one line then the first found sequence one is taken as source. Entries found in newline-separated lines are all scanned for ReferencedSOPInstanceUIDs. Allowed entries are currently RelatedMultiFileVolumeTools::FromReferencedSeriesSequence, RelatedMultiFileVolumeTools::FromReferencedImageSequence, RelatedMultiFileVolumeTools::FromSourceImageSequence, and RelatedMultiFileVolumeTools::FromDerivationImageSequence. Example: take ReferencedSOPInstanceUIDs from SourceImageSequence, if found, otherwise from ReferencedImageSequence. Additionally those ones from DerivationImageSequence: "SourceImageSequence, ReferencedImageSequence" "DerivationImageSequence"

Definition at line 84 of file mlRelatedDicomVolumeFieldAddOn.h.

◆ _relatedVolumeIndexesFld

StringField* ml::RelatedDicomVolumeFieldAddOn::_relatedVolumeIndexesFld = nullptr

protected

All valid indexes from _volumeIndexesDerivedFromFld and _sharedFrameOfReferenceVolumeIndexesFld.

Definition at line 106 of file mlRelatedDicomVolumeFieldAddOn.h.

◆ _sharedFrameOfReferenceVolumeIndexesFld

StringField* ml::RelatedDicomVolumeFieldAddOn::_sharedFrameOfReferenceVolumeIndexesFld = nullptr

protected

The indexes of all found MultiFileVolumes in the current MultiFileVolumeList which have the same FrameOfReferenceUID as the current volume or empty if not found.

Definition at line 99 of file mlRelatedDicomVolumeFieldAddOn.h.

◆ _volumeIndexesDerivedFromFld

StringField* ml::RelatedDicomVolumeFieldAddOn::_volumeIndexesDerivedFromFld = nullptr

protected

The indexes into the current MultiFileVolumeList to all images referenced in DerivedImageSequence or empty if not found.

Definition at line 90 of file mlRelatedDicomVolumeFieldAddOn.h.

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

FMEstable/ReleaseMeVis/Projects/MultiFileVolume/MLMultiFileVolumeListOutputs/Sources/mlRelatedDicomVolumeFieldAddOn.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ RelatedDicomVolumeFieldAddOn()

Member Function Documentation

◆ addFields()

◆ checkConsistency()

◆ getEnableRelatedVolumesFld()

◆ getFirstRelatedVolumeIndexFld()

◆ getFirstSharedFrameOfReferenceVolumeIndexFld()

◆ getFirstVolumeIndexDerivedFromFld()

◆ getRelatedSequencesSourceConfigFld()

◆ getRelatedVolumeIndexesFld()

◆ getSharedFrameOfReferenceVolumeIndexesFld()

◆ getVolumeIndexesDerivedFromFld()

◆ handleFieldActivationChanges()

◆ handleFieldChanges()

◆ resetFields()

◆ updateResultFields()

Member Data Documentation

◆ _enableRelatedVolumesFld

◆ _firstRelatedVolumeIndexFld

◆ _firstSharedFrameOfReferenceVolumeIndexFld

◆ _firstVolumeIndexDerivedFromFld

◆ _relatedSequencesSourceConfigFld

◆ _relatedVolumeIndexesFld

◆ _sharedFrameOfReferenceVolumeIndexesFld

◆ _volumeIndexesDerivedFromFld