OPeNDAP Hyrax Back End Server (BES)  Updated for version 3.8.3
BESCatalog Class Referenceabstract

abstract base class catalog object. More...

#include <BESCatalog.h>

Inheritance diagram for BESCatalog:
Inheritance graph
Collaboration diagram for BESCatalog:
Collaboration graph

Public Member Functions

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

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)
inlineprotected

Definition at line 54 of file BESCatalog.h.

virtual BESCatalog::~BESCatalog ( void  )
inlinevirtual

Definition at line 58 of file BESCatalog.h.

Member Function Documentation

virtual unsigned int BESCatalog::dereference_catalog ( )
inlinevirtual

Definition at line 63 of file BESCatalog.h.

Referenced by BESCatalogList::deref_catalog().

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
strmC++ i/o stream to dump the object to

Implements BESObj.

Implemented in BESCatalogDirectory.

virtual string BESCatalog::get_catalog_name ( )
inlinevirtual
virtual void BESCatalog::reference_catalog ( )
inlinevirtual

Definition at line 59 of file BESCatalog.h.

Referenced by BESCatalogList::ref_catalog().

virtual void BESCatalog::show_catalog ( const string &  container,
const string &  catalog_or_info,
BESInfo info 
)
pure virtual

Implemented in BESCatalogDirectory.

Referenced by BESCatalogList::show_catalog().


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