MeVisLab Toolbox Reference
ml::MultiFileVolumeListRefCounted Class Reference

Class managing a list of MultiFileVolume instances for the DirectDicomImport module. More...

#include <mlMultiFileVolumeListRefCounted.h>

Inheritance diagram for ml::MultiFileVolumeListRefCounted:
ml::RefCountedBase ml::EventSource ml::Base

Public Member Functions

 MultiFileVolumeListRefCounted ()
 Default constructor. More...
 
MultiFileVolumeListgetNonConstOutVolumes ()
 Provides non constant access to list of all imported output volumes. More...
 
const MultiFileVolumeListgetConstOutVolumes () const
 Provides constant access to list of all imported output volumes. 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 BasedeepCopy () 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

 ~MultiFileVolumeListRefCounted () override
 Protected destructor. 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

Class managing a list of MultiFileVolume instances for the DirectDicomImport module.


Definition at line 29 of file mlMultiFileVolumeListRefCounted.h.

Constructor & Destructor Documentation

◆ MultiFileVolumeListRefCounted()

ml::MultiFileVolumeListRefCounted::MultiFileVolumeListRefCounted ( )

Default constructor.

◆ ~MultiFileVolumeListRefCounted()

ml::MultiFileVolumeListRefCounted::~MultiFileVolumeListRefCounted ( )
overrideprotected

Protected destructor.

Member Function Documentation

◆ getConstOutVolumes()

const MultiFileVolumeList& ml::MultiFileVolumeListRefCounted::getConstOutVolumes ( ) const

Provides constant access to list of all imported output volumes.

◆ getNonConstOutVolumes()

MultiFileVolumeList& ml::MultiFileVolumeListRefCounted::getNonConstOutVolumes ( )

Provides non constant access to list of all imported output volumes.


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