coco::initializer Class Reference
[Module Base Classes]

Initializer base class. More...

#include <initializer.h>

Collaboration diagram for coco::initializer:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 initializer (const std::string &__n, gptr< work_node > *&wnode, search_focus *&sfoc, gptr< search_graph > *&sgraph, gptr< vdbl::database > *&dbase)
 initializer (const std::string &__n, gptr< work_node > *&wnode, search_focus *&sfoc, gptr< search_graph > *&sgraph)
 initializer (const std::string &__n, gptr< work_node > *&wnode, search_focus *&sfoc, gptr< vdbl::database > *&dbase)
 initializer (const std::string &__n, gptr< work_node > *&wnode, gptr< search_graph > *&sgraph, gptr< vdbl::database > *&dbase)
 initializer (const std::string &__n, search_focus *&sfoc, gptr< search_graph > *&sgraph, gptr< vdbl::database > *&dbase)
 initializer (const std::string &__n, gptr< work_node > *&wnode, search_focus *&sfoc)
 initializer (const std::string &__n, gptr< work_node > *&wnode, gptr< vdbl::database > *&dbase)
 initializer (const std::string &__n, gptr< work_node > *&wnode, gptr< search_graph > *&sgraph)
 initializer (const std::string &__n, search_focus *&sfoc, gptr< search_graph > *&sgraph)
 initializer (const std::string &__n, search_focus *&sfoc, gptr< vdbl::database > *&dbase)
 initializer (const std::string &__n, gptr< search_graph > *&sgraph, gptr< vdbl::database > *&dbase)
 initializer (const std::string &__n, gptr< work_node > *&wnode)
 initializer (const std::string &__n, search_focus *&sfoc)
 initializer (const std::string &__n, gptr< search_graph > *&sgraph)
 initializer (const std::string &__n, gptr< vdbl::database > *&dbase)
virtual ~initializer ()
const std::string & get_name () const
virtual ie_return_type initialize (const control_data &_c)

Protected Attributes

std::string __name
gptr< work_node > ** __wnode
search_focus ** __sfocus
gptr< vdbl::database > ** __dbase
gptr< search_graph > ** __sgraph


Detailed Description

This is the base class of all COCONUT initializer modules. An initializer is a management module, which specializes in initializing data structures like the search graph or the search database.

Definition at line 74 of file initializer.h.


Constructor & Destructor Documentation

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

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

Definition at line 94 of file initializer.h.

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

This is a constructor for an initializer 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 107 of file initializer.h.

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

This is a constructor for an initializer 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 119 of file initializer.h.

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

This is a constructor for an initializer 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 131 of file initializer.h.

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

This is a constructor for an initializer 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 143 of file initializer.h.

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

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

Definition at line 154 of file initializer.h.

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

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

Definition at line 164 of file initializer.h.

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

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

Definition at line 174 of file initializer.h.

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

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

Definition at line 184 of file initializer.h.

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

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

Definition at line 194 of file initializer.h.

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

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

Definition at line 204 of file initializer.h.

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

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

Definition at line 214 of file initializer.h.

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

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

Definition at line 222 of file initializer.h.

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

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

Definition at line 230 of file initializer.h.

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

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

Definition at line 238 of file initializer.h.

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

Standard Destructor

Definition at line 244 of file initializer.h.


Member Function Documentation

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

The get_name method returns the identifier string of the initializer.

Definition at line 247 of file initializer.h.

virtual ie_return_type coco::initializer::initialize ( const control_data _c  )  [inline, virtual]

This method is the main method of an initializer. It is supposed to initialize various internal data structures. Status information is returned in a ie_return_type structure. This method is overloaded by the various subclasses. Service information and parameters are provided via the control_data structure __c.

Definition at line 254 of file initializer.h.


Member Data Documentation

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

This variable contains a pointer to a global pointer to the search database.

Definition at line 85 of file initializer.h.

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

This is the identifier string for an initializer.

Definition at line 78 of file initializer.h.

This variable contains a pointer to a pointer to the search focus.

Definition at line 82 of file initializer.h.

This variable contains a pointer to a global pointer to the search graph.

Definition at line 87 of file initializer.h.

This variable contains a pointer to a global pointer to the work node.

Definition at line 80 of file initializer.h.


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

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