Container representing a NCML request. More...

#include <NCMLContainer.h>

Inheritance diagram for NCMLContainer:

Collaboration diagram for NCMLContainer:

Public Member Functions
virtual string	access ()
	access the NCML target response by making the NCML request

void	dump (std::ostream &strm) const override
	dumps information about this object

virtual void	dump (ostream &strm) const
	dumps 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

	NCMLContainer (const NCMLContainer &copy_from)

	NCMLContainer (const string &sym_name, const string &real_name)

virtual BESContainer *	ptr_duplicate ()
	pure abstract method to duplicate this instances of BESContainer

virtual bool	release ()
	release the NCML cached resources

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.

Protected Member Functions
void	_duplicate (BESContainer &copy_to)
	duplicate this instance into the passed container

void	_duplicate (NCMLContainer &copy_to)

Detailed Description

Container representing a NCML request.

The real name of a NCMLContainer is the actual NCML request. When the access method is called the NCML request is made, the response cached if Successful, and the target response returned as the real container that a data handler would then open.

Note: This code is broken - but it was never actually used. The code closes the open stream that is returned using a value-result parameter in NCMLContainer::access but it should not be doing that. Instead is should keep the stream as a field and close it in the dtor. jhrg 8/12/15

See also: NCMLContainerStorage

Definition at line 54 of file NCMLContainer.h.

Constructor & Destructor Documentation

◆ NCMLContainer()

NCMLContainer::NCMLContainer ( const NCMLContainer & copy_from )

Definition at line 79 of file NCMLContainer.cc.

◆ ~NCMLContainer()

NCMLContainer::~NCMLContainer ( )

virtual

Definition at line 109 of file NCMLContainer.cc.

Member Function Documentation

◆ _duplicate() [1/2]

void BESContainer::_duplicate ( BESContainer & copy_to )

protectedinherited

duplicate this instance into the passed container

Parameters

copy_to The container to copy this instance into

Definition at line 54 of file BESContainer.cc.

◆ _duplicate() [2/2]

void NCMLContainer::_duplicate ( NCMLContainer & copy_to )

protected

Definition at line 90 of file NCMLContainer.cc.

◆ access()

string NCMLContainer::access ( )

virtual

access the NCML target response by making the NCML request

Returns: full path to the NCML request response data file

Exceptions

BESError if there is a problem making the NCML request

Implements BESContainer.

Definition at line 121 of file NCMLContainer.cc.

◆ dump() [1/2]

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

overridevirtualinherited

dumps information about 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

Implements BESObj.

Reimplemented in BESFileContainer, builddmrpp::NgapBuildDmrppContainer, cmr::CmrContainer, gateway::GatewayContainer, httpd_catalog::HttpdCatalogContainer, ngap::NgapOwnedContainer, and s3::S3Container.

Definition at line 73 of file BESContainer.cc.

◆ dump() [2/2]

void NCMLContainer::dump ( ostream & strm ) const

virtual

dumps information about 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

Definition at line 204 of file NCMLContainer.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 * NCMLContainer::ptr_duplicate ( )

virtual

pure abstract method to duplicate this instances of BESContainer

Implements BESContainer.

Definition at line 102 of file NCMLContainer.cc.

◆ release()

bool NCMLContainer::release ( )

virtual

release the NCML cached resources

Release the resource

Returns: true if the resource is released successfully and false otherwise

Implements BESContainer.

Definition at line 187 of file NCMLContainer.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.

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

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ NCMLContainer()

◆ ~NCMLContainer()

Member Function Documentation

◆ _duplicate() [1/2]

◆ _duplicate() [2/2]

◆ access()

◆ dump() [1/2]

◆ dump() [2/2]

◆ 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()