MeVisLab Toolbox Reference
ml::MutableDicomTree Class Reference

#include <mlMutableDicomTree.h>

Inheritance diagram for ml::MutableDicomTree:
ml::DicomTree ml::RefCountedBase ml::EventSource ml::Base ml::RTBase ml::DRTDoseIODBase ml::DRTImageIODBase ml::DRTIonBeamsTreatmentRecordIODBase ml::DRTIonPlanIODBase ml::DRTPlanIODBase ml::DRTStructureSetIODBase ml::DRTTreatmentSummaryRecordIODBase

Public Member Functions

 MutableDicomTree ()
 MutableDicomTree (const DCMTree::TreePtr &tree)
 Wraps the given DCMTree::TreePtr.
DCMTree::TreePtr getMutableTree () const
 Returns the tree pointer.
Public Member Functions inherited from ml::DicomTree
 DicomTree ()
 DicomTree (const DCMTree::Const_TreePtr &tree)
 Wraps the given DCMTree::Const_TreePtr.
DCMTree::Const_TreePtr getTree () const
 Returns the tree pointer.
Public Member Functions inherited from ml::RefCountedBase
 RefCountedBase ()
 Constructor.
 RefCountedBase (const RefCountedBase &)
 Explicit copy constructor.
virtual void incRefCount () const
 Increases the reference count.
virtual void decRefCount () const
 Decreases the reference count (object will be deleted if the reference count is decremented to 0).
bool isRefCountedBase () const override
 Returns whether the instance is derived from RefCountedBase.
Public Member Functions inherited from ml::EventSource
 EventSource ()
 EventSource (const EventSource &evSource)
 ~EventSource () override
void addEventListener (BaseEventCallback *cb, void *userData)
void removeEventListener (BaseEventCallback *cb, void *userData)
bool hasEventListeners () const
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 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)

Protected Member Functions

 ~MutableDicomTree () override
void setMutableTree (const DCMTree::TreePtr &tree)
Protected Member Functions inherited from ml::DicomTree
 ~DicomTree () override
void setTree (const DCMTree::Const_TreePtr &tree)
Protected Member Functions inherited from ml::RefCountedBase
 ~RefCountedBase () override
 Destructor.
Protected Member Functions inherited from ml::EventSource
void sendEvent (BaseEvent *event, void *skipListener=nullptr)

Additional Inherited Members

Public Types inherited from ml::Base
enum  PersistenceInterface { PersistenceByString , PersistenceByTreeNode , PersistenceByStream }
 This enum describes the different persistence interfaces available. More...
Static Public Member Functions inherited from ml::RefCountedBase
static void updateReferenceCountingIfSupported (Base *oldValue, Base *newValue, bool &isRefCountedBase)
Protected Attributes inherited from ml::RefCountedBase
std::atomic_int_least32_t _refCount
 Reference count.

Detailed Description

The DicomTree class can be used to transport a DCMTree::Const_TreePtr as an ml::RefCountedBase object. Note: There are no setters on purpose. Create a new MutableDicomTree if you need to wrap a new DCMTree.

Definition at line 26 of file mlMutableDicomTree.h.

Constructor & Destructor Documentation

◆ MutableDicomTree() [1/2]

ml::MutableDicomTree::MutableDicomTree ( )
inline

Definition at line 29 of file mlMutableDicomTree.h.

Referenced by ml::RTBase::RTBase().

◆ MutableDicomTree() [2/2]

ml::MutableDicomTree::MutableDicomTree ( const DCMTree::TreePtr & tree)

Wraps the given DCMTree::TreePtr.

◆ ~MutableDicomTree()

ml::MutableDicomTree::~MutableDicomTree ( )
inlineoverrideprotected

Definition at line 40 of file mlMutableDicomTree.h.

Member Function Documentation

◆ getMutableTree()

DCMTree::TreePtr ml::MutableDicomTree::getMutableTree ( ) const
inline

Returns the tree pointer.

Definition at line 35 of file mlMutableDicomTree.h.

Referenced by ml::DRTDoseIODBase::getDCMTree(), ml::DRTImageIODBase::getDCMTree(), ml::DRTIonBeamsTreatmentRecordIODBase::getDCMTree(), ml::DRTIonPlanIODBase::getDCMTree(), ml::DRTPlanIODBase::getDCMTree(), ml::DRTStructureSetIODBase::getDCMTree(), ml::DRTTreatmentSummaryRecordIODBase::getDCMTree(), ml::DRTDoseIODBase::isValid(), ml::DRTImageIODBase::isValid(), ml::DRTIonBeamsTreatmentRecordIODBase::isValid(), ml::DRTIonPlanIODBase::isValid(), ml::DRTPlanIODBase::isValid(), ml::DRTStructureSetIODBase::isValid(), and ml::DRTTreatmentSummaryRecordIODBase::isValid().

◆ setMutableTree()

void ml::MutableDicomTree::setMutableTree ( const DCMTree::TreePtr & tree)
inlineprotected

This method is intentionally protected, it is only here to be used in FME RT modules that need to set the DICOM tree later on.

Definition at line 44 of file mlMutableDicomTree.h.

References ml::DicomTree::setTree().

Referenced by ml::DRTDoseIODBase::setDcmTree(), ml::DRTImageIODBase::setDcmTree(), ml::DRTIonBeamsTreatmentRecordIODBase::setDcmTree(), ml::DRTIonPlanIODBase::setDcmTree(), ml::DRTPlanIODBase::setDcmTree(), ml::DRTStructureSetIODBase::setDcmTree(), and ml::DRTTreatmentSummaryRecordIODBase::setDcmTree().

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