BESCatalog Class Reference

abstract base class catalog object. Derived classes know how to show nodes and leaves in a catalog. More...

#include <BESCatalog.h>

Inheritance diagram for BESCatalog:

Inheritance graph
[legend]
Collaboration diagram for BESCatalog:

Collaboration graph
[legend]
List of all members.

Public Member Functions

virtual ~BESCatalog (void)
virtual string get_catalog_name ()
virtual bool show_catalog (const string &container, const string &catalog_or_info, BESInfo *info)=0
virtual void dump (ostream &strm) const =0
 dump the contents of this object to the specified ostream

Protected Member Functions

 BESCatalog (const string &catalog_name)

Detailed Description

abstract base class catalog object. Derived classes know how to show nodes and leaves in a catalog.

Definition at line 47 of file BESCatalog.h.


Constructor & Destructor Documentation

BESCatalog::BESCatalog ( const string &  catalog_name  )  [inline, protected]

Definition at line 53 of file BESCatalog.h.

virtual BESCatalog::~BESCatalog ( void   )  [inline, virtual]

Definition at line 56 of file BESCatalog.h.


Member Function Documentation

virtual string BESCatalog::get_catalog_name (  )  [inline, virtual]

Definition at line 58 of file BESCatalog.h.

Referenced by BESCatalogList::add_catalog().

virtual bool BESCatalog::show_catalog ( const string &  container,
const string &  catalog_or_info,
BESInfo info 
) [pure virtual]

Implemented in BESCatalogDirectory.

virtual void BESCatalog::dump ( ostream &  strm  )  const [pure 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.

Implemented in BESCatalogDirectory.


The documentation for this class was generated from the following file:
Generated on Wed Aug 29 03:28:05 2007 for OPeNDAP Back End Server (BES) by  doxygen 1.5.2