Holds real data, container type and constraint for symbolic name read from persistence. More...

#include <BESFileContainer.h>

Inheritance diagram for BESFileContainer:

Collaboration diagram for BESFileContainer:

Public Member Functions
virtual std::string	access ()
	returns the name of a file to access for this container, uncompressing if necessary.

	BESFileContainer (const BESFileContainer &copy_from)
	make a copy of the container

	BESFileContainer (const std::string &sym_name, const std::string &real_name, const std::string &type)
	construct a container representing a file

virtual void	dump (std::ostream &strm) const
	Displays debug information about this object.

std::string	get_attributes () const
	retrieve the attributes desired from this container

std::string	get_constraint () const
	retrieve the constraint expression for this container

std::string	get_container_type () const
	retrieve the type of data this container holds, such as cedar or netcdf.

std::string	get_dap4_constraint () const
	retrieve the constraint expression for this container

std::string	get_dap4_function () const
	retrieve the constraint expression for this container

std::string	get_real_name () const
	retrieve the real name for this container, such as a file name.

std::string	get_relative_name () const
	Get the relative name of the object in this container.

std::string	get_symbolic_name () const
	retrieve the symbolic name for this container

virtual BESContainer *	ptr_duplicate ()
	duplicate this instances of BESFileContainer

virtual bool	release ()
	release the file

void	set_attributes (const std::string &attrs)
	set desired attributes for this container

void	set_constraint (const std::string &s)
	set the constraint for this container

void	set_container_type (const std::string &type)
	set the type of data that this container represents, such as cedar or netcdf.

void	set_dap4_constraint (const std::string &s)
	set the constraint for this container

void	set_dap4_function (const std::string &s)
	set the constraint for this container

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.

void	set_relative_name (const std::string &relative)
	Set the relative name of the object in this container.

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 &copy_to)

Detailed Description

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.

See also: BESFileContainerStorage

Definition at line 56 of file BESFileContainer.h.

Constructor & Destructor Documentation

◆ BESFileContainer() [1/2]

BESFileContainer::BESFileContainer	(	const std::string &	sym_name,
		const std::string &	real_name,
		const std::string &	type )

construct a container representing a file

Parameters

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 62 of file BESFileContainer.cc.

◆ BESFileContainer() [2/2]

BESFileContainer::BESFileContainer ( const BESFileContainer & copy_from )

make a copy of the container

Parameters

copy_from The container to copy

Definition at line 76 of file BESFileContainer.cc.

◆ ~BESFileContainer()

virtual BESFileContainer::~BESFileContainer ( )

inlinevirtual

Definition at line 78 of file BESFileContainer.h.

Member Function Documentation

◆ _duplicate()

void BESFileContainer::_duplicate ( BESContainer & copy_to )

protectedvirtual

Definition at line 80 of file BESFileContainer.cc.

◆ access()

string BESFileContainer::access ( )

virtual

returns the name of a file to access for this container, uncompressing if necessary.

Returns: name of file to access

Implements BESContainer.

Definition at line 102 of file BESFileContainer.cc.

◆ dump()

void BESFileContainer::dump ( std::ostream & strm ) const

virtual

Displays debug information about this object.

dumps information about this object

Parameters

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.

Parameters

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

Reimplemented from BESContainer.

Definition at line 150 of file BESFileContainer.cc.

◆ get_attributes()

std::string BESContainer::get_attributes ( ) const

inlineinherited

retrieve the attributes desired from this container

Returns: attributes desired from this container

Definition at line 243 of file BESContainer.h.

◆ get_constraint()

std::string BESContainer::get_constraint ( ) const

inlineinherited

retrieve the constraint expression for this container

Returns: constraint expression for this execution for the symbolic name

Definition at line 195 of file BESContainer.h.

◆ get_container_type()

std::string BESContainer::get_container_type ( ) const

inlineinherited

retrieve the type of data this container holds, such as cedar or netcdf.

Returns: type of data this container represents, such as cedar or netcdf

Definition at line 233 of file BESContainer.h.

◆ get_dap4_constraint()

std::string BESContainer::get_dap4_constraint ( ) const

inlineinherited

retrieve the constraint expression for this container

Returns: constraint expression for this execution for the symbolic name

Definition at line 204 of file BESContainer.h.

◆ get_dap4_function()

std::string BESContainer::get_dap4_function ( ) const

inlineinherited

retrieve the constraint expression for this container

Returns: constraint expression for this execution for the symbolic name

