coco::management_module Class Reference
[Module Base Classes]

Management module base class. More...

#include <mgmt_module.h>

Collaboration diagram for coco::management_module:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 management_module (const std::string &__n, gptr< work_node > &wnode, search_focus &sfoc, const search_inspector *sinsp, gptr< search_graph > &sgraph, gptr< vdbl::database > &dbase)
 management_module (const std::string &__n, gptr< work_node > &wnode, search_focus &sfoc, const search_inspector *sinsp, gptr< search_graph > &sgraph)
 management_module (const std::string &__n, gptr< work_node > &wnode, search_focus &sfoc, const search_inspector *sinsp, gptr< vdbl::database > &dbase)
 management_module (const std::string &__n, gptr< work_node > &wnode, const search_inspector *sinsp, gptr< search_graph > &sgraph, gptr< vdbl::database > &dbase)
 management_module (const std::string &__n, search_focus &sfoc, const search_inspector *sinsp, gptr< search_graph > &sgraph, gptr< vdbl::database > &dbase)
 management_module (const std::string &__n, gptr< work_node > &wnode, search_focus &sfoc, const search_inspector *sinsp)
 management_module (const std::string &__n, gptr< work_node > &wnode, const search_inspector *sinsp, gptr< vdbl::database > &dbase)
 management_module (const std::string &__n, gptr< work_node > &wnode, const search_inspector *sinsp, gptr< search_graph > &sgraph)
 management_module (const std::string &__n, search_focus &sfoc, const search_inspector *sinsp, gptr< search_graph > &sgraph)
 management_module (const std::string &__n, search_focus &sfoc, const search_inspector *sinsp, gptr< vdbl::database > &dbase)
 management_module (const std::string &__n, const search_inspector *sinsp, gptr< search_graph > &sgraph, gptr< vdbl::database > &dbase)
 management_module (const std::string &__n, gptr< work_node > &wnode, const search_inspector *sinsp)
 management_module (const std::string &__n, search_focus &sfoc, const search_inspector *sinsp)
 management_module (const std::string &__n, const search_inspector *sinsp, gptr< search_graph > &sgraph)
 management_module (const std::string &__n, const search_inspector *sinsp, gptr< vdbl::database > &dbase)
 management_module (const std::string &__n, gptr< work_node > &wnode, search_focus &sfoc, gptr< search_graph > &sgraph, gptr< vdbl::database > &dbase)
 management_module (const std::string &__n, gptr< work_node > &wnode, search_focus &sfoc, gptr< search_graph > &sgraph)
 management_module (const std::string &__n, gptr< work_node > &wnode, search_focus &sfoc, gptr< vdbl::database > &dbase)
 management_module (const std::string &__n, gptr< work_node > &wnode, gptr< search_graph > &sgraph, gptr< vdbl::database > &dbase)
 management_module (const std::string &__n, search_focus &sfoc, gptr< search_graph > &sgraph, gptr< vdbl::database > &dbase)
 management_module (const std::string &__n, gptr< work_node > &wnode, search_focus &sfoc)
 management_module (const std::string &__n, gptr< work_node > &wnode, gptr< vdbl::database > &dbase)
 management_module (const std::string &__n, gptr< work_node > &wnode, gptr< search_graph > &sgraph)
 management_module (const std::string &__n, search_focus &sfoc, gptr< search_graph > &sgraph)
 management_module (const std::string &__n, search_focus &sfoc, gptr< vdbl::database > &dbase)
 management_module (const std::string &__n, gptr< search_graph > &sgraph, gptr< vdbl::database > &dbase)
 management_module (const std::string &__n, gptr< work_node > &wnode)
 management_module (const std::string &__n, search_focus &sfoc)
 management_module (const std::string &__n, const search_inspector *sinsp)
 management_module (const std::string &__n, gptr< search_graph > &sgraph)
 management_module (const std::string &__n, gptr< vdbl::database > &dbase)
virtual ~management_module ()
const modelget_model () const
const std::string & get_name () const
virtual int manage (const control_data &_c)

Protected Attributes

std::string __name
gptr< work_node > * __wnode
search_focus__sfocus
const search_inspector__sinsp
gptr< vdbl::database > * __dbase
gptr< search_graph > * __sgraph


Detailed Description

This is the base class of all COCONUT management modules. A management module specializes in performing changes to the internal data structures.

Definition at line 73 of file mgmt_module.h.


Constructor & Destructor Documentation

