In This Package:

DbiCtx.h

Go to the documentation of this file.

#ifndef DBICTX_H
#define DBICTX_H

#include "DatabaseInterface/Dbi.h"
#include "DatabaseInterface/DbiSqlContext.h"
#include "DatabaseInterface/DbiValidityRec.h"
#include "Context/Context.h"
#include "Context/ContextRange.h"
#include "Context/TimeStamp.h"

#include <string>
using namespace std ;

class DbiCtx
{
public:
    DbiCtx();
    DbiCtx( const char* str );

    void SetDefaults();
    virtual ~DbiCtx();

    // update ctx based on string interpretation
    int Update( const char* str );

    DbiSqlContext* MakeIntervalContext( DbiSqlContext::IntervalType ity=DbiSqlContext::kWithin ); 

    // static converters from strings
    // these should be moved into Conventions/Context once working 

    static Dbi::AbortTest AbortTest_FromString( const char* str );
    static Dbi::Task      Task_FromString( const char* str );
    static Dbi::SubSite   SubSite_FromString( const char* str );
    static Bool_t         FindFullTimeWindow_FromString( const char* str );
    static TimeStamp      TimeStamp_FromString( const char* str );
    static int            SiteMask_FromString( const char* str );
    static int             SimMask_FromString( const char* str );
    static int             int_FromString( const char* str );
    static string          ObjName( const char* pfx, const char* cls );


   // accessors for contained context

    const Context& GetContext(){     return m_context ; }
    const TimeStamp& GetTimeStamp(){ return m_context.GetTimeStamp() ; }
    SimFlag::SimFlag_t GetSimFlag(){ return m_context.GetSimFlag() ; }
    Site::Site_t               GetSite(){       return m_context.GetSite() ; }
    DetectorId::DetectorId_t   GetDetectorId(){ return m_context.GetDetId() ; }

    void SetContext( const Context& context );
    void SetTimeStamp(const TimeStamp& ts);
    void SetSimFlag(SimFlag::SimFlag_t flag);
    void SetSite(Site::Site_t site);
    void SetDetectorId(DetectorId::DetectorId_t det);

   // accessors for direct data members

    Dbi::SubSite   GetSubSite(){ return m_subsite ; }
    Dbi::Task      GetTask(){     return m_task ; }
    Dbi::AbortTest GetAbortTest(){ return m_abortTest ; }
    Bool_t         GetFindFullTimeWindow(){ return m_findFullTimeWindow ; }
    
    void SetSubSite( Dbi::SubSite subsite   );
    void SetTask(    Dbi::Task task   );
    void SetAbortTest( Dbi::AbortTest abortTest );
    void SetFindFullTimeWindow( Bool_t findFullTimeWindow );

   // accessors for low-level and extended queries ... 

    void SetSeqNo( int seqNo ); 
    void SetDbNo( int dbNo );
    void SetSqlContext( const DbiSqlContext& sqlContext );
    void SetSqlContext( const string& ssqlContext );
    void SetDataSql( const string& dataSql );
    void SetDataFillOpts( const string& dataFillOpts );
    void SetValidityRec( const DbiValidityRec& validityRec );  
    void SetTableName( const string& tableName );  
    void SetDbName( const string& dbName );  
    void SetLogComment( const string& logComment );  
    void SetVersionDate( const TimeStamp& versionDate );  

    int   GetSeqNo(){ return m_seqNo ; }
    int   GetDbNo(){  return m_dbNo  ; }
    const DbiSqlContext& GetSqlContext(){ return m_sqlContext ; }
    const string& GetDataSql(){ return m_dataSql ; }
    const string& GetDataFillOpts(){ return m_dataFillOpts ; }
    const DbiValidityRec& GetValidityRec(){ return m_validityRec ; }
    const string& GetTableName(){ return m_tableName ; }
    const string& GetDbName(){ return m_dbName ; }  
    const string& GetLogComment(){ return m_logComment ; }
    const TimeStamp& GetVersionDate(){ return m_versionDate ; }  


   // accessors for contained context range  
   //    timestamp proliferation due to ContextRange implementation preventing returning references 
    
    const ContextRange& GetContextRange(){ return m_contextRange ; }
    TimeStamp GetTimeStart(){ return m_contextRange.GetTimeStart() ;  }
    TimeStamp GetTimeEnd(){   return m_contextRange.GetTimeEnd() ;  }
    int GetSiteMask(){               return m_contextRange.GetSiteMask() ; }
    int GetSimMask(){                return m_contextRange.GetSimMask() ; }
    int GetAggNo(){   return m_aggNo ; }

    void SetContextRange(const ContextRange& range);  // CAUTION : COLLECTIVE SETTER
    void SetTimeStart(const TimeStamp& tstart);
    void SetTimeEnd(const TimeStamp& tend);
    void SetSiteMask( int siteMask );
    void SetSimMask( int simMask );
    void SetAggNo( int aggNo );

    // masks for tracking use of the above  setters , changes and ctors used


    Bool_t IsSet(int mask); 
    Bool_t IsValid();   // mask comparisons to discern if associated object is uptodate  
    void LogMask( int needmask );

    int GetMask(){  return m_mask ; }           // settings (not necessarily changes)
    int GetUpdateMask(){  return m_update ; }   // changes
    int GetCtorMask(){  return m_ctor ; }   
    
    void SetMask(int mask){ m_mask = mask ; }
    void SetUpdateMask(int mask){ m_update = mask ; }
    void SetCtorMask(int mask){ m_ctor = mask ; }


    void RegisterCreation( const char* msg );
    void RegisterFail( const char* msg );

    const char* AsString();
    static const char* MaskAsString(int msk );

private:
    string           m_class ;

    Context          m_context ;
    Dbi::SubSite     m_subsite ;
    Dbi::Task        m_task ;
    Dbi::AbortTest   m_abortTest ;
    Bool_t           m_findFullTimeWindow ; 

    ContextRange     m_contextRange ;
    int              m_aggNo ;
    int              m_seqNo ;
    int              m_dbNo  ;

    DbiSqlContext    m_sqlContext ;
    string           m_dataSql ;
    string           m_dataFillOpts ;
    DbiValidityRec   m_validityRec ;
    string           m_tableName ;
    string           m_dbName ;
    string           m_logComment ;
    TimeStamp        m_versionDate ;

    // masks for settings/updates/ctor  
    int              m_mask ;
    int              m_update ;
    int              m_ctor ;

};

#endif  // DBICTX_H

---