w2kmeans::GridOperator< GridType > Class Template Reference

Inheritance diagram for w2kmeans::GridOperator< GridType >:

List of all members.

---

Detailed Description

template<class GridType>
class w2kmeans::GridOperator< GridType >

Base-class of cluster-table-action objects that use grids as input.

Public Member Functions
virtual	~GridOperator ()
virtual size_t	numHistoricalGridsNeeded () const
	By default, return 1 (just the latest).
const std::string &	getInputName () const
	GridOperator (const code::XML::Element &columnElement)
virtual void	fillColumn (const std::vector< ClusterTableRegion > &regions, ClusterInputHistory< GridType > &inputs)
virtual float	getDefaultValue () const
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.
bool	alreadyComputed (const code::DataTable &tbl) const
bool	hasAllInputs (const code::DataTable &tbl) const
Static Public Member Functions
static code::SmartPtr< ClusterTableAction< GridType > >	createGridOperator (const code::XML::Element &columnElement)
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::GridOperator< GridType >::~GridOperator

(

)

[inline, virtual]

template<class GridType>

w2kmeans::GridOperator< GridType >::GridOperator

(

const code::XML::Element &

columnElement

)

[inline]

---

Member Function Documentation

template<class GridType>

void w2kmeans::ClusterTableAction< GridType >::addRequiredColumn

(

const std::string &

colName

)

[inline, protected, inherited]

template<class GridType>

bool w2kmeans::ClusterTableAction< GridType >::alreadyComputed

(

const code::DataTable &

tbl

)

const [inline, inherited]

template<class GridType>

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

(

const code::XML::Element &

columnElement

)

[static, inherited]

Factory of Action objects.

template<class GridType>

static code::SmartPtr< ClusterTableAction<GridType> > w2kmeans::GridOperator< GridType >::createGridOperator

(

const code::XML::Element &

columnElement

)

[static]

template<class GridType>

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

template<class GridType>

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

(

)

const [inline, virtual, inherited]

template<class GridType>

const std::string& w2kmeans::GridOperator< GridType >::getInputName

(

)

const [inline]

template<class GridType>

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

(

)

const [inline, inherited]

template<class GridType>

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

(

)

const [inline, inherited]

template<class GridType>

bool w2kmeans::ClusterTableAction< GridType >::hasAllInputs

(

const code::DataTable &

tbl

)

const [inline, inherited]

template<class GridType>

bool w2kmeans::ClusterTableAction< GridType >::isReadyToCompute

(

const code::DataTable &

tbl

)

const [inline, inherited]

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

template<class GridType>

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

(

)

const [inline, virtual]

By default, return 1 (just the latest).

Implements w2kmeans::ClusterTableAction< GridType >.

template<class GridType>

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

template<class GridType>

bool w2kmeans::ClusterTableAction< GridType >::shouldCompute

(

const code::DataTable &

tbl

)

const [inline, inherited]

Should this action be carried out for this table?

---

Member Data Documentation

template<class GridType>

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

---