---

CdbBdbPrintObjectTreeUserAction Class Reference

The base class for user defined actions. More...

#include <CdbBdbPrintObjectTreeUserAction.hh>

List of all members.

Public Types
enum	ActionType { ACTION_PROCEED, ACTION_STOP, ACTION_ERROR }
	These values will be used to indicate the user's response. More...
Public Member Functions
	CdbBdbPrintObjectTreeUserAction (bool verboseMode=false, bool debugMode=false)
	The constructor.
virtual	~CdbBdbPrintObjectTreeUserAction ()
	The destructor.
ActionType	action (const ooHandle(ooObj)&theInputH)
	Let a user to make a decision on what has to be done next.
Protected Member Functions
virtual ActionType	userAction (const ooHandle(ooObj)&theInputH)
	Let a user to make a decision on what has to be done next (ACTUAL USER ACTION).

---

Detailed Description

The base class for user defined actions.

This base class has to implemented by users willing to control the "print object children" navigation in complex graphs.

IMPLEMENTATION NOTES:

(1) This class violates CDB API convention on the inclusion of "CdbBase/CdbCommon.hh" header file to avoid STD namespace conflicts of the kind described above.

Definition at line 22 of file CdbBdbPrintObjectTreeUserAction.hh.

---

Member Enumeration Documentation

enum CdbBdbPrintObjectTreeUserAction::ActionType

These values will be used to indicate the user's response. Enumeration values: ACTION_PROCEED  ACTION_STOP  ACTION_ERROR  Definition at line 28 of file CdbBdbPrintObjectTreeUserAction.hh.

---

Constructor & Destructor Documentation

CdbBdbPrintObjectTreeUserAction::CdbBdbPrintObjectTreeUserAction (  bool    verboseMode = false, bool    debugMode = false )

The constructor. Inityialize's the object's parameters. Definition at line 13 of file CdbBdbPrintObjectTreeUserAction.cc.

CdbBdbPrintObjectTreeUserAction::~CdbBdbPrintObjectTreeUserAction (    )  [virtual]

The destructor. Moe details... Definition at line 19 of file CdbBdbPrintObjectTreeUserAction.cc.

---

Member Function Documentation

CdbBdbPrintObjectTreeUserAction::ActionType CdbBdbPrintObjectTreeUserAction::action (  const ooHandle(ooObj)&    theInputH )

Let a user to make a decision on what has to be done next. This wrapper method takes the "about-to-be-printed" link on the input. Ths link is evaluated by the method to report what's the next action should be. The second parameter passed town to the operation is the current context description in which the link has to be evaluated. Here is the explanation of possible responses: ACTION_PROCEED : a caller has to proceed and print this node. ACTION_STOP : a caller should stop and not to propagate along this link. ACTION_ERROR : an error has happened inside the method. Normally the caller should stop printing any further links. HOW IT WORKS: first of all this method will verify if the passed object is valid and return the ACTION_ERROR value if it's not. if the passed object is valid then a user defined "userAction" application's object will be called to let a user to proceed with his/her actions in the passed object's context. See also: CdbBdbPrintObjectTreeUserAction::userAction() Definition at line 23 of file CdbBdbPrintObjectTreeUserAction.cc. References ACTION_ERROR, and userAction().

CdbBdbPrintObjectTreeUserAction::ActionType CdbBdbPrintObjectTreeUserAction::userAction (  const ooHandle(ooObj)&    theInputH )  [protected, virtual]

Let a user to make a decision on what has to be done next (ACTUAL USER ACTION). This method gets called only for valid objects. IMPLEMENTATION NOTE: In its default implementation this method would always return ACTION_PROCEED. This behaviour can be overriten by specific subclasses. See also: CdbBdbPrintObjectTreeUserAction::action() Definition at line 35 of file CdbBdbPrintObjectTreeUserAction.cc. References ACTION_PROCEED. Referenced by action().

---

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

• CdbBdbPrintObjectTreeUserAction.hh
• CdbBdbPrintObjectTreeUserAction.cc

---