coco::work_node_comp_hook Class Reference
[Search Graph]

The work_node_comp_hook class (work node computation hook). More...

#include <comp_hook.h>

Collaboration diagram for coco::work_node_comp_hook:

Collaboration graph

List of all members.

Public Member Functions

 work_node_comp_hook (const wnc_hook_base &w)
 work_node_comp_hook (const work_node_comp_hook &wh)
 ~work_node_comp_hook ()
work_node_comp_hookoperator= (const work_node_comp_hook &w)
void operator() (const work_node &wn, dbt_row &dbr, std::list< delta > *add_ds=NULL, std::list< certificate > *add_cs=NULL)
bool init_columns (vdbl::standard_table &stable)
bool drop_columns (vdbl::standard_table &stable)
const std::string & name () const

Detailed Description

The work_node_comp_hook class is used to compute info about work_nodes just when the work node is split and stored in the search graph. It is, like the delta class, designed as a wrapper class in order to overcome the problem that copy constructors cannot be overloaded. Work node computation hooks are stored in the search_graph, can be registered and released with search_graph methods.

Definition at line 50 of file comp_hook.h.

Constructor & Destructor Documentation

coco::work_node_comp_hook::work_node_comp_hook ( const wnc_hook_base w  )  [inline]

Constructor, which constructs a work node computation hook from a wnc_hook_base. The clone operation for the wnc_hook_base will be called in that process.

Definition at line 193 of file comp_hook.h.

coco::work_node_comp_hook::work_node_comp_hook ( const work_node_comp_hook wh  )  [inline]

Copy Constructor, which constructs a new work node computation hook from an existing one. The clone operation for the wnc_hook_base will be called in that process, effectively overloading the copy constructor for the wnc_hook_base.

Definition at line 198 of file comp_hook.h.

coco::work_node_comp_hook::~work_node_comp_hook (  )  [inline]

Standard Destructor calling delete on __wh.

Definition at line 203 of file comp_hook.h.

Member Function Documentation

bool coco::work_node_comp_hook::drop_columns ( vdbl::standard_table &  stable  )  [inline]

Upon unregistering this hook, destroy the column(s) in the ``search info'' table in which the result(s) of this hook are stored.

Definition at line 227 of file comp_hook.h.

bool coco::work_node_comp_hook::init_columns ( vdbl::standard_table &  stable  )  [inline]

Upon registering this hook, initialize the column(s) in the ``search info'' table in which the result(s) of this hook are stored.

Definition at line 222 of file comp_hook.h.

const std::string & coco::work_node_comp_hook::name (  )  const [inline]

Return the identifier string for this work node computation hook.

Definition at line 232 of file comp_hook.h.

void coco::work_node_comp_hook::operator() ( const work_node wn,
dbt_row dbr,
std::list< delta > *  add_ds = NULL,
std::list< certificate > *  add_cs = NULL 
) [inline]

The evaluation operator of this computation hook. It stores the result of the hook applied to work_node wn in dbt_row dbr, which in return is stored in the ``search info'' table of the search database. The hook can compute additional deltas and add them to add_ds, which are applied to the work node during the split.

Definition at line 216 of file comp_hook.h.

work_node_comp_hook & coco::work_node_comp_hook::operator= ( const work_node_comp_hook w  )  [inline]

Assignment operator, which uses the clone operation for the wnc_hook_base, effectively overloading the assignment operator for the wnc_hook_base.

Definition at line 209 of file comp_hook.h.

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

Generated on Tue Feb 9 14:47:58 2010 for COCONUT API by  doxygen 1.5.8