OPeNDAP Hyrax Back End Server (BES)  Updated for version 3.8.3
agg_util::GridJoinExistingAggregation Class Reference

#include <GridJoinExistingAggregation.h>

Inheritance diagram for agg_util::GridJoinExistingAggregation:
Inheritance graph
Collaboration diagram for agg_util::GridJoinExistingAggregation:
Collaboration graph

Public Member Functions

virtual const AMDListgetDatasetList () const
 Accessor for the dataset description list that describes this aggregation. More...
 
 GridJoinExistingAggregation (const libdap::Grid &proto, const AMDList &memberDatasets, const DDSLoader &loaderProto, const Dimension &joinDim)
 
 GridJoinExistingAggregation (const GridJoinExistingAggregation &proto)
 
auto_ptr< ArrayJoinExistingAggregationmakeAggregatedOuterMapVector () const
 Create a new map aggregated map vector for this aggregation, using its data templates, granule list, and outer dimension. More...
 
GridJoinExistingAggregationoperator= (const GridJoinExistingAggregation &rhs)
 
virtual GridJoinExistingAggregationptr_duplicate ()
 
virtual bool read ()
 Read in only those datasets that are in the constrained output making sure to apply the internal dimension constraints to the member datasets properly before reading them! Stream the data into the output buffer correctly. More...
 
void setShapeFrom (const libdap::Grid &protoSubGrid, bool addMaps)
 Use the data array and maps from protoSubGrid as the initial point for the shape of the Grid. More...
 
BaseType * transform_to_dap4 (libdap::D4Group *root, libdap::Constructor *container)
 
virtual ~GridJoinExistingAggregation ()
 

Protected Member Functions

void copyProtoMapsIntoThisGrid (const Dimension &aggDim)
 Copy the template's read in subgrid maps into this. More...
 
virtual const DimensiongetAggregationDimension () const
 Get the contained aggregation dimension info. More...
 
Grid * getSubGridTemplate ()
 Reveals the raw ptr, but only to subclasses. More...
 
void printConstraints (const libdap::Array &fromArray)
 
virtual void readAndAggregateConstrainedMapsHook ()
 Called from read()! Invokes the user hooks eventually. More...
 
void readProtoSubGrid ()
 Transfer constraints properly from this object's maps and read in the proto subgrid entirely (respecting constraints) More...
 
virtual void transferConstraintsToSubGridHook (Grid *pSubGrid)
 Required specialization for the read() call stack. More...
 

Detailed Description

Definition at line 40 of file GridJoinExistingAggregation.h.

Constructor & Destructor Documentation

agg_util::GridJoinExistingAggregation::GridJoinExistingAggregation ( const libdap::Grid &  proto,
const AMDList memberDatasets,
const DDSLoader loaderProto,
const Dimension joinDim 
)

Definition at line 46 of file GridJoinExistingAggregation.cc.

Referenced by ptr_duplicate().

agg_util::GridJoinExistingAggregation::GridJoinExistingAggregation ( const GridJoinExistingAggregation proto)

Definition at line 58 of file GridJoinExistingAggregation.cc.

agg_util::GridJoinExistingAggregation::~GridJoinExistingAggregation ( )
virtual

Definition at line 67 of file GridJoinExistingAggregation.cc.

Member Function Documentation

void agg_util::GridAggregationBase::copyProtoMapsIntoThisGrid ( const Dimension aggDim)
protectedinherited

Copy the template's read in subgrid maps into this.

Skip any map found in the subgrid named aggDim.name since we handle the aggregation dimension map specially.

Parameters
aggDima map with aggDim.name is NOT copied.

Definition at line 305 of file GridAggregationBase.cc.

References BESDEBUG_FUNC, agg_util::AggregationUtil::findMapByName(), agg_util::GridAggregationBase::getSubGridTemplate(), agg_util::Dimension::name, NCML_ASSERT_MSG, agg_util::GridAggregationBase::printConstraints(), and VALID_PTR.

Referenced by agg_util::GridAggregationBase::readAndAggregateConstrainedMapsHook().

Here is the call graph for this function:

const Dimension & agg_util::GridJoinExistingAggregation::getAggregationDimension ( ) const
protectedvirtual

Get the contained aggregation dimension info.

Implements agg_util::GridAggregationBase.

Definition at line 134 of file GridJoinExistingAggregation.cc.

const AMDList & agg_util::GridAggregationBase::getDatasetList ( ) const
virtualinherited

Accessor for the dataset description list that describes this aggregation.

Returns
a reference to the AggMemberDataset list.

Definition at line 185 of file GridAggregationBase.cc.

Referenced by makeAggregatedOuterMapVector().

