Anaphe Home Page Reference Documentation

Main Page     Namespaces     Classes     Source Code    

H_Locator Class Reference

#include <H_Locator.h>

List of all members.


Detailed Description

The class allows to set a path in the naming tree and then retrieve by name the histograms stored there. Retrieval methods check that the histogram type is consistent and return the histogram handle on successful retrieval. If the type is not consistent, zero is returned.

Definition at line 15 of file H_Locator.h.

Public Methods

 H_Locator ()
 Constructor.

int init (HepDbApplication *sess, char *path=0)
 Method to initialize the object.

int changeDir (char *)
 Change current node in the HepODBMS naming tree.

int checkCurrentNode ()
 Check the current node really exists in the HepODBMS naming tree.

 H_P_REF (P_Histo1D) Histo1D(char *name)
 Retrieve the handle of the persistent 1D histogram named name starting from the current node.

 H_P_REF (P_Histo1D) Histo1D(int id)
 Retrieve the handle of the persistent 1D histogram named id starting from the current node.

 H_P_REF (P_Histo1DVar) Histo1DVar(int id)
 Retrieve the handle of the persistent 1D histogram named id starting from the current node.

 H_P_REF (P_Histo1DVar) Histo1DVar(char *name)
 Retrieve the handle of the persistent 1D histogram named name starting from the current node.

 H_P_REF (P_ProfileHisto1D) ProfileHisto1D(int id)
 Retrieve the handle of the persistent Profile histogram named id starting from the current node.

 H_P_REF (P_ProfileHisto1D) ProfileHisto1D(char *name)
 Retrieve the handle of the persistent Profile histogram named name starting from the current node.

 H_P_REF (P_ProfileHisto1DVar) ProfileHisto1DVar(int id)
 Retrieve the handle of the persistent Profile histogram named id starting from the current node.

 H_P_REF (P_ProfileHisto1DVar) ProfileHisto1DVar(char *name)
 Retrieve the handle of the persistent Profile histogram named name starting from the current node.

 H_P_REF (P_Histo2D) Histo2D(int id)
 Retrieve the handle of the persistent 2D histogram named id starting from the current node.

 H_P_REF (P_Histo2D) Histo2D(char *name)
 Retrieve the handle of the persistent 2D histogram named name starting from the current node.

 H_P_REF (P_Histo2DVar) Histo2DVar(int id)
 Retrieve the handle of the persistent 2D histogram named id starting from the current node.

 H_P_REF (P_Histo2DVar) Histo2DVar(char *name)
 Retrieve the handle of the persistent 2D histogram named name starting from the current node.


Private Attributes

HepDbApplication * dbApp


Constructor & Destructor Documentation

H_Locator::H_Locator   [inline]
 

Definition at line 20 of file H_Locator.h.

References dbApp.


Member Function Documentation

int H_Locator::changeDir char *   
 

Returns 1 on success, 0 on failure (e.g. the node does not exist.

Definition at line 13 of file H_Locator.cpp.

References checkCurrentNode(), dbApp, and HTL_ERR.

Referenced by init().

int H_Locator::checkCurrentNode  
 

Returns 1 on success, 0 on failure.

Definition at line 4 of file H_Locator.cpp.

References dbApp.

Referenced by changeDir().

H_Locator::H_P_REF P_Histo2DVar   
 

If it doesn't exist or the type does not match, the method returns 0.

H_Locator::H_P_REF P_Histo2DVar   
 

If it doesn't exist or the type does not match, the method returns 0.

H_Locator::H_P_REF P_Histo2D   
 

If it doesn't exist or the type does not match, the method returns 0.

H_Locator::H_P_REF P_Histo2D   
 

If it doesn't exist or the type does not match, the method returns 0.

H_Locator::H_P_REF P_ProfileHisto1DVar   
 

If it doesn't exist or the type does not match, the method returns 0.

H_Locator::H_P_REF P_ProfileHisto1DVar   
 

If it doesn't exist or the type does not match, the method returns 0.

H_Locator::H_P_REF P_ProfileHisto1D   
 

If it doesn't exist or the type does not match, the method returns 0.

H_Locator::H_P_REF P_ProfileHisto1D   
 

If it doesn't exist or the type does not match, the method returns 0.

H_Locator::H_P_REF P_Histo1DVar   
 

If it doesn't exist or the type does not match, the method returns 0.

H_Locator::H_P_REF P_Histo1DVar   
 

If it doesn't exist or the type does not match, the method returns 0.

H_Locator::H_P_REF P_Histo1D   
 

If it doesn't exist or the type does not match, the method returns 0.

H_Locator::H_P_REF P_Histo1D   
 

If it doesn't exist or the type does not match, the method returns 0.

int H_Locator::init HepDbApplication *    sess,
char *    path = 0
 

It takes a pointer to the HepDbApplication object used to manage transactions sess and the path path to the HepODBMS naming node.

Definition at line 24 of file H_Locator.cpp.

References changeDir(), and dbApp.


Member Data Documentation

HepDbApplication* H_Locator::dbApp [private]
 

Definition at line 17 of file H_Locator.h.

Referenced by changeDir(), checkCurrentNode(), H_Locator(), and init().


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

Anaphe documentation generated by Doxygen (www.doxygen.org)