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
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
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_type &	Added (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_type &	Removed (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_type &	Results () const
template<typename Op >
void	operator() (Op Operation) const
	Scan through the results. More...
	ScanResults ()
const filename_container_type &	Added (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_type &	Removed (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_type &	Results () const
template<typename Op >
void	operator() (Op Operation) const
	Scan through the results. More...
	ScanResults ()
const filename_container_type &	Added (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_type &	Removed (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_type &	Results () const
template<typename Op >
void	operator() (Op Operation) const
	Scan through the results. More...

Private Attributes
directory_count_type	m_scanned_directories
file_count_type	m_scanned_files
directory_container_type	m_results

Member Typedef Documentation

directory_container_type [1/3]

typedef std::map< std::string, info_type > diskCache::Cache::Directory::ScanResults::directory_container_type

directory_container_type [2/3]

typedef std::map< std::string, info_type > diskCache::Cache::Directory::ScanResults::directory_container_type

directory_container_type [3/3]

typedef std::map< std::string, info_type > diskCache::Cache::Directory::ScanResults::directory_container_type

directory_count_type [1/3]

typedef INT_4U diskCache::Cache::Directory::ScanResults::directory_count_type

directory_count_type [2/3]

typedef INT_4U diskCache::Cache::Directory::ScanResults::directory_count_type

directory_count_type [3/3]

typedef INT_4U diskCache::Cache::Directory::ScanResults::directory_count_type

directory_state [1/3]

typedef Directory::directory_state diskCache::Cache::Directory::ScanResults::directory_state

directory_state [2/3]

typedef Directory::directory_state diskCache::Cache::Directory::ScanResults::directory_state

directory_state [3/3]

typedef Directory::directory_state diskCache::Cache::Directory::ScanResults::directory_state

file_container_type [1/3]

typedef std::map< std::string, count_type > diskCache::Cache::Directory::ScanResults::file_container_type

file_container_type [2/3]

typedef std::map< std::string, count_type > diskCache::Cache::Directory::ScanResults::file_container_type

file_container_type [3/3]

typedef std::map< std::string, count_type > diskCache::Cache::Directory::ScanResults::file_container_type

file_count_type [1/3]

typedef INT_4U diskCache::Cache::Directory::ScanResults::file_count_type

file_count_type [2/3]

typedef INT_4U diskCache::Cache::Directory::ScanResults::file_count_type

file_count_type [3/3]

typedef INT_4U diskCache::Cache::Directory::ScanResults::file_count_type

filename_container_type [1/3]

typedef std::list< std::string > diskCache::Cache::Directory::ScanResults::filename_container_type

filename_container_type [2/3]

typedef std::list< std::string > diskCache::Cache::Directory::ScanResults::filename_container_type

filename_container_type [3/3]

typedef std::list< std::string > diskCache::Cache::Directory::ScanResults::filename_container_type

Constructor & Destructor Documentation

ScanResults() [1/3]

diskCache::Cache::Directory::ScanResults::ScanResults

(

)

ScanResults() [2/3]

diskCache::Cache::Directory::ScanResults::ScanResults

(

)

ScanResults() [3/3]

diskCache::Cache::Directory::ScanResults::ScanResults

(

)

Member Function Documentation

Added() [1/9]

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]

DirectoryName

The parent directory

Added() [2/9]

const filename_container_type& diskCache::Cache::Directory::ScanResults::Added

(

const std::string &

DirectoryName

)

const

Retrieve the collection of added directories.

Parameters

[in]

DirectoryName

The parent directory

Added() [3/9]

const filename_container_type& diskCache::Cache::Directory::ScanResults::Added

(

const std::string &

DirectoryName

)

const

Retrieve the collection of added directories.

Parameters

[in]

DirectoryName

The parent directory

Added() [4/9]

void diskCache::Cache::Directory::ScanResults::Added ( const std::string &  DirectoryName, filename_container_type &  Subdirectories  )

inline

Add the directories that were newly discovered.

Parameters

[in]	DirectoryName	The parent directory
[in,out]	Subdirectories	The collection of directories that have been newly added.

Added() [5/9]

void diskCache::Cache::Directory::ScanResults::Added	(	const std::string &	DirectoryName,
		filename_container_type &	Subdirectories
	)

Add the directories that were newly discovered.

Parameters

[in]	DirectoryName	The parent directory
[in,out]	Subdirectories	The collection of directories that have been newly added.

Added() [6/9]

void diskCache::Cache::Directory::ScanResults::Added	(	const std::string &	DirectoryName,
		filename_container_type &	Subdirectories
	)

Add the directories that were newly discovered.

Parameters

[in]	DirectoryName	The parent directory
[in,out]	Subdirectories	The collection of directories that have been newly added.

Added() [7/9]

void diskCache::Cache::Directory::ScanResults::Added	(	const std::string &	DirectoryName,
		const std::string &	SearchEngine,
		INT_4U	FileCount
	)

Added() [8/9]

void diskCache::Cache::Directory::ScanResults::Added ( const std::string &  DirectoryName, const std::string &  SearchEngine, INT_4U  FileCount  )

inline

Added() [9/9]

void diskCache::Cache::Directory::ScanResults::Added	(	const std::string &	DirectoryName,
		const std::string &	SearchEngine,
		INT_4U	FileCount
	)

DirectoryCount() [1/3]

directory_count_type diskCache::Cache::Directory::ScanResults::DirectoryCount

(

)

const

Retrieve the number of directories scanned.

DirectoryCount() [2/3]

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.

DirectoryCount() [3/3]

directory_count_type diskCache::Cache::Directory::ScanResults::DirectoryCount

(

)

const

Retrieve the number of directories scanned.

DirectoryCountInc() [1/3]

void diskCache::Cache::Directory::ScanResults::DirectoryCountInc

(

)

Retrieve the number of directories scanned.

DirectoryCountInc() [2/3]

void diskCache::Cache::Directory::ScanResults::DirectoryCountInc

(

)

Retrieve the number of directories scanned.

DirectoryCountInc() [3/3]

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

inline

Retrieve the number of directories scanned.

Increment the number of directorys that have been scanned.

FileCount() [1/3]

file_count_type diskCache::Cache::Directory::ScanResults::FileCount

(

)

const

Retrieve the number of Files scanned.

FileCount() [2/3]

file_count_type diskCache::Cache::Directory::ScanResults::FileCount

(

)

const

Retrieve the number of Files scanned.

FileCount() [3/3]

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.

FileCountInc() [1/3]

void diskCache::Cache::Directory::ScanResults::FileCountInc

(

file_count_type

Value

)

Increment the number of Files scanned.

Parameters

[in]

Value

The amount by which to incriment the file count.

FileCountInc() [2/3]

void diskCache::Cache::Directory::ScanResults::FileCountInc

(

file_count_type

Value

)

Increment the number of Files scanned.

Parameters

[in]

Value

The amount by which to incriment the file count.

FileCountInc() [3/3]

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]

Value

The amount by which to incriment the file count.

Log() [1/3]

void diskCache::Cache::Directory::ScanResults::Log	(	const std::string &	Caller,
		const std::string &	JobInfo
	)		const

Create a log message.

Log() [2/3]

void diskCache::Cache::Directory::ScanResults::Log	(	const std::string &	Caller,
		const std::string &	JobInfo
	)		const

Create a log message.

Log() [3/3]

void diskCache::Cache::Directory::ScanResults::Log	(	const std::string &	Caller,
		const std::string &	JobInfo
	)		const

Create a log message.

operator()() [1/3]

template<typename Op >

void diskCache::Cache::Directory::ScanResults::operator() ( Op  Operation ) const

inline

Scan through the results.

operator()() [2/3]

template<typename Op >

void diskCache::Cache::Directory::ScanResults::operator() ( Op  Operation ) const

inline

Scan through the results.

operator()() [3/3]

template<typename Op >

void diskCache::Cache::Directory::ScanResults::operator() ( Op  Operation ) const

inline

Scan through the results.

Removed() [1/9]

const filename_container_type& diskCache::Cache::Directory::ScanResults::Removed

(

const std::string &

DirectoryName

)

const

Retrieve the collection of removed directories.

Parameters

[in]

DirectoryName

The parent directory

Removed() [2/9]

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]

DirectoryName

The parent directory

Removed() [3/9]

const filename_container_type& diskCache::Cache::Directory::ScanResults::Removed

(

const std::string &

DirectoryName

)

const

Retrieve the collection of removed directories.

Parameters

[in]

DirectoryName

The parent directory

Removed() [4/9]

void diskCache::Cache::Directory::ScanResults::Removed	(	const std::string &	DirectoryName,
		filename_container_type &	Subdirectories
	)

Add the directories that were removed.

Parameters

[in]	DirectoryName	The parent directory
[in,out]	Subdirectories	The collection of directories that have been newly added.

Removed() [5/9]

void diskCache::Cache::Directory::ScanResults::Removed	(	const std::string &	DirectoryName,
		filename_container_type &	Subdirectories
	)

Add the directories that were removed.

Parameters

[in]	DirectoryName	The parent directory
[in,out]	Subdirectories	The collection of directories that have been newly added.

Removed() [6/9]

void diskCache::Cache::Directory::ScanResults::Removed	(	const std::string &	DirectoryName,
		filename_container_type &	Subdirectories
	)

Add the directories that were removed.

Parameters

[in]	DirectoryName	The parent directory
[in,out]	Subdirectories	The collection of directories that have been newly added.

Removed() [7/9]

void diskCache::Cache::Directory::ScanResults::Removed	(	const std::string &	DirectoryName,
		const std::string &	SearchEngine,
		INT_4U	FileCount
	)

Removed() [8/9]

void diskCache::Cache::Directory::ScanResults::Removed	(	const std::string &	DirectoryName,
		const std::string &	SearchEngine,
		INT_4U	FileCount
	)

Removed() [9/9]

void diskCache::Cache::Directory::ScanResults::Removed ( const std::string &  DirectoryName, const std::string &  SearchEngine, INT_4U  FileCount  )

inline

Results() [1/3]

const directory_container_type& diskCache::Cache::Directory::ScanResults::Results

(

)

const

Results() [2/3]

const directory_container_type& diskCache::Cache::Directory::ScanResults::Results

(

)

const

Results() [3/3]

const Directory::ScanResults::directory_container_type & diskCache::Cache::Directory::ScanResults::Results ( ) const

inline

State() [1/3]

void diskCache::Cache::Directory::ScanResults::State	(	const std::string &	DirectoryName,
		directory_state	State
	)

Record the directory state at the time of scanning.

Parameters

[in]	DirectoryName	The name of the directory that was scanned.
[in]	State	The state of the directory at the time of being scanned.

State() [2/3]

void diskCache::Cache::Directory::ScanResults::State	(	const std::string &	DirectoryName,
		directory_state	State
	)

Record the directory state at the time of scanning.

Parameters

[in]	DirectoryName	The name of the directory that was scanned.
[in]	State	The state of the directory at the time of being scanned.

State() [3/3]

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]	DirectoryName	The name of the directory that was scanned.
[in]	State	The state of the directory at the time of being scanned.

Member Data Documentation

m_results

directory_container_type diskCache::Cache::Directory::ScanResults::m_results

private

m_scanned_directories

directory_count_type diskCache::Cache::Directory::ScanResults::m_scanned_directories

private

m_scanned_files

file_count_type diskCache::Cache::Directory::ScanResults::m_scanned_files

private

---

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

• /build/ldas-tools-diskcacheapi-2.7.2/debian/tmp/usr/include/diskcacheAPI/Cache/Directory.hh
• /build/ldas-tools-diskcacheapi-2.7.2/src/Cache/Directory.cc