MeVisLab Toolbox Reference
ml::DicomAcquisitionContextModuleTagInterface Class Reference

#include <mlDicomAcquisitionContextModuleTagInterface.h>

Inheritance diagram for ml::DicomAcquisitionContextModuleTagInterface:
ml::DicomModifyFieldAddOnBase ml::DicomModifyList ml::FieldAddOnBase ml::Base

Public Member Functions

 DicomAcquisitionContextModuleTagInterface (Module &modRef)
 Constructor, setting the reference of the module for which the fields shall be managed.
void addFields () override
 Add fields to field container of module.
void handleFieldActivationChanges () override
 Handle class changes according to Module::activateAttachments.
FieldAddOnBase::FieldChangeState handleFieldChanges (Field *field) override
 Handle field notifications according to Module::activateAttachments with a return of field change state.
void inheritValues (DCMTree::Const_TreePtr dcmTree) override
 Implements the copy of tag values from the given dcmTree to the fields.
std::string applyModifications (DCMTree::TreePtr dcmTree, const FieldContainer *treeInfos=nullptr) override
void _addAcquisitionContextModuleSpecificTags (DCMTree::TreePtr dcmTree)
 Add tags of the Acquisition Context Module.
std::string checkConsistency () const override
Public Member Functions inherited from ml::DicomModifyFieldAddOnBase
 DicomModifyFieldAddOnBase (FieldContainer &fieldContainerRef, size_t numInstances=1, bool createInputModifyTagsPluginBaseConnectorField=false, bool createOutputModifyTagsPluginBaseConnectorField=false)
 ~DicomModifyFieldAddOnBase () override
 Destructor resetting connector fields if they exist.
size_t getNumInstances () const
 Returns the number of instances to be created by derived fields.
std::string applyModifications (DCMTree::TreePtr dcmTree, const FieldContainer *treeInfos=nullptr) override
void addFields () override
 Add fields to field container of the FieldAddOn.
void handleFieldActivationChanges () override
 Handle class changes according to Module::activateAttachments.
FieldAddOnBase::FieldChangeState handleFieldChanges (Field *field) override
 Handle field notifications according to Module::handleNotification with a return of field change state.
BaseField * getOutputModifierListFld () const
 Provide access to output base field if it was created.
BaseField * getInputModifierListFld () const
 Provide access to input base connector field if it was created.
Public Member Functions inherited from ml::DicomModifyList
 DicomModifyList ()
 ~DicomModifyList () override
 Destructor also destroying all of its stored Modifiers.
void addModifier (DicomModifyBase *modifier, bool atEnd=true)
void clear ()
 Makes modifier array empty and deletes all of them.
std::vector< DicomModifyBase * > & getModifierList ()
const std::vector< DicomModifyBase * > & getModifierList () const
 Same as getModifierList() only for constant access.
void setInputPlugin (DicomModifyList *inputPlugin=nullptr)
DicomModifyList * getInputPlugin () const
 Returns the optional plugin to be called by applyModififcations.
Public Member Functions inherited from ml::Base
 Base ()
 Constructor.
virtual ~Base ()
 Destructor.
virtual Base * deepCopy () const
bool isOfAllowedType (const std::vector< const RuntimeType * > &types) const
virtual bool isRefCountedBase () const
 Returns whether the instance is derived from RefCountedBase.
virtual std::string detailString () const
virtual bool implementsPersistence (PersistenceInterface) const
virtual std::string persistentState () const
 Returns a string describing the object's internal state.
virtual void setPersistentState (const std::string &state)
virtual void addStateToTree (TreeNode *) const
 Attaches the object state as children of the given parent node.
virtual void readStateFromTree (TreeNode *)
 Reads the object state from the children of the given parent node.
virtual void writeTo (AbstractPersistenceOutputStream *) const
virtual void readFrom (AbstractPersistenceInputStream *, int)
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.

Public Attributes

DicomCopyTagSetInterface otherAcquisitionContextModuleTags
 All tags not available in the interface which are from Acquisition Context Module.

Additional Inherited Members

Public Types inherited from ml::Base
enum  PersistenceInterface { PersistenceByString , PersistenceByTreeNode , PersistenceByStream }
 This enum describes the different persistence interfaces available. More...
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...
Static Public Member Functions inherited from ml::DicomModifyFieldAddOnBase
static bool isIn (const std::string &str, const char *const *values, size_t numValues)
 Static helper function which checks whether str is part of the given list of values which has numValues entries.
Protected Member Functions inherited from ml::FieldAddOnBase
void _addFieldPointer (Field *field)

Detailed Description

Manages the module field interface according to DICOM Acquisition Context Module C.7.6.14, currently only by adding an empty Acquisition Context Sequence (0040,0555).

Definition at line 24 of file mlDicomAcquisitionContextModuleTagInterface.h.

Constructor & Destructor Documentation

◆ DicomAcquisitionContextModuleTagInterface()

ml::DicomAcquisitionContextModuleTagInterface::DicomAcquisitionContextModuleTagInterface ( Module & modRef)

Constructor, setting the reference of the module for which the fields shall be managed.

Member Function Documentation

◆ _addAcquisitionContextModuleSpecificTags()

void ml::DicomAcquisitionContextModuleTagInterface::_addAcquisitionContextModuleSpecificTags ( DCMTree::TreePtr dcmTree)

Add tags of the Acquisition Context Module.

◆ addFields()

void ml::DicomAcquisitionContextModuleTagInterface::addFields ( )
overridevirtual

Add fields to field container of module.

Implements ml::FieldAddOnBase.

◆ applyModifications()

std::string ml::DicomAcquisitionContextModuleTagInterface::applyModifications ( DCMTree::TreePtr dcmTree,
const FieldContainer * treeInfos = nullptr )
overridevirtual

See DicomModifyFieldAddOnBase::applyModifications() for documentation; adds field values as tags to dcmTree.

Reimplemented from ml::DicomModifyList.

◆ checkConsistency()

std::string ml::DicomAcquisitionContextModuleTagInterface::checkConsistency ( ) const
overridevirtual

Checks for invalid parameters; return textual description on error, or empty string on success; requires that setInputPagedImage was called with a valid image before for successful proper operation.

Reimplemented from ml::DicomModifyFieldAddOnBase.

◆ handleFieldActivationChanges()

void ml::DicomAcquisitionContextModuleTagInterface::handleFieldActivationChanges ( )
overridevirtual

Handle class changes according to Module::activateAttachments.

Reimplemented from ml::FieldAddOnBase.

◆ handleFieldChanges()

FieldAddOnBase::FieldChangeState ml::DicomAcquisitionContextModuleTagInterface::handleFieldChanges ( Field * field)
overridevirtual

Handle field notifications according to Module::activateAttachments with a return of field change state.

Reimplemented from ml::FieldAddOnBase.

◆ inheritValues()

void ml::DicomAcquisitionContextModuleTagInterface::inheritValues ( DCMTree::Const_TreePtr dcmTree)
overridevirtual

Implements the copy of tag values from the given dcmTree to the fields.

Reimplemented from ml::DicomModifyFieldAddOnBase.

Member Data Documentation

◆ otherAcquisitionContextModuleTags

DicomCopyTagSetInterface ml::DicomAcquisitionContextModuleTagInterface::otherAcquisitionContextModuleTags

All tags not available in the interface which are from Acquisition Context Module.

Definition at line 56 of file mlDicomAcquisitionContextModuleTagInterface.h.

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