ldas-tools-diskcacheAPI  2.6.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Classes | Public Types | Public Member Functions | List of all members
diskCache::Cache::Directory::ScanResults Class Reference

#include <Directory.hh>

Classes

struct  count_type
 
struct  directory_type
 
struct  info_type
 

Public Types

typedef std::list< std::string > filename_container_type
 
typedef INT_4U directory_count_type
 
typedef INT_4U file_count_type
 
typedef Directory::directory_state directory_state
 
typedef std::map< std::string,
count_type
file_container_type
 
typedef std::map< std::string,
info_type
directory_container_type
 

Public Member Functions

 ScanResults ()
 
const filename_container_typeAdded (const std::string &DirectoryName) const
 Retrieve the collection of added directories. More...
 
void Added (const std::string &DirectoryName, filename_container_type &Subdirectories)
 Add the directories that were newly discovered. More...
 
void Added (const std::string &DirectoryName, const std::string &SearchEngine, INT_4U FileCount)
 
directory_count_type DirectoryCount () const
 Retrieve the number of directories scanned. More...
 
void DirectoryCountInc ()
 Retrieve the number of directories scanned. More...
 
file_count_type FileCount () const
 Retrieve the number of Files scanned. More...
 
void FileCountInc (file_count_type Value)
 Increment the number of Files scanned. More...
 
void Log (const std::string &Caller, const std::string &JobInfo) const
 Create a log message. More...
 
void State (const std::string &DirectoryName, directory_state State)
 Record the directory state at the time of scanning. More...
 
const filename_container_typeRemoved (const std::string &DirectoryName) const
 Retrieve the collection of removed directories. More...
 
void Removed (const std::string &DirectoryName, filename_container_type &Subdirectories)
 Add the directories that were removed. More...
 
void Removed (const std::string &DirectoryName, const std::string &SearchEngine, INT_4U FileCount)
 
const directory_container_typeResults () const
 
template<typename Op >
void operator() (Op Operation) const
 Scan through the results. More...
 

Member Typedef Documentation

typedef std::map< std::string, info_type > diskCache::Cache::Directory::ScanResults::directory_container_type
typedef INT_4U diskCache::Cache::Directory::ScanResults::directory_count_type
typedef std::map< std::string, count_type > diskCache::Cache::Directory::ScanResults::file_container_type
typedef INT_4U diskCache::Cache::Directory::ScanResults::file_count_type
typedef std::list< std::string > diskCache::Cache::Directory::ScanResults::filename_container_type

Constructor & Destructor Documentation

Member Function Documentation

const Directory::ScanResults::filename_container_type & diskCache::Cache::Directory::ScanResults::Added ( const std::string &  DirectoryName) const
inline

Retrieve the collection of added directories.

Parameters
[in]DirectoryNameThe parent directory
void diskCache::Cache::Directory::ScanResults::Added ( const std::string &  DirectoryName,
filename_container_type Subdirectories 
)
inline

Add the directories that were newly discovered.

Parameters
[in]DirectoryNameThe parent directory
[in,out]SubdirectoriesThe collection of directories that have been newly added.
void diskCache::Cache::Directory::ScanResults::Added ( const std::string &  DirectoryName,
const std::string &  SearchEngine,
INT_4U  FileCount 
)
inline
Directory::ScanResults::directory_count_type diskCache::Cache::Directory::ScanResults::DirectoryCount ( ) const
inline

Retrieve the number of directories scanned.

Return the number of directorys that have been scanned.

void diskCache::Cache::Directory::ScanResults::DirectoryCountInc ( )
inline

Retrieve the number of directories scanned.

Increment the number of directorys that have been scanned.

Directory::ScanResults::file_count_type diskCache::Cache::Directory::ScanResults::FileCount ( ) const
inline

Retrieve the number of Files scanned.

Return the number of files that have been scanned.

void diskCache::Cache::Directory::ScanResults::FileCountInc ( file_count_type  Value)
inline

Increment the number of Files scanned.

Increment the number of files that have been scanned.

Parameters
[in]ValueThe amount by which to incriment the file count.
void diskCache::Cache::Directory::ScanResults::Log ( const std::string &  Caller,
const std::string &  JobInfo 
) const

Create a log message.

template<typename Op >
void diskCache::Cache::Directory::ScanResults::operator() ( Op  Operation) const
inline

Scan through the results.

const Directory::ScanResults::filename_container_type & diskCache::Cache::Directory::ScanResults::Removed ( const std::string &  DirectoryName) const
inline

Retrieve the collection of removed directories.

Parameters
[in]DirectoryNameThe parent directory
void diskCache::Cache::Directory::ScanResults::Removed ( const std::string &  DirectoryName,
filename_container_type Subdirectories 
)

Add the directories that were removed.

Parameters
[in]DirectoryNameThe parent directory
[in,out]SubdirectoriesThe collection of directories that have been newly added.
void diskCache::Cache::Directory::ScanResults::Removed ( const std::string &  DirectoryName,
const std::string &  SearchEngine,
INT_4U  FileCount 
)
inline
const Directory::ScanResults::directory_container_type & diskCache::Cache::Directory::ScanResults::Results ( ) const
inline
void diskCache::Cache::Directory::ScanResults::State ( const std::string &  DirectoryName,
directory_state  State 
)
inline

Record the directory state at the time of scanning.

Parameters
[in]DirectoryNameThe name of the directory that was scanned.
[in]StateThe state of the directory at the time of being scanned.

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