#include <BESContainerStorageFile.h>
Inheritance diagram for BESContainerStorageFile:
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 | |
BESContainerStorageFile (const string &n) | |
pull container information from the specified file | |
virtual bool | del_container (const string &s_name) |
removes a container with the given symbolic name | |
virtual bool | del_containers () |
removes all containers | |
virtual void | dump (ostream &strm) const |
dumps information about this object | |
virtual const string & | get_name () const |
retrieve the name of this persistent store | |
virtual BESContainer * | look_for (const string &sym_name) |
looks for the specified container in the list of containers loaded from the file. | |
virtual void | show_containers (BESInfo &info) |
show information for each container in this persistent store | |
virtual | ~BESContainerStorageFile () |
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 | |
Protected Attributes | |
string | _my_name |
Classes | |
struct | _container |
This impelementation 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
Definition at line 70 of file BESContainerStorageFile.h.
BESContainerStorageFile::BESContainerStorageFile | ( | const string & | n | ) |
pull container information from the specified file
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
n | name of this persistent store |
BESInternalError | if the file cannot be opened or if there is an error in reading in the container information. |
Definition at line 78 of file BESContainerStorageFile.cc.
References BESKeys::get_value(), and TheBESKeys::TheKeys().
Here is the call graph for this function:
BESContainerStorageFile::~BESContainerStorageFile | ( | ) | [virtual] |
Definition at line 148 of file BESContainerStorageFile.cc.
void BESContainerStorageFile::add_container | ( | const string & | sym_name, | |
const string & | real_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. This functionality is not currently supported for file persistence.
sym_name | symbolic name for the container | |
real_name | real name for the container | |
type | type of data represented by this container |
Implements BESContainerStorage.
Definition at line 198 of file BESContainerStorageFile.cc.
bool BESContainerStorageFile::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. The container is NOT removed from the file from which it was loaded, however.
s_name | symbolic name for the container |
Implements BESContainerStorage.
Definition at line 216 of file BESContainerStorageFile.cc.
bool BESContainerStorageFile::del_containers | ( | ) | [virtual] |
removes all containers
This method removes all containers from the persistent store. The container is NOT removed from the file from which it was loaded, however.
Implements BESContainerStorage.
Definition at line 239 of file BESContainerStorageFile.cc.
void BESContainerStorageFile::dump | ( | ostream & | strm | ) | const [virtual] |
dumps information about this object
Displays the pointer value of this instance along with information about the containers in this storage
strm | C++ i/o stream to dump the information to |
Implements BESContainerStorage.
Definition at line 293 of file BESContainerStorageFile.cc.
References BESContainerStorage::get_name(), BESIndent::Indent(), BESIndent::LMarg(), and BESIndent::UnIndent().
Here is the call graph for this function:
virtual const string& BESContainerStorage::get_name | ( | ) | const [inline, virtual, inherited] |
retrieve the name of this persistent store
Definition at line 91 of file BESContainerStorage.h.
References BESContainerStorage::_my_name.
Referenced by BESContainerStorageList::add_persistence(), BESContainerStorageVolatile::dump(), dump(), BESContainerStorageCatalog::dump(), and BESContainerStorageVolatile::show_containers().
BESContainer * BESContainerStorageFile::look_for | ( | const string & | sym_name | ) | [virtual] |
looks for the specified container in the list of containers loaded from the file.
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.
sym_name | name of the container to look for |
Implements BESContainerStorage.
Definition at line 171 of file BESContainerStorageFile.cc.
void BESContainerStorage::show_container | ( | const string & | sym_name, | |
const string & | real_name, | |||
const string & | type, | |||
BESInfo & | info | |||
) | [protected, virtual, inherited] |
add information for a container to the informational response object
sym_name | symbolic name of the container to add | |
real_name | real name, e.g. file name, of the container to add | |
type | data type of the container | |
info | The BES information object to add container information to |
Definition at line 45 of file BESContainerStorage.cc.
References BESInfo::add_tag().
Referenced by BESContainerStorageVolatile::show_containers(), and show_containers().
Here is the call graph for this function:
void BESContainerStorageFile::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 all of the containers loaded from the file specified by the key BES.Container.Persistence.File.<store_name> is added to the information object.
info | object to store the container and persistent store information into |
Implements BESContainerStorage.
Definition at line 271 of file BESContainerStorageFile.cc.
References BESContainerStorage::show_container().
Here is the call graph for this function:
string BESContainerStorage::_my_name [protected, inherited] |