w2kmeans::ClusterTableAction< GridType > Class Template Reference

Inheritance diagram for w2kmeans::ClusterTableAction< GridType >:

List of all members.

---

Detailed Description

template<class GridType>
class w2kmeans::ClusterTableAction< GridType >

An action that will be performed on a cluster table input to create a new output grid.

See also:

ClusterTableCreator

Author:

Lakshman

Version:

Id

w2kmeans_ClusterTableAction.h,v 1.13 2010/11/30 17:39:11 lakshman Exp

Public Member Functions
virtual void	fillColumn (const std::vector< ClusterTableRegion > &regions, ClusterInputHistory< GridType > &inputs)
virtual float	getDefaultValue () const
virtual	~ClusterTableAction ()
	ClusterTableAction (const code::XML::Element &columnElement)
const std::string &	getOutputName () const
const std::string &	getOutputUnit () const
bool	shouldCompute (const code::DataTable &tbl) const
	Should this action be carried out for this table?
bool	isReadyToCompute (const code::DataTable &tbl) const
	looks in the table to see if all the required data is already present.
virtual size_t	numHistoricalGridsNeeded () const =0
	How many historical grids are needed? Return value of 1 indicates just the latest.
bool	alreadyComputed (const code::DataTable &tbl) const
bool	hasAllInputs (const code::DataTable &tbl) const
Static Public Member Functions
static code::SmartPtr< ClusterTableAction< GridType > >	createAction (const code::XML::Element &columnElement)
	Factory of Action objects.
Protected Member Functions
void	addRequiredColumn (const std::string &colName)
virtual void	process (const std::vector< ClusterTableRegion > &regions, ClusterInputHistory< GridType > &inputs)=0
Protected Attributes
std::vector< std::string >	requiredColumns

---

Constructor & Destructor Documentation

template<class GridType>

virtual w2kmeans::ClusterTableAction< GridType >::~ClusterTableAction

(

)

[inline, virtual]

template<class GridType>

w2kmeans::ClusterTableAction< GridType >::ClusterTableAction

(

const code::XML::Element &

columnElement

)

---

Member Function Documentation

template<class GridType>

void w2kmeans::ClusterTableAction< GridType >::addRequiredColumn

(

const std::string &

colName

)

[inline, protected]

template<class GridType>

bool w2kmeans::ClusterTableAction< GridType >::alreadyComputed

(

const code::DataTable &

tbl

)

const [inline]

template<class GridType>

static code::SmartPtr< ClusterTableAction<GridType> > w2kmeans::ClusterTableAction< GridType >::createAction

(

const code::XML::Element &

columnElement

)

[static]

Factory of Action objects.

template<class GridType>

virtual void w2kmeans::ClusterTableAction< GridType >::fillColumn	(	const std::vector< ClusterTableRegion > &	regions,
		ClusterInputHistory< GridType > &	inputs
	)			[virtual]

template<class GridType>

virtual float w2kmeans::ClusterTableAction< GridType >::getDefaultValue

(

)

const [inline, virtual]

template<class GridType>

const std::string& w2kmeans::ClusterTableAction< GridType >::getOutputName

(

)

const [inline]

template<class GridType>

const std::string& w2kmeans::ClusterTableAction< GridType >::getOutputUnit

(

)

const [inline]

template<class GridType>

bool w2kmeans::ClusterTableAction< GridType >::hasAllInputs

(

const code::DataTable &

tbl

)

const [inline]

template<class GridType>

bool w2kmeans::ClusterTableAction< GridType >::isReadyToCompute

(

const code::DataTable &

tbl

)

const [inline]

looks in the table to see if all the required data is already present.

template<class GridType>

virtual size_t w2kmeans::ClusterTableAction< GridType >::numHistoricalGridsNeeded

(

)

const [pure virtual]

How many historical grids are needed? Return value of 1 indicates just the latest.

Implemented in w2kmeans::GridOperator< GridType >, and w2kmeans::ColumnOperator< GridType >.

template<class GridType>

virtual void w2kmeans::ClusterTableAction< GridType >::process	(	const std::vector< ClusterTableRegion > &	regions,
		ClusterInputHistory< GridType > &	inputs
	)			[protected, pure virtual]

template<class GridType>

bool w2kmeans::ClusterTableAction< GridType >::shouldCompute

(

const code::DataTable &

tbl

)

const [inline]

Should this action be carried out for this table?

---

Member Data Documentation

template<class GridType>

std::vector<std::string> w2kmeans::ClusterTableAction< GridType >::requiredColumns [protected]

---