ldas-tools-ldasgen  2.7.1
Public Types | Static Public Member Functions | List of all members
GenericAPI::MountPointStatus Class Reference

Monitors a list of directories. More...

#include <MountPointStatus.hh>

Public Types

typedef std::list< std::string > mount_point_list_type
 Container for a set of mount points. More...
 
typedef std::list< std::string > mount_point_list_type
 Container for a set of mount points. More...
 
typedef std::list< std::string > mount_point_list_type
 Container for a set of mount points. More...
 

Static Public Member Functions

static bool Initialize ()
 Initialize the class. More...
 
static void Add (const mount_point_list_type &MountPoint)
 Adds directories to set of managed directories. More...
 
static bool IsDirManaged (const std::string &Dir)
 Checks if directory is being managed. More...
 
static void Remove (const mount_point_list_type &MountPoint)
 Removes directories from the set of managed directories. More...
 
static void Set (const mount_point_list_type &MountPoint)
 Resets the set of directories to be managed. More...
 
static void Set (const std::vector< std::string > &MountPoint)
 Resets the set of directories to be managed. More...
 
static state_type Status (const std::string &Path)
 Returns the on-line status of the file system. More...
 
static bool Initialize ()
 Initialize the class. More...
 
static void Add (const mount_point_list_type &MountPoint)
 Adds directories to set of managed directories. More...
 
static bool IsDirManaged (const std::string &Dir)
 Checks if directory is being managed. More...
 
static void Remove (const mount_point_list_type &MountPoint)
 Removes directories from the set of managed directories. More...
 
static void Set (const mount_point_list_type &MountPoint)
 Resets the set of directories to be managed. More...
 
static void Set (const std::vector< std::string > &MountPoint)
 Resets the set of directories to be managed. More...
 
static state_type Status (const std::string &Path)
 Returns the on-line status of the file system. More...
 
static bool Initialize ()
 Initialize the class. More...
 
static void Add (const mount_point_list_type &MountPoint)
 Adds directories to set of managed directories. More...
 
static bool IsDirManaged (const std::string &Dir)
 Checks if directory is being managed. More...
 
static void Remove (const mount_point_list_type &MountPoint)
 Removes directories from the set of managed directories. More...
 
static void Set (const mount_point_list_type &MountPoint)
 Resets the set of directories to be managed. More...
 
static void Set (const std::vector< std::string > &MountPoint)
 Resets the set of directories to be managed. More...
 
static state_type Status (const std::string &Path)
 Returns the on-line status of the file system. More...
 

Detailed Description

Monitors a list of directories.

The main focus of this class is to provide methods which maintain information about a group of directories.

Member Typedef Documentation

◆ mount_point_list_type [1/3]

typedef std::list< std::string > GenericAPI::MountPointStatus::mount_point_list_type

Container for a set of mount points.

This type is used by several routines to pass a set of directories on which to operate.

◆ mount_point_list_type [2/3]

typedef std::list< std::string > GenericAPI::MountPointStatus::mount_point_list_type

Container for a set of mount points.

This type is used by several routines to pass a set of directories on which to operate.

◆ mount_point_list_type [3/3]

typedef std::list< std::string > GenericAPI::MountPointStatus::mount_point_list_type

Container for a set of mount points.

This type is used by several routines to pass a set of directories on which to operate.

Member Function Documentation

◆ Add() [1/3]

void GenericAPI::MountPointStatus::Add ( const mount_point_list_type MountPoints)
static

Adds directories to set of managed directories.

Parameters
[in]MountPointA group of directories to be added.
Returns
Nothing

This method adds new mount points to the list managed mount points. It is careful to check to see if any of the entries in MountPoints are already being managed and only adds the entries from MountPoints which are not currently being managed.

◆ Add() [2/3]

static void GenericAPI::MountPointStatus::Add ( const mount_point_list_type MountPoint)
static

Adds directories to set of managed directories.

Parameters
[in]MountPointA group of directories to be added.
Returns
Nothing

◆ Add() [3/3]

static void GenericAPI::MountPointStatus::Add ( const mount_point_list_type MountPoint)
static

Adds directories to set of managed directories.

Parameters
[in]MountPointA group of directories to be added.
Returns
Nothing

◆ Initialize() [1/3]

static bool GenericAPI::MountPointStatus::Initialize ( )
static

Initialize the class.

Returns
True if initialization completes successfully, false otherwise.

◆ Initialize() [2/3]

