MeVisLab Toolbox Reference
ml::MultiFileVolumeListTools Namespace Reference

Functions

MLMULTI_FILE_VOLUME_EXPORT bool checkRequiredFilesExist (const MultiFileVolume &mfv)
 Returns true if all files referenced in mfv can be found as files on disk, otherwise false; multi-frame handles are supported as described in fileHandleFileExists. More...
 
MLMULTI_FILE_VOLUME_EXPORT bool checkHasFramesFromOneDir (const MultiFileVolume &mfv)
 Returns true if all frames referenced in mfv are located in one flat directory, otherwise false; multi-frame handles are supported as described in fileHandleFileExists. More...
 
MLMULTI_FILE_VOLUME_EXPORT size_t calcNumFrameDirectories (const MultiFileVolume &mfv)
 Returns the number of directories in which the frames of mfv are located. More...
 
MLMULTI_FILE_VOLUME_EXPORT size_t calcNumDifferentTagAppearances (const MultiFileVolume &mfv, const std::string &tagId)
 Returns the number of existing different string-convertible top-level tags with id tagId in frames of mfv. More...
 

Function Documentation

◆ calcNumDifferentTagAppearances()

MLMULTI_FILE_VOLUME_EXPORT size_t ml::MultiFileVolumeListTools::calcNumDifferentTagAppearances ( const MultiFileVolume mfv,
const std::string &  tagId 
)

Returns the number of existing different string-convertible top-level tags with id tagId in frames of mfv.

Parameters
mfvThe MultiFileVolume in whose frames the tags with id tagId are counted.
tagIdThe id of the tag whose number of appearances is searched in (a) MultiFileVolume(s).
Returns
The number of appearances to different string-convertible top-level tags with id tagId, or std::string::npos in case on non-string-convertible tags, invalid tag ids, exceptions on tag accesses or enhanced multi-frame handles in mfv.

◆ calcNumFrameDirectories()

MLMULTI_FILE_VOLUME_EXPORT size_t ml::MultiFileVolumeListTools::calcNumFrameDirectories ( const MultiFileVolume mfv)

Returns the number of directories in which the frames of mfv are located.

Parameters
mfvThe MultiFileVolume whose number of directories of file handles are to be counted.
Returns
The number of directories in which the frames of mfv are located.

◆ checkHasFramesFromOneDir()

MLMULTI_FILE_VOLUME_EXPORT bool ml::MultiFileVolumeListTools::checkHasFramesFromOneDir ( const MultiFileVolume mfv)

Returns true if all frames referenced in mfv are located in one flat directory, otherwise false; multi-frame handles are supported as described in fileHandleFileExists.

Parameters
mfvThe MultiFileVolume whose file handles are to be checked to be in one directory.
Returns
True if all frame handles of the MultiFileVolume come from one flat directory, otherwise false.

◆ checkRequiredFilesExist()

MLMULTI_FILE_VOLUME_EXPORT bool ml::MultiFileVolumeListTools::checkRequiredFilesExist ( const MultiFileVolume mfv)

Returns true if all files referenced in mfv can be found as files on disk, otherwise false; multi-frame handles are supported as described in fileHandleFileExists.

Parameters
mfvThe MultiFileVolume whose file handles are to be checked.
Returns
True if all file handles exist, otherwise false.