MeVisLab Toolbox Reference
ml::RTBase Class Reference

DcmtkBase derived base object class for base objects that wrap RT related objects. More...

#include <mlRTBase.h>

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

Public Member Functions

 RTBase (const DCMTree::TreePtr &tree=DCMTree::TreePtr())
 Default Constructor. More...
 
virtual ~RTBase ()
 Virtual Destructor. More...
 
- Public Member Functions inherited from ml::MutableDicomTree
 MutableDicomTree ()
 
 MutableDicomTree (const DCMTree::TreePtr &tree)
 wraps the given DCMTree::TreePtr More...
 
DCMTree::TreePtr getMutableTree () const
 Get 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
 Get 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
 Increase reference count. More...
 
virtual void decRefCount () const
 Decrease ref count (object will be deleted if ref count is decremented to 0) More...
 
bool isRefCountedBase () const override
 Returns if 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)
 add event listener callback to this Base object - the userData will be the first argument when the callback is called More...
 
void removeEventListener (BaseEventCallback *cb, void *userData)
 remove event listener callback from this Base object - arguments must be the same as for the addEventListener call More...
 
bool hasEventListeners () const
 check if 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 BasedeepCopy () const
 Set addStateToTree version number that can be accessed via getAddStateVersion() More...
 
bool isOfAllowedType (const std::vector< const RuntimeType * > &types) const
 Check if this object's type is equal to or derived from one of the types given in the argument. More...
 
virtual std::string detailString () const
 Return 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
 Write the objects state to the data stream object. More...
 
virtual void readFrom (AbstractPersistenceInputStream *, int)
 Read the objects state from the data stream object. 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 inc/dec of ref count if base instances support it. More...
 
- Protected Member Functions inherited from ml::MutableDicomTree
 ~MutableDicomTree () override
 
void setMutableTree (const DCMTree::TreePtr &tree)
 This method is intentionally protected, it is only here to be used in FME RT modules, which need to set the DCM 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, which need to set the DCM 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...
 
- Protected Member Functions inherited from ml::Base
virtual char * getPersistentState () const
 Returns a C string describing the object's internal state. More...
 
virtual void setPersistentState (const char *)
 Restores the object's internal state from a string that had been previously generated using getPersistentState(). More...
 
virtual void clearPersistentState (char *) const
 Disposes a string previously allocated by getPersistentState(). More...
 
- Protected Attributes inherited from ml::RefCountedBase
MLint32 _refCount
 Reference count. More...
 

Detailed Description

DcmtkBase derived base object class for base objects that wrap RT related objects.

Definition at line 33 of file mlRTBase.h.

Constructor & Destructor Documentation

◆ RTBase()

ml::RTBase::RTBase ( const DCMTree::TreePtr tree = DCMTree::TreePtr())
inline

Default Constructor.

Definition at line 38 of file mlRTBase.h.

◆ ~RTBase()

virtual ml::RTBase::~RTBase ( )
inlinevirtual

Virtual Destructor.

Definition at line 41 of file mlRTBase.h.


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