static bool GenericAPI::MountPointStatus::Initialize ( )
static

Initialize the class.

Returns
True if initialization completes successfully, false otherwise.

◆ Initialize() [3/3]

bool GenericAPI::MountPointStatus::Initialize ( )
static

Initialize the class.

Returns
True if initialization completes successfully, false otherwise.

◆ IsDirManaged() [1/3]

static bool GenericAPI::MountPointStatus::IsDirManaged ( const std::string &  Dir)
static

Checks if directory is being managed.

Parameters
[in]DirThe name of a file or directory on the file system
Returns
If their is an exact match, then true is returned, false otherwise.

◆ IsDirManaged() [2/3]

static bool GenericAPI::MountPointStatus::IsDirManaged ( const std::string &  Dir)
static

Checks if directory is being managed.

Parameters
[in]DirThe name of a file or directory on the file system
Returns
If their is an exact match, then true is returned, false otherwise.

◆ IsDirManaged() [3/3]

bool GenericAPI::MountPointStatus::IsDirManaged ( const std::string &  Dir)
static

Checks if directory is being managed.

Parameters
[in]DirThe name of a file or directory on the file system
Returns
If their is an exact match, then true is returned, false otherwise.

Verifies that Dir exists as an element of the set of currently managed directories. If their is an exact match, then true is returned, false otherwise.

◆ Remove() [1/3]

void GenericAPI::MountPointStatus::Remove ( const mount_point_list_type MountPoint)
static

Removes directories from the set of managed directories.

Parameters
[in]MountPointA group of directories to be removed.
Returns
Nothing

◆ Remove() [2/3]

static void GenericAPI::MountPointStatus::Remove ( const mount_point_list_type MountPoint)
static

Removes directories from the set of managed directories.

Parameters
[in]MountPointA group of directories to be removed.
Returns
Nothing

◆ Remove() [3/3]

static void GenericAPI::MountPointStatus::Remove ( const mount_point_list_type MountPoint)
static

Removes directories from the set of managed directories.

Parameters
[in]MountPointA group of directories to be removed.
Returns
Nothing

◆ Set() [1/6]

void GenericAPI::MountPointStatus::Set ( const mount_point_list_type MountPoint)
static

Resets the set of directories to be managed.

Parameters
[in]MountPointA group of directories to be managed.
Returns
Nothing

◆ Set() [2/6]

static void GenericAPI::MountPointStatus::Set ( const mount_point_list_type MountPoint)
static

Resets the set of directories to be managed.

Parameters
[in]MountPointA group of directories to be managed.
Returns
Nothing

◆ Set() [3/6]

static void GenericAPI::MountPointStatus::Set ( const mount_point_list_type MountPoint)
static

Resets the set of directories to be managed.

Parameters
[in]MountPointA group of directories to be managed.
Returns
Nothing

◆ Set() [4/6]

static void GenericAPI::MountPointStatus::Set ( const std::vector< std::string > &  MountPoint)
static

Resets the set of directories to be managed.

Parameters
[in]MountPointA group of directories to be managed.
Returns
Nothing

◆ Set() [5/6]

void GenericAPI::MountPointStatus::Set ( const std::vector< std::string > &  MountPoint)
inlinestatic

Resets the set of directories to be managed.

Parameters
[in]MountPointA group of directories to be managed.
Returns
Nothing

◆ Set() [6/6]

static void GenericAPI::MountPointStatus::Set ( const std::vector< std::string > &  MountPoint)
static

Resets the set of directories to be managed.

Parameters
[in]MountPointA group of directories to be managed.
Returns
Nothing

◆ Status() [1/3]

static state_type GenericAPI::MountPointStatus::Status ( const std::string &  Path)
static

Returns the on-line status of the file system.

Parameters
[in]PathThe Path to a file or directory on the file system for which the on-line status is being queried.
Returns
The on-line status of the file system.

◆ Status() [2/3]

static state_type GenericAPI::MountPointStatus::Status ( const std::string &  Path)
static

Returns the on-line status of the file system.

Parameters
[in]PathThe Path to a file or directory on the file system for which the on-line status is being queried.
Returns
The on-line status of the file system.

◆ Status() [3/3]

MountPointStatus::state_type GenericAPI::MountPointStatus::Status ( const std::string &  Path)
static

Returns the on-line status of the file system.

Parameters
[in]PathThe Path to a file or directory on the file system for which the on-line status is being queried.
Returns
The on-line status of the file system.

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