coco::management_module::management_module ( const std::string &  __n,
gptr< work_node > &  wnode,
search_focus sfoc,
const search_inspector sinsp,
gptr< search_graph > &  sgraph,
gptr< vdbl::database > &  dbase 
) [inline]

This is the most general constructor for a management module containing parameters for setting all internal variables. The parameter __n sets __name, wnode sets __wnode, sfoc sets __sfocus, sinsp sets __sinsp, sgraph sets __sgraph, and dbase sets __dbase.

Definition at line 94 of file mgmt_module.h.

coco::management_module::management_module ( const std::string &  __n,
gptr< work_node > &  wnode,
search_focus sfoc,
const search_inspector sinsp,
gptr< search_graph > &  sgraph 
) [inline]

This is a constructor for a management module containing parameters for setting some internal variables. The parameter __n sets __name, wnode sets __wnode, sfoc sets __sfocus, sinsp sets __sinsp, and sgraph sets __sgraph.

Definition at line 108 of file mgmt_module.h.

coco::management_module::management_module ( const std::string &  __n,
gptr< work_node > &  wnode,
search_focus sfoc,
const search_inspector sinsp,
gptr< vdbl::database > &  dbase 
) [inline]

This is a constructor for a management module containing parameters for setting some internal variables. The parameter __n sets __name, wnode sets __wnode, sfoc sets __sfocus, sinsp sets __sinsp, and dbase sets __dbase.

Definition at line 121 of file mgmt_module.h.

coco::management_module::management_module ( const std::string &  __n,
gptr< work_node > &  wnode,
const search_inspector sinsp,
gptr< search_graph > &  sgraph,
gptr< vdbl::database > &  dbase 
) [inline]

This is a constructor for a management module containing parameters for setting some internal variables. The parameter __n sets __name, wnode sets __wnode, sinsp sets __sinsp, sgraph sets __sgraph, and dbase sets __dbase.

Definition at line 134 of file mgmt_module.h.

coco::management_module::management_module ( const std::string &  __n,
search_focus sfoc,
const search_inspector sinsp,
gptr< search_graph > &  sgraph,
gptr< vdbl::database > &  dbase 
) [inline]

This is a constructor for a management module containing parameters for setting some internal variables. The parameter __n sets __name, sfoc sets __sfocus, sinsp sets __sinsp, sgraph sets __sgraph, and dbase sets __dbase.

Definition at line 147 of file mgmt_module.h.

coco::management_module::management_module ( const std::string &  __n,
gptr< work_node > &  wnode,
search_focus sfoc,
const search_inspector sinsp 
) [inline]

This is a constructor for a management module containing parameters for setting some internal variables. The parameter __n sets __name, wnode sets __wnode, sfoc sets __sfocus, and sinsp sets __sinsp.

Definition at line 160 of file mgmt_module.h.

coco::management_module::management_module ( const std::string &  __n,
gptr< work_node > &  wnode,
const search_inspector sinsp,
gptr< vdbl::database > &  dbase 
) [inline]

This is a constructor for a management module containing parameters for setting some internal variables. The parameter __n sets __name, wnode sets __wnode, sinsp sets __sinsp, and dbase sets __dbase.

Definition at line 172 of file mgmt_module.h.

coco::management_module::management_module ( const std::string &  __n,
gptr< work_node > &  wnode,
const search_inspector sinsp,
gptr< search_graph > &  sgraph 
) [inline]

This is a constructor for a management module containing parameters for setting some internal variables. The parameter __n sets __name, wnode sets __wnode, sinsp sets __sinsp, and sgraph sets __sgraph.

Definition at line 184 of file mgmt_module.h.

coco::management_module::management_module ( const std::string &  __n,
search_focus sfoc,
const search_inspector sinsp,
gptr< search_graph > &  sgraph 
) [inline]

This is a constructor for a management module containing parameters for setting some internal variables. The parameter __n sets __name, sfoc sets __sfocus, sinsp sets __sinsp, and sgraph sets __sgraph.

Definition at line 196 of file mgmt_module.h.

coco::management_module::management_module ( const std::string &  __n,
search_focus sfoc,
const search_inspector sinsp,
gptr< vdbl::database > &  dbase 
) [inline]

This is a constructor for a management module containing parameters for setting some internal variables. The parameter __n sets __name, sfoc sets __sfocus, sinsp sets __sinsp, and dbase sets __dbase.

Definition at line 208 of file mgmt_module.h.

