agg_util::GridAggregationBase Class Reference

Inheritance diagram for agg_util::GridAggregationBase:

Collaboration diagram for agg_util::GridAggregationBase:

Public Member Functions
virtual const AMDList &	getDatasetList () const
	GridAggregationBase (const GridAggregationBase &proto)
	GridAggregationBase (const libdap::Grid &proto, const AMDList &memberDatasets, const DDSLoader &loaderProto)
	GridAggregationBase (const string &name, const AMDList &memberDatasets, const DDSLoader &loaderProto)
GridAggregationBase &	operator= (const GridAggregationBase &rhs)
bool	read () override
bool	serialize (libdap::ConstraintEvaluator &eval, libdap::DDS &dds, libdap::Marshaller &m, bool ce_eval) override
void	setShapeFrom (const libdap::Grid &protoSubGrid, bool addMaps)
void	transform_to_dap4 (libdap::D4Group *root, libdap::Constructor *container) override

Protected Member Functions
void	copyProtoMapsIntoThisGrid (const Dimension &aggDim)
virtual const Dimension &	getAggregationDimension () const =0
Grid *	getSubGridTemplate ()
void	printConstraints (const libdap::Array &fromArray)
virtual void	readAndAggregateConstrainedMapsHook ()
void	readProtoSubGrid ()
virtual void	transferConstraintsToSubGridHook (Grid *pSubGrid)

Detailed Description

Definition at line 46 of file GridAggregationBase.h.

Constructor & Destructor Documentation

GridAggregationBase() [1/3]

agg_util::GridAggregationBase::GridAggregationBase	(	const libdap::Grid &	proto,
		const AMDList &	memberDatasets,
		const DDSLoader &	loaderProto )

Definition at line 59 of file GridAggregationBase.cc.

GridAggregationBase() [2/3]

agg_util::GridAggregationBase::GridAggregationBase	(	const string &	name,
		const AMDList &	memberDatasets,
		const DDSLoader &	loaderProto )

Construct an EMPTY Grid structure with given name. NOTE: The result is an incomplete type!

The shape prototype will be added by hand later for this case, where the caller needs more control than initializing the Grid from another Grid.

See also

setShapeFrom()

Parameters

name	name to give the grid
memberDatasets	the granules defining the aggregation
loaderProto	the laoder to use

Definition at line 64 of file GridAggregationBase.cc.

GridAggregationBase() [3/3]

agg_util::GridAggregationBase::GridAggregationBase

(

const GridAggregationBase &

proto

)

Definition at line 69 of file GridAggregationBase.cc.

~GridAggregationBase()

agg_util::GridAggregationBase::~GridAggregationBase ( )

override

Definition at line 76 of file GridAggregationBase.cc.

Member Function Documentation

copyProtoMapsIntoThisGrid()

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

protected

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

aggDim

a map with aggDim.name is NOT copied.

Definition at line 387 of file GridAggregationBase.cc.

getAggregationDimension()

virtual const Dimension & agg_util::GridAggregationBase::getAggregationDimension ( ) const

protectedpure virtual

Get the contained aggregation dimension info

Implemented in agg_util::GridAggregateOnOuterDimension, and agg_util::GridJoinExistingAggregation.

getDatasetList()

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

virtual

Accessor for the dataset description list that describes this aggregation.

Returns

a reference to the AggMemberDataset list.

Definition at line 163 of file GridAggregationBase.cc.

getSubGridTemplate()

Grid * agg_util::GridAggregationBase::getSubGridTemplate ( )

protected

Reveals the raw ptr, but only to subclasses. Don't delete it, but can be changed etc.

Definition at line 321 of file GridAggregationBase.cc.

operator=()

GridAggregationBase & agg_util::GridAggregationBase::operator=

(

const GridAggregationBase &

rhs

)

Definition at line 82 of file GridAggregationBase.cc.

printConstraints()

void agg_util::GridAggregationBase::printConstraints ( const libdap::Array & fromArray )

protected

Definition at line 361 of file GridAggregationBase.cc.

read()

bool agg_util::GridAggregationBase::read ( )

override

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 169 of file GridAggregationBase.cc.

readAndAggregateConstrainedMapsHook()

void agg_util::GridAggregationBase::readAndAggregateConstrainedMapsHook ( )

protectedvirtual

Called from read()! Invokes the user hooks eventually. Can be overridden, but default calls should suffice for now.

Definition at line 344 of file GridAggregationBase.cc.

readProtoSubGrid()

void agg_util::GridAggregationBase::readProtoSubGrid ( )

protected

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

Definition at line 368 of file GridAggregationBase.cc.

serialize()

bool agg_util::GridAggregationBase::serialize ( libdap::ConstraintEvaluator & eval, libdap::DDS & dds, libdap::Marshaller & m, bool ce_eval )

override

Pipelining data reads and network writes. This version of serialize(), like the versions in ArrayAggregation... also here in the NCML module, handles interleaved data reads and network write operations.

Note

The read() method for this class reads the entire Aggregated Grid variable into memory, so code that depends on that behavior will continue to work. When this serialize() code is called and the variable is 'loaded' with data, the libdap::Grid::serialize() code is called, so that will work as well. When this method is called and the data still need to be read, the new behavior will take over and latency, from the client program's perspective, will be small compared to reading then entire variable and then transmitting its values.

Parameters

eval
dds
m
ce_eval

Returns

Definition at line 219 of file GridAggregationBase.cc.

setShapeFrom()

void agg_util::GridAggregationBase::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. It may still not be complete until the callers adds maps, etc.

Parameters

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

Definition at line 135 of file GridAggregationBase.cc.

transferConstraintsToSubGridHook()

void agg_util::GridAggregationBase::transferConstraintsToSubGridHook ( Grid * pSubGrid )

protectedvirtual

To be specialized in subclass to copy constraints on this object properly into the given pSubGrid map list and data array for read.

Should handle the aggregation dimension properly, hence the specialization.

Called from readProtoSubGrid

Parameters

pSubGrid

Grid to modify with the constraints

Reimplemented in agg_util::GridAggregateOnOuterDimension, and agg_util::GridJoinExistingAggregation.

Definition at line 436 of file GridAggregationBase.cc.

transform_to_dap4()

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

override

Definition at line 94 of file GridAggregationBase.cc.

---

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

• GridAggregationBase.h
• GridAggregationBase.cc