bes  Updated for version 3.17.0
BESContainerStorageFile Class Reference

implementation of BESContainerStorage that represents a way to read container information from a file. More...

#include <BESContainerStorageFile.h>

Inheritance diagram for BESContainerStorageFile:
Inheritance graph

Public Member Functions

virtual void add_container (const string &sym_name, const string &real_name, const string &type)
 adds a container with the provided information More...
 
 BESContainerStorageFile (const string &n)
 pull container information from the specified file More...
 
virtual bool del_container (const string &s_name)
 removes a container with the given symbolic name More...
 
virtual bool del_containers ()
 removes all containers More...
 
virtual void dump (ostream &strm) const
 dumps information about this object More...
 
virtual const string & get_name () const
 retrieve the name of this persistent store More...
 
virtual bool isData (const string &inQuestion, list< string > &provides)
 determine if the given container is data and what servies are available for it More...
 
virtual BESContainerlook_for (const string &sym_name)
 looks for the specified container in the list of containers loaded from the file. More...
 
virtual void show_containers (BESInfo &info)
 show information for each container in this persistent store More...
 

Protected Member Functions

virtual void show_container (const string &sym_name, const string &real_name, const string &type, BESInfo &info)
 add information for a container to the informational response object More...
 

Protected Attributes

string _my_name
 

Detailed Description

This implementation of BESContainerStorage loads container information from a file. The name of the file is determined from the bes configuration file. The key is:

BES.Container.Persistence.File.<name>

where <name> is the name of this persistent store.

The format of the file is:

<symbolic_name> <real_name> <data type>

where the <symbolic_name> is the symbolic name of the container, the <real_name> represents the physical location of the data, such as a file, and the <data type> is the type of data being represented, such as netcdf, cedar, etc...

One container per line, cannot span multiple lines

See also
BESContainerStorage
BESFileContainer
BESKeys

Definition at line 70 of file BESContainerStorageFile.h.

Constructor & Destructor Documentation

BESContainerStorageFile::BESContainerStorageFile ( const string &  n)

Constructs a BESContainerStorageFile from a file specified by a key in the bes configuration file. The key is constructed using the name of this persistent store.

BES.Container.Persistence.File.<name>

where <name> is the name of this persistent store.

The containers are then read into memory. The format of the file is as follows.

<symbolic_name> <real_name> <data type>

where the symbolic name is the symbolic name of the container, the <real_name> represents the physical location of the data, such as a file, and the <data type> is the type of data being represented, such as netcdf, cedar, etc...

One container per line, cannot span multiple lines

Parameters
nname of this persistent store
Exceptions
BESInternalErrorif the file cannot be opened or if there is an error in reading in the container information.
See also
BESContainerStorage
BESFileContainer
BESInternalError

Definition at line 79 of file BESContainerStorageFile.cc.

References BESKeys::get_value(), and TheBESKeys::TheKeys().

Member Function Documentation

void BESContainerStorageFile::add_container ( const string &  sym_name,
const string &  real_name,
const string &  type 
)
virtual

This method adds a container to the persistence store with the specified information. This functionality is not currently supported for file persistence.

Parameters
sym_namesymbolic name for the container
real_namereal name for the container
typetype of data represented by this container

Implements BESContainerStorage.

Definition at line 199 of file BESContainerStorageFile.cc.

bool BESContainerStorageFile::del_container ( const string &  s_name)
virtual

This method removes a container to the persistence store with the given symbolic name. It deletes the container. The container is NOT removed from the file from which it was loaded, however.

Parameters
s_namesymbolic name for the container
Returns
true if successfully removes container, false otherwise

Implements BESContainerStorage.

Definition at line 217 of file BESContainerStorageFile.cc.

bool BESContainerStorageFile::del_containers ( )
virtual

This method removes all containers from the persistent store. The container is NOT removed from the file from which it was loaded, however.

Returns
true if successfully removes all containers, false otherwise

Implements BESContainerStorage.

Definition at line 243 of file BESContainerStorageFile.cc.

void BESContainerStorageFile::dump ( ostream &  strm) const
virtual

Displays the pointer value of this instance along with information about the containers in this storage

Parameters
strmC++ i/o stream to dump the information to

Implements BESContainerStorage.

Definition at line 321 of file BESContainerStorageFile.cc.

References BESContainerStorage::get_name().

virtual const string& BESContainerStorage::get_name ( ) const
inlinevirtualinherited
bool BESContainerStorageFile::isData ( const string &  inQuestion,
list< string > &  provides 
)
virtual
Parameters
inQuestionthe container in question
providesan output parameter for storing the list of services provided for this container

Implements BESContainerStorage.

Definition at line 266 of file BESContainerStorageFile.cc.

References BESContainer::get_container_type(), look_for(), and BESServiceRegistry::services_handled().

BESContainer * BESContainerStorageFile::look_for ( const string &  sym_name)
virtual

If a match is made with the specified symbolic name then a BESFileContainer instance is created using the the information found (real name and container type). If not found then NULL is returned.

Parameters
sym_namename of the container to look for
Returns
a new BESFileContainer if the sym_name is found in the file, else 0
See also
BESFileContainer

Implements BESContainerStorage.

Definition at line 172 of file BESContainerStorageFile.cc.

void BESContainerStorage::show_container ( const string &  sym_name,
const string &  real_name,
const string &  type,
BESInfo info 
)
protectedvirtualinherited
Parameters
sym_namesymbolic name of the container to add
real_namereal name, e.g. file name, of the container to add
typedata type of the container
infoThe BES information object to add container information to
See also
BESInfo

Definition at line 45 of file BESContainerStorage.cc.

void BESContainerStorageFile::show_containers ( BESInfo info)
virtual

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 all of the containers loaded from the file specified by the key BES.Container.Persistence.File.<store_name> is added to the information object.

Parameters
infoobject to store the container and persistent store information into
See also
BESInfo

Implements BESContainerStorage.

Definition at line 299 of file BESContainerStorageFile.cc.

References BESContainerStorage::show_container().


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