coco::management_module::management_module ( const std::string &  __n,
const search_inspector sinsp,
gptr< search_graph > &  sgraph,
gptr< vdbl::database > &  dbase 
) [inline]

This is a constructor for a management module containing parameters for setting some internal variables. The parameter __n sets __name, sinsp sets __sinsp, sgraph sets __sgraph, and dbase sets __dbase.

Definition at line 220 of file mgmt_module.h.

coco::management_module::management_module ( const std::string &  __n,
gptr< work_node > &  wnode,
const search_inspector sinsp 
) [inline]

This is a constructor for a management module containing parameters for setting some internal variables. The parameter __n sets __name, wnode sets __wnode, and sinsp sets __sinsp.

Definition at line 231 of file mgmt_module.h.

coco::management_module::management_module ( const std::string &  __n,
search_focus sfoc,
const search_inspector sinsp 
) [inline]

This is a constructor for a management module containing parameters for setting some internal variables. The parameter __n sets __name, sfoc sets __sfocus, sinsp sets __sinsp.

Definition at line 240 of file mgmt_module.h.

coco::management_module::management_module ( const std::string &  __n,
const search_inspector sinsp,
gptr< search_graph > &  sgraph 
) [inline]

This is a constructor for a management module containing parameters for setting some internal variables. The parameter __n sets __name, sinsp sets __sinsp, and sgraph sets __sgraph.

Definition at line 249 of file mgmt_module.h.

coco::management_module::management_module ( const std::string &  __n,
const search_inspector sinsp,
gptr< vdbl::database > &  dbase 
) [inline]

This is a constructor for a management module containing parameters for setting some internal variables. The parameter __n sets __name, sinsp sets __sinsp, and dbase sets __dbase.

Definition at line 258 of file mgmt_module.h.

coco::management_module::management_module ( const std::string &  __n,
gptr< work_node > &  wnode,
search_focus sfoc,
gptr< search_graph > &  sgraph,
gptr< vdbl::database > &  dbase 
) [inline]

This is a constructor for a management module containing parameters for setting some internal variables. The parameter __n sets __name, wnode sets __wnode, sfoc sets __sfocus, sgraph sets __sgraph, and dbase sets __dbase.

Definition at line 268 of file mgmt_module.h.

coco::management_module::management_module ( const std::string &  __n,
gptr< work_node > &  wnode,
search_focus sfoc,
gptr< search_graph > &  sgraph 
) [inline]

This is a constructor for a management module containing parameters for setting some internal variables. The parameter __n sets __name, wnode sets __wnode, sfoc sets __sfocus, and sgraph sets __sgraph.

Definition at line 281 of file mgmt_module.h.

coco::management_module::management_module ( const std::string &  __n,
gptr< work_node > &  wnode,
search_focus sfoc,
gptr< vdbl::database > &  dbase 
) [inline]

This is a constructor for a management module containing parameters for setting some internal variables. The parameter __n sets __name, wnode sets __wnode, sfoc sets __sfocus, and dbase sets __dbase.

Definition at line 293 of file mgmt_module.h.

coco::management_module::management_module ( const std::string &  __n,
gptr< work_node > &  wnode,
gptr< search_graph > &  sgraph,
gptr< vdbl::database > &  dbase 
) [inline]

This is a constructor for a management module containing parameters for setting some internal variables. The parameter __n sets __name, wnode sets __wnode, sgraph sets __sgraph, and dbase sets __dbase.

Definition at line 305 of file mgmt_module.h.

coco::management_module::management_module ( const std::string &  __n,
search_focus sfoc,
gptr< search_graph > &  sgraph,
gptr< vdbl::database > &  dbase 
) [inline]

This is a constructor for a management module containing parameters for setting some internal variables. The parameter __n sets __name, sfoc sets __sfocus, sgraph sets __sgraph, and dbase sets __dbase.

Definition at line 317 of file mgmt_module.h.

coco::management_module::management_module ( const std::string &  __n,
gptr< work_node > &  wnode,
search_focus sfoc 
) [inline]

This is a constructor for a management module containing parameters for setting some internal variables. The parameter __n sets __name, wnode sets __wnode, and sfoc sets __sfocus.

Definition at line 328 of file mgmt_module.h.

coco::management_module::management_module ( const std::string &  __n,
gptr< work_node > &  wnode,
gptr< vdbl::database > &  dbase 
) [inline]

This is a constructor for a management module containing parameters for setting some internal variables. The parameter __n sets __name, wnode sets __wnode, and dbase sets __dbase.