Grid * agg_util::GridAggregationBase::getSubGridTemplate ( )
protectedinherited

Reveals the raw ptr, but only to subclasses.

Don't delete it, but can be changed etc.

Definition at line 230 of file GridAggregationBase.cc.

Referenced by agg_util::GridAggregationBase::copyProtoMapsIntoThisGrid(), makeAggregatedOuterMapVector(), and agg_util::GridAggregationBase::readProtoSubGrid().

auto_ptr< ArrayJoinExistingAggregation > agg_util::GridJoinExistingAggregation::makeAggregatedOuterMapVector ( ) const

Create a new map aggregated map vector for this aggregation, using its data templates, granule list, and outer dimension.

The returned variable will be have name joinDim.name and will be of shape with the joinDim. Does NOT add it to the maps! The caller will likely prepend it themselves as needed.

Returns
the new object wrapped as a source return.

Definition at line 92 of file GridJoinExistingAggregation.cc.

References BESDEBUG_FUNC, agg_util::AggregationUtil::findMapByName(), agg_util::GridAggregationBase::getDatasetList(), agg_util::GridAggregationBase::getSubGridTemplate(), agg_util::Dimension::name, and NCML_ASSERT_MSG.

Here is the call graph for this function:

GridJoinExistingAggregation & agg_util::GridJoinExistingAggregation::operator= ( const GridJoinExistingAggregation rhs)

Definition at line 80 of file GridJoinExistingAggregation.cc.

References agg_util::GridAggregationBase::operator=().

Here is the call graph for this function:

void agg_util::GridAggregationBase::printConstraints ( const libdap::Array &  fromArray)
protectedinherited
GridJoinExistingAggregation * agg_util::GridJoinExistingAggregation::ptr_duplicate ( )
virtual

Definition at line 74 of file GridJoinExistingAggregation.cc.

References GridJoinExistingAggregation().

Here is the call graph for this function:

bool agg_util::GridAggregationBase::read ( )
virtualinherited

Read in only those datasets that are in the constrained output making sure to apply the internal dimension constraints to the member datasets properly before reading them! Stream the data into the output buffer correctly.

NOTE: Subclasses should implement the protected hooks if possible rather than overriding this function!

Returns
success.

Definition at line 192 of file GridAggregationBase.cc.

References BESDEBUG_FUNC, agg_util::GridAggregationBase::printConstraints(), agg_util::GridAggregationBase::readAndAggregateConstrainedMapsHook(), and VALID_PTR.

Here is the call graph for this function:

void agg_util::GridAggregationBase::readAndAggregateConstrainedMapsHook ( )
protectedvirtualinherited

Called from read()! Invokes the user hooks eventually.

Can be overridden, but default calls should suffice for now.

Definition at line 259 of file GridAggregationBase.cc.

References agg_util::GridAggregationBase::copyProtoMapsIntoThisGrid(), agg_util::GridAggregationBase::getAggregationDimension(), and agg_util::GridAggregationBase::readProtoSubGrid().

Referenced by agg_util::GridAggregationBase::read().

Here is the call graph for this function:

void agg_util::GridAggregationBase::readProtoSubGrid ( )
protectedinherited

Transfer constraints properly from this object's maps and read in the proto subgrid entirely (respecting constraints)

Definition at line 285 of file GridAggregationBase.cc.

References agg_util::GridAggregationBase::getSubGridTemplate(), agg_util::GridAggregationBase::transferConstraintsToSubGridHook(), and VALID_PTR.

Referenced by agg_util::GridAggregationBase::readAndAggregateConstrainedMapsHook().

Here is the call graph for this function:

void agg_util::GridAggregationBase::setShapeFrom ( const libdap::Grid &  protoSubGrid,
bool  addMaps 
)
inherited

Use the data array and maps from protoSubGrid as the initial point for the shape of the Grid.

It may still not be complete until the callers adds maps, etc.

Parameters
protoSubGriddescribes the data array and map templates to use for the granules (modulo any agg subclass changes).
addMapsif true, add's all the maps in protoSubGrid into this. if false, does not.

Definition at line 153 of file GridAggregationBase.cc.

References VALID_PTR.

void agg_util::GridJoinExistingAggregation::transferConstraintsToSubGridHook ( Grid *  pSubGrid)
protectedvirtual

Required specialization for the read() call stack.

Reimplemented from agg_util::GridAggregationBase.

Definition at line 125 of file GridJoinExistingAggregation.cc.

References VALID_PTR.

BaseType * agg_util::GridAggregationBase::transform_to_dap4 ( libdap::D4Group *  root,
libdap::Constructor *  container 
)
inherited

Definition at line 108 of file GridAggregationBase.cc.


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