Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members

BESContainerStorageVolatile Class Reference

implementation of BESContainerStorage that stores containers for the duration of this process. More...

#include <BESContainerStorageVolatile.h>

Inheritance diagram for BESContainerStorageVolatile:

[legend]
Collaboration diagram for BESContainerStorageVolatile:
[legend]
List of all members.

Public Types

typedef map< string, BESContainer
* >::const_iterator 
Container_citer
typedef map< string, BESContainer
* >::iterator 
Container_iter

Public Member Functions

 BESContainerStorageVolatile (const string &n)
 create an instance of this persistent store with the given name.
virtual ~BESContainerStorageVolatile ()
virtual void look_for (BESContainer &d)
 looks for the specified container using the given name
virtual void add_container (const string &s_name, const string &r_name, const string &type)
 adds a container with the provided information
virtual bool del_container (const string &s_name)
 removes a container with the given symbolic name
virtual bool del_containers ()
 removes all container
virtual void show_containers (BESInfo &info)
 show information for each container in this persistent store
virtual void dump (ostream &strm) const
 dumps information about this object
virtual const string & get_name () const
 retrieve the name of this persistent store

Protected Attributes

string _root_dir
string _my_name

Detailed Description

implementation of BESContainerStorage that stores containers for the duration of this process.

This implementation of BESContainerStorage stores volatile containers for the duration of this process. A list of containers is stored in the object. The look_for method simply looks for the specified symbolic name in the list of containers and returns if a match is found. Containers can be added to this instance as long as the symbolic name doesn't already exist.

See also:
BESContainerStorage

BESContainer


Member Typedef Documentation

typedef map< string, BESContainer * >::const_iterator BESContainerStorageVolatile::Container_citer
 

typedef map< string, BESContainer * >::iterator BESContainerStorageVolatile::Container_iter
 


Constructor & Destructor Documentation

BESContainerStorageVolatile::BESContainerStorageVolatile const string &  n  ) 
 

create an instance of this persistent store with the given name.

Creates an instances of BESContainerStorageVolatile with the given name.

Parameters:
n name of this persistent store
See also:
BESContainer

BESContainerStorageVolatile::~BESContainerStorageVolatile  )  [virtual]
 


Member Function Documentation

void BESContainerStorageVolatile::add_container const string &  s_name,
const string &  r_name,
const string &  type
[virtual]
 

adds a container with the provided information

This method adds a container to the persistence store with the specified information.

Parameters:
s_name symbolic name for the container
r_name real name for the container
type type of data represented by this container

Implements BESContainerStorage.

Reimplemented in BESContainerStorageCatalog.

bool BESContainerStorageVolatile::del_container const string &  s_name  )  [virtual]
 

removes a container with the given symbolic name

This method removes a container to the persistence store with the given symbolic name. It deletes the container.

Parameters:
s_name symbolic name for the container
Returns:
true if successfully removed and false otherwise

Implements BESContainerStorage.

bool BESContainerStorageVolatile::del_containers  )  [virtual]
 

removes all container

This method removes all containers from the persistent store. It does not delete the real data behind the container.

Returns:
true if successfully removed and false otherwise

Implements BESContainerStorage.

void BESContainerStorageVolatile::dump ostream &  strm  )  const [virtual]
 

dumps information about this object

Displays the pointer value of this instance along with information about the containers stored in this volatile list.

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

Implements BESContainerStorage.

Reimplemented in BESContainerStorageCatalog.

virtual const string& BESContainerStorage::get_name  )  const [inline, virtual, inherited]
 

retrieve the name of this persistent store

Returns:
name of this persistent store.

void BESContainerStorageVolatile::look_for BESContainer d  )  [virtual]
 

looks for the specified container using the given name

If a match is made with the symbolic name found in the container then the information is stored in the passed container object and the is_valid flag is set to true. If not found, then is_valid is set to false.

Parameters:
d container to look for and, if found, store the information in.

Implements BESContainerStorage.

void BESContainerStorageVolatile::show_containers BESInfo info  )  [virtual]
 

show information for each container in this persistent store

For each container in this persistent store, add infomation about each of those containers. The information added to the information object includes a line for each container within this persistent store which includes the symbolic name, the real name, and the data type, separated by commas.

In the case of this persistent store information from each container added to the volatile list is added to the information object.

Parameters:
info object to store the container and persistent store information
See also:
BESInfo

Implements BESContainerStorage.


Member Data Documentation

string BESContainerStorage::_my_name [protected, inherited]
 

string BESContainerStorageVolatile::_root_dir [protected]
 


The documentation for this class was generated from the following files:
Generated on Thu May 3 23:10:58 2007 for OPeNDAP Back End Server (BES) by  doxygen 1.4.4