Definition at line 338 of file mgmt_module.h.

coco::management_module::management_module ( const std::string &  __n,
gptr< work_node > &  wnode,
gptr< search_graph > &  sgraph 
) [inline]

This is a constructor for a management module containing parameters for setting some internal variables. The parameter __n sets __name, wnode sets __wnode, and sgraph sets __sgraph.

Definition at line 348 of file mgmt_module.h.

coco::management_module::management_module ( const std::string &  __n,
search_focus sfoc,
gptr< search_graph > &  sgraph 
) [inline]

This is a constructor for a management module containing parameters for setting some internal variables. The parameter __n sets __name, sfoc sets __sfocus, and sgraph sets __sgraph.

Definition at line 358 of file mgmt_module.h.

coco::management_module::management_module ( const std::string &  __n,
search_focus sfoc,
gptr< vdbl::database > &  dbase 
) [inline]

This is a constructor for a management module containing parameters for setting some internal variables. The parameter __n sets __name, sfoc sets __sfocus, and dbase sets __dbase.

Definition at line 368 of file mgmt_module.h.

coco::management_module::management_module ( const std::string &  __n,
gptr< search_graph > &  sgraph,
gptr< vdbl::database > &  dbase 
) [inline]

This is a constructor for a management module containing parameters for setting some internal variables. The parameter __n sets __name, sgraph sets __sgraph, and dbase sets __dbase.

Definition at line 378 of file mgmt_module.h.

coco::management_module::management_module ( const std::string &  __n,
gptr< work_node > &  wnode 
) [inline]

This is a constructor for a management module containing parameters for setting some internal variables. The parameter __n sets __name, and wnode sets __wnode.

Definition at line 388 of file mgmt_module.h.

coco::management_module::management_module ( const std::string &  __n,
search_focus sfoc 
) [inline]

This is a constructor for a management module containing parameters for setting some internal variables. The parameter __n sets __name, and sfoc sets __sfocus.

Definition at line 396 of file mgmt_module.h.

coco::management_module::management_module ( const std::string &  __n,
const search_inspector sinsp 
) [inline]

This is a constructor for a management module containing parameters for setting some internal variables. The parameter __n sets __name and sinsp sets __sinsp.

Definition at line 404 of file mgmt_module.h.

coco::management_module::management_module ( const std::string &  __n,
gptr< search_graph > &  sgraph 
) [inline]

This is a constructor for a management module containing parameters for setting some internal variables. The parameter __n sets __name and sgraph sets __sgraph.

Definition at line 412 of file mgmt_module.h.

coco::management_module::management_module ( const std::string &  __n,
gptr< vdbl::database > &  dbase 
) [inline]

This is a constructor for a management module containing parameters for setting some internal variables. The parameter __n sets __name and dbase sets __dbase.

Definition at line 420 of file mgmt_module.h.

virtual coco::management_module::~management_module (  )  [inline, virtual]

Standard Destructor

Definition at line 426 of file mgmt_module.h.


Member Function Documentation

const model* coco::management_module::get_model (  )  const [inline]

A call to this method returns a pointer to the model of the work node.

Definition at line 429 of file mgmt_module.h.

const std::string& coco::management_module::get_name (  )  const [inline]

The get_name method returns the identifier string of the management module.

Definition at line 434 of file mgmt_module.h.

virtual int coco::management_module::manage ( const control_data _c  )  [inline, virtual]

This method is the main method of a management module. It is supposed to perform changes to some internal data structure. It returns a status value. Here 0 denotes success. All other return values signal some error or warning. Service information and parameters are provided via the control_data structure _c.

Definition at line 441 of file mgmt_module.h.


Member Data Documentation

gptr<vdbl::database>* coco::management_module::__dbase [protected]

This variable contains a global pointer to the search database.

Definition at line 85 of file mgmt_module.h.

std::string coco::management_module::__name [protected]

This is the identifier string for a management module.

Definition at line 77 of file mgmt_module.h.

This variable contains a pointer to the search focus.

Definition at line 81 of file mgmt_module.h.

This variable contains a global pointer to the search graph.

Definition at line 87 of file mgmt_module.h.

This variable contains a pointer to a search inspector

Definition at line 83 of file mgmt_module.h.

This variable contains a global pointer to the work node.

Definition at line 79 of file mgmt_module.h.


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

Generated on Tue Feb 9 14:49:36 2010 for COCONUT API by  doxygen 1.5.8