Definition at line 213 of file BESContainer.h.

◆ get_real_name()

std::string BESContainer::get_real_name ( ) const

inlineinherited

retrieve the real name for this container, such as a file name.

Returns: real name, such as file name

Definition at line 181 of file BESContainer.h.

◆ get_relative_name()

std::string BESContainer::get_relative_name ( ) const

inlineinherited

Get the relative name of the object in this container.

Definition at line 187 of file BESContainer.h.

◆ get_symbolic_name()

std::string BESContainer::get_symbolic_name ( ) const

inlineinherited

retrieve the symbolic name for this container

Returns: symbolic name for this container

Definition at line 222 of file BESContainer.h.

◆ ptr_duplicate()

BESContainer * BESFileContainer::ptr_duplicate ( )

virtual

duplicate this instances of BESFileContainer

Returns: a copy of this instance

Implements BESContainer.

Definition at line 90 of file BESFileContainer.cc.

◆ release()

bool BESFileContainer::release ( )

virtual

release the file

If the file was cached (uncompressed) then we need to release the lock on the cached entry

Todo: Call this in the dtor? jhrg 7/25/18

Returns: if successfully released, returns true, otherwise returns false

Implements BESContainer.

Definition at line 134 of file BESFileContainer.cc.

◆ set_attributes()

void BESContainer::set_attributes ( const std::string & attrs )

inlineinherited

set desired attributes for this container

Parameters

attrs attributes desired to access for this container

Definition at line 171 of file BESContainer.h.

◆ set_constraint()

void BESContainer::set_constraint ( const std::string & s )

inlineinherited

set the constraint for this container

Parameters

s	constraint

Definition at line 119 of file BESContainer.h.

◆ set_container_type()

void BESContainer::set_container_type ( const std::string & type )

inlineinherited

set the type of data that this container represents, such as cedar or netcdf.

Parameters

type	type of data, such as cedar or netcdf

Definition at line 162 of file BESContainer.h.

◆ set_dap4_constraint()

void BESContainer::set_dap4_constraint ( const std::string & s )

inlineinherited

set the constraint for this container

Parameters

s	constraint

Definition at line 128 of file BESContainer.h.

◆ set_dap4_function()

void BESContainer::set_dap4_function ( const std::string & s )

inlineinherited

set the constraint for this container

Parameters

s	constraint

Definition at line 137 of file BESContainer.h.

◆ set_real_name()

void BESContainer::set_real_name ( const std::string & real_name )

inlineinherited

set the real name for this container, such as a file name if reading a data file.

Parameters

real_name real name, such as the file name

Definition at line 147 of file BESContainer.h.

◆ set_relative_name()

void BESContainer::set_relative_name ( const std::string & relative )

inlineinherited

Set the relative name of the object in this container.

Definition at line 153 of file BESContainer.h.

Member Data Documentation

◆ UNCOMPRESS_CACHE_DIR_KEY

const std::string BESFileContainer::UNCOMPRESS_CACHE_DIR_KEY

static

Definition at line 69 of file BESFileContainer.h.

◆ UNCOMPRESS_CACHE_PREFIX_KEY

const std::string BESFileContainer::UNCOMPRESS_CACHE_PREFIX_KEY

static

Definition at line 70 of file BESFileContainer.h.

◆ UNCOMPRESS_CACHE_SIZE_KEY

const std::string BESFileContainer::UNCOMPRESS_CACHE_SIZE_KEY

static

Definition at line 71 of file BESFileContainer.h.

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

Public Member Functions

Static Public Attributes

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ BESFileContainer() [1/2]

◆ BESFileContainer() [2/2]

◆ ~BESFileContainer()

Member Function Documentation

◆ _duplicate()

◆ access()

◆ dump()

◆ get_attributes()

◆ get_constraint()

◆ get_container_type()

◆ get_dap4_constraint()

◆ get_dap4_function()

◆ get_real_name()

◆ get_relative_name()

◆ get_symbolic_name()

◆ ptr_duplicate()

◆ release()

◆ set_attributes()

◆ set_constraint()

◆ set_container_type()

◆ set_dap4_constraint()

◆ set_dap4_function()

◆ set_real_name()

◆ set_relative_name()

Member Data Documentation

◆ UNCOMPRESS_CACHE_DIR_KEY

◆ UNCOMPRESS_CACHE_PREFIX_KEY

◆ UNCOMPRESS_CACHE_SIZE_KEY