MeVisLab Toolbox Reference
MLDICOMCachedIOTreeCacheSingleMFMapEntry Class Reference

Class describing one SingleMultiFrameFrame entry in the map of locked single frames in the MLDICOMCachedIOTreeCache. More...

#include <mlDICOMCachedIOTreeCacheSingleMFMapEntry.h>

Public Member Functions

 MLDICOMCachedIOTreeCacheSingleMFMapEntry ()
 Default constructor. More...
 
 MLDICOMCachedIOTreeCacheSingleMFMapEntry (DCMTree::TreePtr singleFrameTreeArg, const ml::DICOMCachedIOFileHandle origFileHandleArg, size_t frameIndexArg)
 Convenience constructor. More...
 
 MLDICOMCachedIOTreeCacheSingleMFMapEntry (const MLDICOMCachedIOTreeCacheSingleMFMapEntry &orig)
 Copy constructor. More...
 
MLDICOMCachedIOTreeCacheSingleMFMapEntryoperator= (const MLDICOMCachedIOTreeCacheSingleMFMapEntry &orig)
 Assignment operator. More...
 
const DCMTree::TreePtrgetSingleFrameTree () const
 Public access to protected members. More...
 
const ml::DICOMCachedIOFileHandlegetCodedHandle () const
 
const ml::DICOMCachedIOFileHandlegetOrigHandle () const
 
size_t getFrameIndex () const
 

Static Public Member Functions

static ml::DICOMCachedIOFileHandle createCodedHandle (const ml::DICOMCachedIOFileHandle origFileHandleArg, size_t frameIndexArg)
 Function which returns a coded handle built from an original handle and an index. More...
 

Protected Attributes

DCMTree::TreePtr _singleFrameTree
 The tree representing one frame from a multi-frame file. More...
 
ml::DICOMCachedIOFileHandle _codedHandle
 The coded handle to the single frame + original handle to the multi-frame file with additional "*" at its beginning and "#<frameIdx>" at its end. More...
 
ml::DICOMCachedIOFileHandle _origFileHandle
 The original handle to the multi-frame file without additional "*" at its beginning and without number at its end. More...
 
size_t _frameIndex
 The index of the frame in _origFileHandle to which singleFrameTree corresponds. More...
 

Detailed Description

Class describing one SingleMultiFrameFrame entry in the map of locked single frames in the MLDICOMCachedIOTreeCache.

Definition at line 24 of file mlDICOMCachedIOTreeCacheSingleMFMapEntry.h.

Constructor & Destructor Documentation

◆ MLDICOMCachedIOTreeCacheSingleMFMapEntry() [1/3]

MLDICOMCachedIOTreeCacheSingleMFMapEntry::MLDICOMCachedIOTreeCacheSingleMFMapEntry ( )

Default constructor.

◆ MLDICOMCachedIOTreeCacheSingleMFMapEntry() [2/3]

MLDICOMCachedIOTreeCacheSingleMFMapEntry::MLDICOMCachedIOTreeCacheSingleMFMapEntry ( DCMTree::TreePtr  singleFrameTreeArg,
const ml::DICOMCachedIOFileHandle  origFileHandleArg,
size_t  frameIndexArg 
)

Convenience constructor.

◆ MLDICOMCachedIOTreeCacheSingleMFMapEntry() [3/3]

MLDICOMCachedIOTreeCacheSingleMFMapEntry::MLDICOMCachedIOTreeCacheSingleMFMapEntry ( const MLDICOMCachedIOTreeCacheSingleMFMapEntry orig)

Copy constructor.

Member Function Documentation

◆ createCodedHandle()

static ml::DICOMCachedIOFileHandle MLDICOMCachedIOTreeCacheSingleMFMapEntry::createCodedHandle ( const ml::DICOMCachedIOFileHandle  origFileHandleArg,
size_t  frameIndexArg 
)
static

Function which returns a coded handle built from an original handle and an index.

◆ getCodedHandle()

const ml::DICOMCachedIOFileHandle& MLDICOMCachedIOTreeCacheSingleMFMapEntry::getCodedHandle ( ) const
inline

Definition at line 48 of file mlDICOMCachedIOTreeCacheSingleMFMapEntry.h.

◆ getFrameIndex()

size_t MLDICOMCachedIOTreeCacheSingleMFMapEntry::getFrameIndex ( ) const
inline

Definition at line 50 of file mlDICOMCachedIOTreeCacheSingleMFMapEntry.h.

◆ getOrigHandle()

const ml::DICOMCachedIOFileHandle& MLDICOMCachedIOTreeCacheSingleMFMapEntry::getOrigHandle ( ) const
inline

Definition at line 49 of file mlDICOMCachedIOTreeCacheSingleMFMapEntry.h.

◆ getSingleFrameTree()

const DCMTree::TreePtr& MLDICOMCachedIOTreeCacheSingleMFMapEntry::getSingleFrameTree ( ) const
inline

Public access to protected members.

Definition at line 47 of file mlDICOMCachedIOTreeCacheSingleMFMapEntry.h.

◆ operator=()

MLDICOMCachedIOTreeCacheSingleMFMapEntry& MLDICOMCachedIOTreeCacheSingleMFMapEntry::operator= ( const MLDICOMCachedIOTreeCacheSingleMFMapEntry orig)

Assignment operator.

Member Data Documentation

◆ _codedHandle

ml::DICOMCachedIOFileHandle MLDICOMCachedIOTreeCacheSingleMFMapEntry::_codedHandle
protected

The coded handle to the single frame + original handle to the multi-frame file with additional "*" at its beginning and "#<frameIdx>" at its end.

Definition at line 59 of file mlDICOMCachedIOTreeCacheSingleMFMapEntry.h.

◆ _frameIndex

size_t MLDICOMCachedIOTreeCacheSingleMFMapEntry::_frameIndex
protected

The index of the frame in _origFileHandle to which singleFrameTree corresponds.

Definition at line 66 of file mlDICOMCachedIOTreeCacheSingleMFMapEntry.h.

◆ _origFileHandle

ml::DICOMCachedIOFileHandle MLDICOMCachedIOTreeCacheSingleMFMapEntry::_origFileHandle
protected

The original handle to the multi-frame file without additional "*" at its beginning and without number at its end.

Definition at line 63 of file mlDICOMCachedIOTreeCacheSingleMFMapEntry.h.

◆ _singleFrameTree

DCMTree::TreePtr MLDICOMCachedIOTreeCacheSingleMFMapEntry::_singleFrameTree
protected

The tree representing one frame from a multi-frame file.

Definition at line 55 of file mlDICOMCachedIOTreeCacheSingleMFMapEntry.h.


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