coco::graph_analyzer Class Reference
[Module Base Classes]

Graph analyzer base class. More...

#include <graph_analyzer.h>

Collaboration diagram for coco::graph_analyzer:

[legend]

List of all members.

Public Member Functions
	graph_analyzer (const gptr< search_graph > &sgraph, const search_focus &sfoc, const std::string &__n)
	graph_analyzer (const gptr< search_graph > &sgraph, const std::string &__n)
virtual	~graph_analyzer ()
virtual bool	update_engine (const gptr< search_graph > &sgraph, const search_focus &sfoc)
virtual bool	update_engine (const gptr< search_graph > &sgraph)
virtual ga_return_type	analyze (const control_data &__c)
const std::string &	get_name () const
Protected Attributes
std::string	__name
const gptr< search_graph > *	__sgraph
const search_focus *	__sfoc
const search_graph_context *	__sgc
const vdbl::viewdbase *	__vdb

---

Detailed Description

This is the base class of all COCONUT graph analyzer modules. A graph analyzer is an inference module, which specializes in analyzing the search graph. A typical graph analyzer is, e.g., the box chooser, which selects the next search_node from the search_graph.

Definition at line 83 of file graph_analyzer.h.

---

Constructor & Destructor Documentation

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

This is the standard constructor for a graph_analyzer. It sets the indentifier string to n, the search graph to sgraph, and the search focus to sfoc.

Definition at line 102 of file graph_analyzer.h.

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

This is the standard constructor for a graph_analyzer if no search focus is available. It sets the indentifier string to n and the search graph to sgraph.

Definition at line 113 of file graph_analyzer.h.

virtual coco::graph_analyzer::~graph_analyzer

(

)

[inline, virtual]

Standard Destructor

Definition at line 121 of file graph_analyzer.h.

---

Member Function Documentation

virtual ga_return_type coco::graph_analyzer::analyze

(

const control_data &

__c

)

[inline, virtual]

This method is the main method of a graph analyzer. It is supposed to analyze the search graph and to return the information gained in the ga_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 151 of file graph_analyzer.h.

const std::string& coco::graph_analyzer::get_name

(

)

const [inline]

The get_name method returns the identifier string of the graph analyzer.

Definition at line 155 of file graph_analyzer.h.

virtual bool coco::graph_analyzer::update_engine

(

const gptr< search_graph > &

sgraph

)

[inline, virtual]

This update_engine method changes the search graph to sgraph and clears the search focus.

Definition at line 137 of file graph_analyzer.h.

virtual bool coco::graph_analyzer::update_engine	(	const gptr< search_graph > &	sgraph,
		const search_focus &	sfoc
	)			[inline, virtual]

This update_engine method changes the search graph to sgraph and the search focus to sfoc.

Definition at line 125 of file graph_analyzer.h.

---

Member Data Documentation

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

This is the identifier string for a graph analyzer.

Definition at line 87 of file graph_analyzer.h.

const search_focus* coco::graph_analyzer::__sfoc [protected]

This is the current search focus.

Definition at line 91 of file graph_analyzer.h.

const search_graph_context* coco::graph_analyzer::__sgc [protected]

This is the search_graph_context for extracting information from the search database.

Definition at line 94 of file graph_analyzer.h.

const gptr<search_graph>* coco::graph_analyzer::__sgraph [protected]

This variable contains a global pointer to the search graph.

Definition at line 89 of file graph_analyzer.h.

const vdbl::viewdbase* coco::graph_analyzer::__vdb [protected]

This is a view to the search database.

Definition at line 96 of file graph_analyzer.h.

---

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

• graph_analyzer.h