class ArrayAggregateOnOuterDimension More...

#include <ArrayAggregateOnOuterDimension.h>

Inheritance diagram for agg_util::ArrayAggregateOnOuterDimension:

Collaboration diagram for agg_util::ArrayAggregateOnOuterDimension:

Public Member Functions
	ArrayAggregateOnOuterDimension (const libdap::Array &proto, const AMDList &memberDatasets, std::auto_ptr< ArrayGetterInterface > &arrayGetter, const Dimension &newDim)
	Construct a joinNew Array aggregation given the parameters. More...

	ArrayAggregateOnOuterDimension (const ArrayAggregateOnOuterDimension &proto)
	Construct from a copy. More...

const AMDList &	getDatasetList () const
	Get the list of AggMemberDataset's that comprise this aggregation. More...

ArrayAggregateOnOuterDimension &	operator= (const ArrayAggregateOnOuterDimension &rhs)
	Assign this from rhs object. More...

virtual ArrayAggregateOnOuterDimension *	ptr_duplicate ()
	Virtual Constructor: Make a deep copy (clone) of the object and return it. More...

virtual bool	read ()
	Base implementation that works for both joinNew and joinExisting. More...

virtual	~ArrayAggregateOnOuterDimension ()
	Destroy any local memory. More...

Protected Member Functions
const ArrayGetterInterface &	getArrayGetterInterface () const
	Accessor for subclasses Note this is protected, so not const! Subclasses may mutate the return hence this, but should not delete it, hence the reference. More...

libdap::Array &	getGranuleTemplateArray ()
	Accessor for subclasses Note this is protected, so not const! Subclasses may mutate the return hence this, but should not delete it, hence the reference. More...

void	printConstraints (const Array &fromArray)
	Print out the constraints on fromArray to the debug channel. More...

virtual void	readConstrainedGranuleArraysAndAggregateDataHook ()
	Actually go through the constraints and stream the correctly constrained data into the superclass's output buffer for serializing out. More...

virtual void	transferOutputConstraintsIntoGranuleTemplateHook ()
	Subclass hook for read() to copy granule constraints properly (inner dim ones). More...

Detailed Description

class ArrayAggregateOnOuterDimension

Array variable which contains information for performing a joinNew (new outer dimension) aggregation of an Array variable using samples of this variable in a specified list of member datasets.

The list is specified as a list of RCPtr<AggMemberDataset>, i.e. reference-counted AggMemberDataset's (AMD). The AMD is in charge of lazy-loading it's contained DataDDS as needed as well as for only loading the required data for a read() call. In other words, read() on this subclass will respect the constraints given to the superclass Array.

Note: this class is designed to lazy-load the member datasets only if there are needed for the actual serialization at read() call time.

Note: the member datasets might be external files or might be wrapped virtual datasets (specified in NcML) or nested aggregation's.

Definition at line 64 of file ArrayAggregateOnOuterDimension.h.

Constructor & Destructor Documentation

agg_util::ArrayAggregateOnOuterDimension::ArrayAggregateOnOuterDimension	(	const libdap::Array &	proto,
		const AMDList &	memberDatasets,
		std::auto_ptr< ArrayGetterInterface > &	arrayGetter,
		const Dimension &	newDim
	)

Construct a joinNew Array aggregation given the parameters.

Parameters

proto	the Array to use as a prototype for the UNaggregated Array (ie module the new dimension). It is the object for the aggVar as loaded from memberDatasets[0].
memberDatasets	list of the member datasets forming the aggregation. this list will be copied internally so memberDatasets may be destroyed after this call (though the element AggMemberDataset objects will be ref()'d in our copy).
arrayGetter	smart ptr to the algorithm for getting out the constrained array from each individual AMDList DataDDS. Ownership transferred to this (clearly).
newDim	the new outer dimension this instance will add to the proto Array template

Definition at line 48 of file ArrayAggregateOnOuterDimension.cc.

References BESDEBUG, agg_util::Dimension::name, and agg_util::Dimension::size.

Referenced by ptr_duplicate().

agg_util::ArrayAggregateOnOuterDimension::ArrayAggregateOnOuterDimension ( const ArrayAggregateOnOuterDimension & proto )

Construct from a copy.

Definition at line 67 of file ArrayAggregateOnOuterDimension.cc.

References BESDEBUG.

agg_util::ArrayAggregateOnOuterDimension::~ArrayAggregateOnOuterDimension ( )

virtual

Destroy any local memory.

Definition at line 79 of file ArrayAggregateOnOuterDimension.cc.

References BESDEBUG.

Member Function Documentation

const ArrayGetterInterface & agg_util::ArrayAggregationBase::getArrayGetterInterface ( ) const

protectedinherited

Accessor for subclasses Note this is protected, so not const! Subclasses may mutate the return hence this, but should not delete it, hence the reference.

Definition at line 168 of file ArrayAggregationBase.cc.

References VALID_PTR.

Referenced by agg_util::ArrayJoinExistingAggregation::readConstrainedGranuleArraysAndAggregateDataHook(), and readConstrainedGranuleArraysAndAggregateDataHook().

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

inherited

Get the list of AggMemberDataset's that comprise this aggregation.

Definition at line 144 of file ArrayAggregationBase.cc.

Referenced by agg_util::ArrayJoinExistingAggregation::readConstrainedGranuleArraysAndAggregateDataHook(), and readConstrainedGranuleArraysAndAggregateDataHook().

libdap::Array & agg_util::ArrayAggregationBase::getGranuleTemplateArray ( )

protectedinherited

Accessor for subclasses Note this is protected, so not const! Subclasses may mutate the return hence this, but should not delete it, hence the reference.

Definition at line 160 of file ArrayAggregationBase.cc.

References VALID_PTR.

Referenced by agg_util::ArrayAggregationBase::read(), agg_util::ArrayJoinExistingAggregation::readConstrainedGranuleArraysAndAggregateDataHook(), readConstrainedGranuleArraysAndAggregateDataHook(), agg_util::ArrayJoinExistingAggregation::transferOutputConstraintsIntoGranuleTemplateHook(), and transferOutputConstraintsIntoGranuleTemplateHook().

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

Assign this from rhs object.

Parameters