The DicomTree class can be used to transport a DCMTree::Const_TreePtr as an ml::RefCountedBase object. More...
#include <mlMutableDicomTree.h>
Public Member Functions | |
| MutableDicomTree () | |
| MutableDicomTree (const DCMTree::TreePtr &tree) | |
| Wraps the given DCMTree::TreePtr. More... | |
| DCMTree::TreePtr | getMutableTree () const |
| Returns the tree pointer. More... | |
 Public Member Functions inherited from ml::DicomTree | |
| DicomTree () | |
| DicomTree (const DCMTree::Const_TreePtr &tree) | |
| Wraps the given DCMTree::Const_TreePtr. More... | |
| DCMTree::Const_TreePtr | getTree () const |
| Returns the tree pointer. More... | |
| Public Member Functions inherited from ml::RefCountedBase | |
| RefCountedBase () | |
| Constructor. More... | |
| RefCountedBase (const RefCountedBase &) | |
| Explicit copy constructor. More... | |
| virtual void | incRefCount () const |
| Increases the reference count. More... | |
| virtual void | decRefCount () const |
| Decreases the reference count (object will be deleted if the reference count is decremented to 0). More... | |
| bool | isRefCountedBase () const override |
| Returns whether the instance is derived from RefCountedBase. More... | |
| Public Member Functions inherited from ml::EventSource | |
| EventSource () | |
| EventSource (const EventSource &evSource) | |
| ~EventSource () override | |
| void | addEventListener (BaseEventCallback *cb, void *userData) |
| Adds event listener callback to this Base object. More... | |
| void | removeEventListener (BaseEventCallback *cb, void *userData) |
| Removes event listener callback from this Base object. More... | |
| bool | hasEventListeners () const |
| Checks whether any event listeners have been added to this Base object; this can be used to skip the sendEvent call and the potentially expensive building of the event object altogether. More... | |
| Public Member Functions inherited from ml::Base | |
| Base () | |
| Constructor. More... | |
| virtual | ~Base () |
| Destructor. More... | |
| virtual Base * | deepCopy () const |
| Creates a deep copy of the given object. More... | |
| bool | isOfAllowedType (const std::vector< const RuntimeType * > &types) const |
| Checks whether this object's type is equal to or derived from one of the types given in the argument. More... | |
| virtual std::string | detailString () const |
| Returns a string describing this object. More... | |
| virtual bool | implementsPersistence (PersistenceInterface) const |
| Override this method to declare which persistence interfaces are implemented by your derived class. More... | |
| virtual std::string | persistentState () const |
| Returns a string describing the object's internal state. More... | |
| virtual void | setPersistentState (const std::string &state) |
| Restores the object's internal state from a string that had been previously generated using persistentState(). More... | |
| virtual void | addStateToTree (TreeNode *) const |
| Attaches the object state as children of the given parent node. More... | |
| virtual void | readStateFromTree (TreeNode *) |
| Reads the object state from the children of the given parent node. More... | |
| virtual void | writeTo (AbstractPersistenceOutputStream *) const |
| Writes the objects state to the data stream object. More... | |
| virtual void | readFrom (AbstractPersistenceInputStream *, int) |
| Reads the objects state from the data stream object. More... | |
Protected Member Functions | |
| ~MutableDicomTree () override | |
| void | setMutableTree (const DCMTree::TreePtr &tree) |
| 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. More... | |
| Protected Member Functions inherited from ml::DicomTree | |
| ~DicomTree () override | |
| void | setTree (const DCMTree::Const_TreePtr &tree) |
| 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. More... | |
| Protected Member Functions inherited from ml::RefCountedBase | |
| ~RefCountedBase () override | |
| Macro for the declaration of the runtime type system methods, defined in mlRuntimeSubClass.h. More... | |
| Protected Member Functions inherited from ml::EventSource | |
| void | sendEvent (BaseEvent *event, void *skipListener=nullptr) |
| Macro for the declaration of the runtime type system methods, defined in mlRuntimeSubClass.h. More... | |
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) |
| Helper method that handles incrementing/decrementing of the reference count if base instances support it. More... | |
| Protected Attributes inherited from ml::RefCountedBase | |
| std::atomic_int_least32_t | _refCount |
| Reference count. More... | |
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]
|
inline |
Definition at line 29 of file mlMutableDicomTree.h.
◆ MutableDicomTree() [2/2]
| ml::MutableDicomTree::MutableDicomTree | ( | const DCMTree::TreePtr & | tree | ) |
Wraps the given DCMTree::TreePtr.
◆ ~MutableDicomTree()
|
inlineoverrideprotected |
Definition at line 40 of file mlMutableDicomTree.h.
Member Function Documentation
◆ getMutableTree()
|
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()
|
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.
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:
- MeVis/Foundation/Sources/MLDicomTreeImagePropertyExtension/mlMutableDicomTree.h
