BESCatalogUtils Class Reference

#include <BESCatalogUtils.h>

Inheritance diagram for BESCatalogUtils:

Inheritance graph
[legend]
Collaboration diagram for BESCatalogUtils:

Collaboration graph
[legend]
List of all members.

Public Types

typedef vector< type_reg
>::const_iterator 
match_citer

Public Member Functions

 BESCatalogUtils (const string &name)
virtual void dump (ostream &strm) const
 dump the contents of this object to the specified ostream
virtual bool exclude (const string &inQuestion) const
bool follow_sym_links () const
const string & get_root_dir () const
virtual bool include (const string &inQuestion) const
BESCatalogUtils::match_citer match_list_begin () const
BESCatalogUtils::match_citer match_list_end () const
virtual ~BESCatalogUtils ()

Static Public Member Functions

static const BESCatalogUtilsUtils (const string &name)

Classes

struct  type_reg

Detailed Description

Definition at line 49 of file BESCatalogUtils.h.


Member Typedef Documentation

typedef vector< type_reg >::const_iterator BESCatalogUtils::match_citer

Definition at line 78 of file BESCatalogUtils.h.


Constructor & Destructor Documentation

BESCatalogUtils::BESCatalogUtils ( const string &  name  ) 

Definition at line 57 of file BESCatalogUtils.cc.

References BESUtil::explode(), BESKeys::get_value(), BESKeys::get_values(), BESUtil::lowercase(), BESCatalogUtils::type_reg::reg, TheBESKeys::TheKeys(), and BESCatalogUtils::type_reg::type.

Here is the call graph for this function:

virtual BESCatalogUtils::~BESCatalogUtils (  )  [inline, virtual]

Definition at line 72 of file BESCatalogUtils.h.


Member Function Documentation

void BESCatalogUtils::dump ( ostream &  strm  )  const [virtual]

dump the contents of this object to the specified ostream

This method is implemented by all derived classes to dump their contents, in other words, any state they might have, private variables, etc...

The inline function below can be used to dump the contents of an OPeNDAOObj object. For example, the object Animal is derived from BESObj. A user could do the following:

Animal *a = new dog( "Sparky" ) ; cout << a << endl ;

And the dump method for dog could display the name passed into the constructor, the (this) pointer of the object, etc...

Parameters:
strm C++ i/o stream to dump the object to

Implements BESObj.

Definition at line 243 of file BESCatalogUtils.cc.

References BESIndent::Indent(), BESIndent::LMarg(), and BESIndent::UnIndent().

Referenced by BESContainerStorageCatalog::dump(), and BESCatalogDirectory::dump().

Here is the call graph for this function:

bool BESCatalogUtils::exclude ( const string &  inQuestion  )  const [virtual]

Definition at line 203 of file BESCatalogUtils.cc.

Referenced by BESContainerStorageCatalog::add_container(), include(), and BESCatalogDirectory::show_catalog().

bool BESCatalogUtils::follow_sym_links (  )  const [inline]

Definition at line 74 of file BESCatalogUtils.h.

Referenced by BESContainerStorageCatalog::BESContainerStorageCatalog(), and BESCatalogDirectory::show_catalog().

const string& BESCatalogUtils::get_root_dir (  )  const [inline]

Definition at line 73 of file BESCatalogUtils.h.

Referenced by BESContainerStorageCatalog::BESContainerStorageCatalog(), and BESCatalogDirectory::show_catalog().

bool BESCatalogUtils::include ( const string &  inQuestion  )  const [virtual]

Definition at line 152 of file BESCatalogUtils.cc.

References exclude().

Referenced by BESContainerStorageCatalog::add_container(), and BESCatalogDirectory::show_catalog().

Here is the call graph for this function:

BESCatalogUtils::match_citer BESCatalogUtils::match_list_begin (  )  const

Definition at line 231 of file BESCatalogUtils.cc.

Referenced by BESContainerStorageCatalog::add_container(), and BESContainerStorageCatalog::isData().

BESCatalogUtils::match_citer BESCatalogUtils::match_list_end (  )  const

Definition at line 237 of file BESCatalogUtils.cc.

Referenced by BESContainerStorageCatalog::add_container(), and BESContainerStorageCatalog::isData().

const BESCatalogUtils * BESCatalogUtils::Utils ( const string &  name  )  [static]

Definition at line 317 of file BESCatalogUtils.cc.

Referenced by BESCatalogDirectory::BESCatalogDirectory(), and BESContainerStorageCatalog::BESContainerStorageCatalog().


The documentation for this class was generated from the following files:
Generated on Thu Feb 11 09:15:33 2010 for OPeNDAP Hyrax Back End Server (BES) by  doxygen 1.4.7