Bdb packages | Design docs | Source docs | Guidelines | Recent releases
	Search | Site Map .

                 

---

/TagData/TagTransient.hh

Go to the documentation of this file.

//--------------------------------------------------------------------------
// File and Version Information:
//      $Id: TagTransient.hh,v 1.8 2001/10/31 00:04:08 brownd Exp $
//
// Description:
//      Class TagTransient. Interface definition file for transient event tag.
//
// Environment:
//      Software developed for the BaBar Detector at the SLAC B-Factory.
//
// Author List:
//      David R. Quarrie                Original Author
//
// Copyright Information:
//      Copyright (C) 1998              Lawrence Berkeley Laboratory
//
//------------------------------------------------------------------------

#ifndef TAGTRANSIENT_HH
#define TAGTRANSIENT_HH

//-----------------
// BaBar Headers --
//-----------------
#include "BaBar/BaBar.hh"

//----------------------
// Base Class Headers --
//----------------------
#include "AbsEventTag/AbsEventTag.hh"

//------------------------------------
// Collaborating Class Declarations --
//------------------------------------
#include "rw/tvhdict.h"
#include "rw/cstring.h"

//      ---------------------
//      -- Class Interface --
//      ---------------------
 
/**
 ** The TagTransient class. This is an interface for the transient event tag.
 **
 ** The event tag contains named integer, float and boolean elements. The
 ** name of each element must be unique, independent of the data type.
 **
 ** Copyright (C) 1998              Lawrence Berkeley National Laboratory
 **
 ** @version $Id: TagTransient.hh,v 1.8 2001/10/31 00:04:08 brownd Exp $ 
 **
 ** @author (David R. Quarrie)          Originator
 **/

class TagTransient : public AbsEventTag {

//--------------------
// Instance Members --
//--------------------

public:

    // Constructors
    TagTransient( );

    TagTransient( const TagTransient& anotherTag);

    TagTransient& operator = (const TagTransient& other);

    // Destructor
    virtual ~TagTransient( );

    // Selectors
//     RWTValHashDictionary<RWCString, bool>*  bools ( ) const;
//     RWTValHashDictionary<RWCString, int>*   ints  ( ) const;
//     RWTValHashDictionary<RWCString, float>* floats( ) const;
    
    // Operations 
    /**
     ** Retrieve a boolean tag element. The "key" argument is used as
     ** the key for identifying the element. The function value indicates
     ** whether the specified tag element exists, and the "value" argument
     ** is used to return the value of the element.
     **/
    virtual bool getBool ( bool&  value, const char* const key ) const;

    /**
     ** Retrieve an integer tag element. The "key" argument is used as
     ** the key for identifying the element. The function value indicates
     ** whether the specified tag element exists, and the "value" argument
     ** is used to return the value of the element.
     **/
    virtual bool getInt  ( int&   value, const char* const key ) const;

    /**
     ** Retrieve float tag element. The "key" argument is used as
     ** the key for identifying the element. The function value indicates
     ** whether the specified tag element exists, and the "value" argument
     ** is used to return the value of the element.
     **/
    virtual bool getFloat( float& value, const char* const key ) const;

    /**
     ** Insert a boolean tag element. The "key" argument is used as
     ** the key for identifying the element. The function value indicates
     ** whether the insertion was successful. A failure indicates that
     ** the specified name is already in use for an element of another
     ** basic datatype. The "value" argument specifies the value of the 
     ** element.
     **/
    virtual bool putBool ( bool   value, const char* const key );

    /**
     ** Insert an integer tag element. The "key" argument is used as
     ** the key for identifying the element. The function value indicates
     ** whether the insertion was successful. A failure indicates that
     ** the specified name is already in use for an element of another
     ** basic datatype. The "value" argument specifies the value of the 
     ** element.
     **/
    virtual bool putInt  ( int    value, const char* const key );

    /**
     ** Insert a float tag element. The "key" argument is used as
     ** the key for identifying the element. The function value indicates
     ** whether the insertion was successful. A failure indicates that
     ** the specified name is already in use for an element of another
     ** basic datatype. The "value" argument specifies the value of the 
     ** element.
     **/
    virtual bool putFloat( float  value, const char* const key );

    /**
     ** Insert a packed integer tag element. The ownership of the packer is 
     ** taken. 
     **/
    virtual bool putInt  ( int    value, const char* const key,
                           ComPackBase<int>* packer);

    /**
     ** Insert a packed float tag element. 
     **/
    virtual bool putFloat( float  value, const char* const key,
                           ComPackBase<float>* packer);

    /**
     ** Merge the contents with another tag 
     ** @param iwin  specifies which value to use in case of name collision:
     **        true  -- use own value
     **        false -- use other value
     **/
    virtual bool merge( AbsEventTag* anotherTag, bool iwin );

    /**
     ** Return an iterator that allows the boolean elements to be
     ** retrieved from the tag. It is the responsibility of the client
     ** to delete this iterator after use.
     **/
    virtual AbsEventTagBoolIter*  boolIter ( );

    /**
     ** Return an iterator that allows the integer elements to be
     ** retrieved from the tag. It is the responsibility of the client
     ** to delete this iterator after use.
     **/
    virtual AbsEventTagIntIter*   intIter  ( );

    /**
     ** Return an iterator that allows the float elements to be
     ** retrieved from the tag. It is the responsibility of the client
     ** to delete this iterator after use.
     **/
    virtual AbsEventTagFloatIter* floatIter( );

    void lock() {_locked = true;}
protected:

    RWTValHashDictionary<RWCString, bool>*  _bools;
    RWTValHashDictionary<RWCString, int>*   _ints;
    RWTValHashDictionary<RWCString, float>* _floats;

    bool _locked;

    friend class TagTransientBoolIter;
    friend class TagTransientIntIter;
    friend class TagTransientFloatIter;
};

#endif

 

---

BaBar Public Site | SLAC | News | Links | Who's Who | Contact Us

Page Owner: Jacek Becla
Last Update: October 04, 2002