bes
Updated for version 3.20.6
|
A container is something that holds data. E.G., a netcdf file or a database entry. More...
#include <BESContainer.h>
Public Member Functions | |
virtual std::string | access ()=0 |
returns the true name of this container More... | |
virtual void | dump (std::ostream &strm) const |
dumps 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 ()=0 |
pure abstract method to duplicate this instances of BESContainer More... | |
virtual bool | release ()=0 |
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... | |
Protected Member Functions | |
void | _duplicate (BESContainer ©_to) |
duplicate this instance into the passed container More... | |
BESContainer (const BESContainer ©_from) | |
make a copy of the passed container More... | |
BESContainer (const std::string &sym_name, const std::string &real_name, const std::string &type) | |
construct a container with the given symbolic name, real name and container type. More... | |
A container is something that holds data. E.G., a netcdf file or a database entry.
A symbolic name is a name that represents a set of data, such as a file, and the type of data, such as cedar, netcdf, hdf, etc... Associated with this symbolic name during run time is a constraint expression used to constrain the data and attributes desired from the container.
The symbolic name is looked up in persistence, such as a MySQL database, a file, or in volatile memory. The information retrieved from the persistent source is saved in the BESContainer and is used to execute the request from the client.
Definition at line 65 of file BESContainer.h.
|
inlineprotected |
construct a container with the given symbolic name, real name and container type.
sym_name | symbolic name |
real_name | real name of the container, such as a file name |
type | type of data represented by this container, such as netcdf |
Definition at line 94 of file BESContainer.h.
|
protected |
make a copy of the passed container
copy_from | The container to copy |
Definition at line 42 of file BESContainer.cc.
|
protected |
duplicate this instance into the passed container
copy_to | The container to copy this instance into |
Definition at line 54 of file BESContainer.cc.
|
pure virtual |
returns the true name of this container
The true name of this container might be an uncompressed file name from the compressed file name represented by the real name of this container. This method would uncompress the real name and return the uncompressed file name. Another example is where the real name represents a WCS request. The access method would make the WCS request and return the name of the resulting file.
Implemented in BESFileContainer, cmr::CmrContainer, gateway::GatewayContainer, and httpd_catalog::HttpdCatalogContainer.
|
virtual |
dumps information about 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 |
Implements BESObj.
Reimplemented in BESFileContainer, cmr::CmrContainer, gateway::GatewayContainer, and httpd_catalog::HttpdCatalogContainer.
Definition at line 73 of file BESContainer.cc.
|
inline |
retrieve the attributes desired from this container
Definition at line 242 of file BESContainer.h.
|
inline |
retrieve the constraint expression for this container
Definition at line 194 of file BESContainer.h.
|
inline |
retrieve the type of data this container holds, such as cedar or netcdf.
Definition at line 232 of file BESContainer.h.
|
inline |
retrieve the constraint expression for this container
Definition at line 203 of file BESContainer.h.
|
inline |
retrieve the constraint expression for this container
Definition at line 212 of file BESContainer.h.
|
inline |
retrieve the real name for this container, such as a file name.
Definition at line 180 of file BESContainer.h.
|
inline |
Get the relative name of the object in this container.
Definition at line 186 of file BESContainer.h.
|
inline |
retrieve the symbolic name for this container
Definition at line 221 of file BESContainer.h.
|
pure virtual |
pure abstract method to duplicate this instances of BESContainer
Implemented in BESFileContainer, cmr::CmrContainer, gateway::GatewayContainer, and httpd_catalog::HttpdCatalogContainer.
|
inline |
set desired attributes for this container
attrs | attributes desired to access for this container |
Definition at line 170 of file BESContainer.h.
|
inline |
set the constraint for this container
s | constraint |
Definition at line 118 of file BESContainer.h.
|
inline |
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.
|
inline |
set the constraint for this container
s | constraint |
Definition at line 127 of file BESContainer.h.
|
inline |
set the constraint for this container
s | constraint |
Definition at line 136 of file BESContainer.h.
|
inline |
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.
|
inline |
Set the relative name of the object in this container.
Definition at line 152 of file BESContainer.h.