bes
Updated for version 3.20.6
|
Holds real data, container type and constraint for symbolic name read from persistence. More...
#include <BESFileContainer.h>
Public Member Functions | |
virtual std::string | access () |
returns the name of a file to access for this container, uncompressing if necessary. More... | |
BESFileContainer (const BESFileContainer ©_from) | |
make a copy of the container More... | |
BESFileContainer (const std::string &sym_name, const std::string &real_name, const std::string &type) | |
construct a container representing a file More... | |
virtual void | dump (std::ostream &strm) const |
Displays debug information about this object. More... | |
std::string | get_attributes () const |
retrieve the attributes desired from this container More... | |
std::string | get_constraint () const |
retrieve the constraint expression for this container More... | |
std::string | get_container_type () const |
retrieve the type of data this container holds, such as cedar or netcdf. More... | |
std::string | get_dap4_constraint () const |
retrieve the constraint expression for this container More... | |
std::string | get_dap4_function () const |
retrieve the constraint expression for this container More... | |
std::string | get_real_name () const |
retrieve the real name for this container, such as a file name. More... | |
std::string | get_relative_name () const |
Get the relative name of the object in this container. More... | |
std::string | get_symbolic_name () const |
retrieve the symbolic name for this container More... | |
virtual BESContainer * | ptr_duplicate () |
duplicate this instances of BESFileContainer More... | |
virtual bool | release () |
release the file More... | |
void | set_attributes (const std::string &attrs) |
set desired attributes for this container More... | |
void | set_constraint (const std::string &s) |
set the constraint for this container More... | |
void | set_container_type (const std::string &type) |
set the type of data that this container represents, such as cedar or netcdf. More... | |
void | set_dap4_constraint (const std::string &s) |
set the constraint for this container More... | |
void | set_dap4_function (const std::string &s) |
set the constraint for this container More... | |
void | set_real_name (const std::string &real_name) |
set the real name for this container, such as a file name if reading a data file. More... | |
void | set_relative_name (const std::string &relative) |
Set the relative name of the object in this container. More... | |
Static Public Attributes | |
static const std::string | UNCOMPRESS_CACHE_DIR_KEY |
static const std::string | UNCOMPRESS_CACHE_PREFIX_KEY |
static const std::string | UNCOMPRESS_CACHE_SIZE_KEY |
Protected Member Functions | |
virtual void | _duplicate (BESContainer ©_to) |
Holds real data, container type and constraint for symbolic name read from persistence.
A symbolic name is a name that represents a certain set of data, usually a file, and the type of data, such as cedar, netcdf, hdf, etc... Associated with this symbolic name during run time is the constraint associated with the name.
The symbolic name is looked up in persistence, such as a MySQL database, a file, or even in memory. The information retrieved from the persistent source is saved in the BESFileContainer and is used to execute the request from the client.
Definition at line 56 of file BESFileContainer.h.
BESFileContainer::BESFileContainer | ( | const std::string & | sym_name, |
const std::string & | real_name, | ||
const std::string & | type | ||
) |
construct a container representing a file
sym_name | symbolic name of the container |
real_name | real name of the container, a file name in this case |
type | type of the data represented in the file |
Definition at line 54 of file BESFileContainer.cc.
BESFileContainer::BESFileContainer | ( | const BESFileContainer & | copy_from | ) |
make a copy of the container
copy_from | The container to copy |
Definition at line 68 of file BESFileContainer.cc.
|
virtual |
returns the name of a file to access for this container, uncompressing if necessary.
Implements BESContainer.
Definition at line 94 of file BESFileContainer.cc.
|
virtual |
Displays debug information about this object.
dumps information about this object
strm | output stream to use to dump the contents of this object |
Displays the pointer value of this instance along with information about this container.
strm | C++ i/o stream to dump the information to |
Reimplemented from BESContainer.
Definition at line 142 of file BESFileContainer.cc.
|
inlineinherited |
retrieve the attributes desired from this container
Definition at line 242 of file BESContainer.h.
|
inlineinherited |
retrieve the constraint expression for this container
Definition at line 194 of file BESContainer.h.
|
inlineinherited |
retrieve the type of data this container holds, such as cedar or netcdf.
Definition at line 232 of file BESContainer.h.
|
inlineinherited |
retrieve the constraint expression for this container
Definition at line 203 of file BESContainer.h.
|
inlineinherited |
retrieve the constraint expression for this container
Definition at line 212 of file BESContainer.h.
|
inlineinherited |
retrieve the real name for this container, such as a file name.
Definition at line 180 of file BESContainer.h.
|
inlineinherited |
Get the relative name of the object in this container.
Definition at line 186 of file BESContainer.h.
|
inlineinherited |
retrieve the symbolic name for this container
Definition at line 221 of file BESContainer.h.
|
virtual |
duplicate this instances of BESFileContainer
Implements BESContainer.
Definition at line 82 of file BESFileContainer.cc.
|
virtual |
release the file
If the file was cached (uncompressed) then we need to release the lock on the cached entry
Implements BESContainer.
Definition at line 126 of file BESFileContainer.cc.
|
inlineinherited |
set desired attributes for this container
attrs | attributes desired to access for this container |
Definition at line 170 of file BESContainer.h.
|
inlineinherited |
set the constraint for this container
s | constraint |
Definition at line 118 of file BESContainer.h.
|
inlineinherited |
set the type of data that this container represents, such as cedar or netcdf.
type | type of data, such as cedar or netcdf |
Definition at line 161 of file BESContainer.h.
|
inlineinherited |
set the constraint for this container
s | constraint |
Definition at line 127 of file BESContainer.h.
|
inlineinherited |
set the constraint for this container
s | constraint |
Definition at line 136 of file BESContainer.h.
|
inlineinherited |
set the real name for this container, such as a file name if reading a data file.
real_name | real name, such as the file name |
Definition at line 146 of file BESContainer.h.
|
inlineinherited |
Set the relative name of the object in this container.
Definition at line 152 of file BESContainer.h.