DbiWriter< T > Class Template Reference

Concept Templated class of pointers to Writer objects. Writer objects are lightweight and provide type safe write access to a single validity set of a specific table. A DbiWriter knows about publishing protocols but uses a DbiSqlValPacket both to hold the data in a type- neutral form and to do the actual I/O. Purpose Writers are the primary application output interface to the Dbi. Users instantiate Writers with the information necessary define a validity set and then pass all the rows one at a time, to the writer. The user is able to abort the process at any point before the final commit. More...

#include <DbiWriter.h>

List of all members.

Public Member Functions
	DbiWriter ()
	DbiWriter (const VldRange &vr, Int_t aggNo, Dbi::Task task, VldTimeStamp creationDate, const std::string &dbName, const std::string &logComment="", const std::string &tableName="")
	DbiWriter (const VldRange &vr, Int_t aggNo, Dbi::Task task=0, VldTimeStamp creationDate=VldTimeStamp(0, 0), UInt_t dbNo=0, const std::string &logComment="", const std::string &tableName="")
	DbiWriter (const DbiValidityRec &vrec, const std::string &dbName, const std::string &logComment="")
	DbiWriter (const DbiValidityRec &vrec, UInt_t dbNo=0, const std::string &logComment="")
virtual	~DbiWriter ()
DbiTableProxy &	TableProxy () const
Bool_t	IsOpen (Bool_t reportErrors=kTRUE) const
	Open and ready to receive data.
Bool_t	CanOutput (Bool_t reportErrors=kTRUE) const
	Open and ready to receive/output data.
void	SetDbNo (UInt_t dbNo)
void	SetDbName (const string &dbName)
void	SetLogComment (const std::string &reason)
void	SetRequireGlobalSeqno (Int_t requireGlobal)
void	SetOverlayCreationDate ()
void	Abort ()
Bool_t	Close (const char *fileSpec=0)
Bool_t	Open (const VldRange &vr, Int_t aggNo, Dbi::Task task, VldTimeStamp creationDate, const string &dbName, const std::string &logComment="")
Bool_t	Open (const VldRange &vr, Int_t aggNo, Dbi::Task task=0, VldTimeStamp creationDate=VldTimeStamp(), UInt_t dbNo=0, const std::string &logComment="")
Bool_t	Open (const DbiValidityRec &vrec, const string &dbName, const std::string &logComment="")
Bool_t	Open (const DbiValidityRec &vrec, UInt_t dbNo=0, const std::string &logComment="")
DbiWriter< T > &	operator<< (const T &row)
Private Member Functions
Bool_t	NeedsLogEntry () const
Bool_t	WritingToMaster () const
	DbiWriter (const DbiWriter &)
DbiWriter &	operator= (const DbiWriter &)
void	CompleteOpen (UInt_t dbNo=0, const std::string &logComment="")
void	Reset ()
Static Private Member Functions
DbiTableProxy &	GetTableProxy ()
DbiTableProxy &	GetTableProxy (const std::string &tableName)
Private Attributes
Int_t	fAggregateNo
	Aggregate noumber for set.
UInt_t	fDbNo
	Database number in cascade.
DbiSqlValPacket *	fPacket
	The assembled record to be output. Never null.
Int_t	fRequireGlobalSeqno
	Controls SEQNO type (see DbiCascader::AllocateSeqNo).
DbiTableProxy *	fTableProxy
	Proxy to associated table.
std::string	fTableName
	Associated table name.
Bool_t	fUseOverlayCreationDate
	Use overlay creation date if true.
DbiValidityRec *	fValidRec
	Validity record. May be =0 if closed.
DbiLogEntry	fLogEntry
	Associated log entry (if any) for update.

---

Detailed Description

template<class T>
class DbiWriter< T >

Concept Templated class of pointers to Writer objects. Writer objects are lightweight and provide type safe write access to a single validity set of a specific table. A DbiWriter knows about publishing protocols but uses a DbiSqlValPacket both to hold the data in a type- neutral form and to do the actual I/O. Purpose Writers are the primary application output interface to the Dbi. Users instantiate Writers with the information necessary define a validity set and then pass all the rows one at a time, to the writer. The user is able to abort the process at any point before the final commit.

Id

DbiWriter.h,v 1.24 2006/08/08 10:51:32 west Exp

DatabaseInterface

Contact: n.west1@physics.ox.ac.uk

Definition at line 45 of file DbiWriter.h.

---

Constructor & Destructor Documentation

template<class T> DbiWriter< T >::DbiWriter (   )

template<class T> DbiWriter< T >::DbiWriter (  const VldRange &  vr, Int_t  aggNo, Dbi::Task  task, VldTimeStamp  creationDate, const std::string &  dbName, const std::string &  logComment = "", const std::string &  tableName = "" )

Definition at line 128 of file DbiWriter.tpl. References DbiWriter< T >::fTableName, LEA_CTOR, MSG, and DbiWriter< T >::Open(). : fAggregateNo(aggNo), fPacket(new DbiSqlValPacket), fRequireGlobalSeqno(0), fTableProxy(&DbiWriter<T>::GetTableProxy(tableName)), fTableName(fTableProxy->GetTableName()), fUseOverlayCreationDate(creationDate == VldTimeStamp(0,0)), fValidRec(0), fLogEntry(fTableName,logComment,vr.GetDetectorMask(),vr.GetSimMask(),task) { // // Purpose: Constructor // // Arguments: // vr in Validity range of validity set. // aggNo in Aggregate number of validity set. // task in Task of validity set. // creationDate in Creation date of validity set. // dbName in Database name. // logComment in Reason for update. // tableName in Table name (default: "" - get table name from object type) // // Return: n/a // // Contact: N. West // // Specification:- // ============= // // o Create Writer. // Program Notes:- // ============= // None. LEA_CTOR //Leak Checker MSG("Dbi", Msg::kVerbose) << "Creating DbiWriter for " << fTableName << endl; Open(vr,aggNo,task,creationDate,dbName,logComment); }

template<class T> DbiWriter< T >::DbiWriter (  const VldRange &  vr, Int_t  aggNo, Dbi::Task  task = 0, VldTimeStamp  creationDate = VldTimeStamp(0, 0), UInt_t  dbNo = 0, const std::string &  logComment = "", const std::string &  tableName = "" )

Definition at line 72 of file DbiWriter.tpl. References DbiWriter< T >::fTableName, LEA_CTOR, MSG, and DbiWriter< T >::Open(). : fAggregateNo(aggNo), fDbNo(dbNo), fPacket(new DbiSqlValPacket), fRequireGlobalSeqno(0), fTableProxy(&DbiWriter<T>::GetTableProxy(tableName)), fTableName(fTableProxy->GetTableName()), fUseOverlayCreationDate(creationDate == VldTimeStamp(0,0)), fValidRec(0), fLogEntry(fTableName,logComment,vr.GetDetectorMask(),vr.GetSimMask(),task) { // // Purpose: Constructor // // Arguments: // vr in Validity range of validity set. // aggNo in Aggregate number of validity set. // task in Task of validity set. // creationDate in Creation date of validity set. // dbNo in Database number in cascade (starting at 0). // logComment in Reason for update. // tableName in Table name (default: "" - get table name from object type) // // Return: n/a // // Contact: N. West // // Specification:- // ============= // // o Create Writer. // Program Notes:- // ============= // None. LEA_CTOR //Leak Checker MSG("Dbi", Msg::kVerbose) << "Creating DbiWriter for " << fTableName << endl; Open(vr,aggNo,task,creationDate,dbNo,logComment); }

template<class T> DbiWriter< T >::DbiWriter (  const DbiValidityRec &  vrec, const std::string &  dbName, const std::string &  logComment = "" )

Definition at line 234 of file DbiWriter.tpl. References LEA_CTOR, MSG, and DbiWriter< T >::Open(). : fAggregateNo(0), fPacket(new DbiSqlValPacket), fRequireGlobalSeqno(0), fTableProxy(0), fUseOverlayCreationDate(kFALSE), fValidRec(new DbiValidityRec(vrec)), fLogEntry(fTableName,logComment,vrec.GetVldRange().GetDetectorMask(), vrec.GetVldRange().GetSimMask(),vrec.GetTask()) { // // Purpose: Constructor // // Arguments: // vrec in Validity record for set. // MUST have an associated DbiTableProxy // dbName in Database name. // logComment in Reason for update. // // // Return: n/a // // Contact: N. West // // Specification:- // ============= // // o Create Writer. // Program Notes:- // ============= // None. LEA_CTOR //Leak Checker T pet; MSG("Dbi", Msg::kVerbose) << "Creating DbiWriter for " << pet.GetName() << endl; this->Open(vrec,dbName,logComment); }

template<class T> DbiWriter< T >::DbiWriter (  const DbiValidityRec &  vrec, UInt_t  dbNo = 0, const std::string &  logComment = "" )

Definition at line 183 of file DbiWriter.tpl. References LEA_CTOR, MSG, and DbiWriter< T >::Open(). : fAggregateNo(0), fDbNo(dbNo), fPacket(new DbiSqlValPacket), fRequireGlobalSeqno(0), fTableProxy(0), fUseOverlayCreationDate(kFALSE), fValidRec(new DbiValidityRec(vrec)), fLogEntry(fTableName,logComment,vrec.GetVldRange().GetDetectorMask(), vrec.GetVldRange().GetSimMask(),vrec.GetTask()) { // // Purpose: Constructor // // Arguments: // vrec in Validity record for set. // MUST have an associated DbiTableProxy // dbNo in Database number in cascade (starting at 0). // logComment in Reason for update. // // // Return: n/a // // Contact: N. West // // Specification:- // ============= // // o Create Writer. // Program Notes:- // ============= // None. LEA_CTOR //Leak Checker T pet; MSG("Dbi", Msg::kVerbose) << "Creating DbiWriter for " << pet.GetName() << endl; this->Open(vrec,dbNo,logComment); }

template<class T> DbiWriter< T >::~DbiWriter (   )  [virtual]

Definition at line 285 of file DbiWriter.tpl. References DbiWriter< T >::fPacket, DbiWriter< T >::fValidRec, LEA_DTOR, MSG, and DbiWriter< T >::Reset(). { // // // Purpose: Destructor LEA_DTOR //Leak Checker MSG("Dbi", Msg::kVerbose) << "Destroying DbiWriter" << endl; Reset(); delete fPacket; fPacket = 0; delete fValidRec; fValidRec = 0; }

template<class T> DbiWriter< T >::DbiWriter (  const DbiWriter< T > &   )  [private]

---

Member Function Documentation

template<class T> void DbiWriter< T >::Abort (   )  [inline]

Definition at line 94 of file DbiWriter.h. Referenced by DbiWriter< T >::operator<<(). { Reset(); }

template<class T> Bool_t DbiWriter< T >::CanOutput (  Bool_t  reportErrors = kTRUE  )  const

Open and ready to receive/output data. Definition at line 336 of file DbiWriter.tpl. References DbiWriter< T >::fLogEntry, DbiWriter< T >::fPacket, DbiWriter< T >::fTableName, DbiSqlValPacket::GetNumSqlStmts(), DbiSqlValPacket::GetStmt(), DbiLogEntry::HasReason(), DbiWriter< T >::IsOpen(), MSG, DbiWriter< T >::NeedsLogEntry(), and DbiSqlValPacket::Print(). Referenced by DbiWriter< T >::Close(), DetailedTimeCal(), load_better_mipcal(), load_mc_mipcal(), main(), LIPlexMaps::MakeCalAdcToPe(), LIPlexMaps::MakeCalMIPCalibration(), LIPlexMaps::MakeCalStripAtten(), LIPlexMaps::MakeCalStripToStrip(), LIPlexMaps::MakePlexStripEndToLed(), MakeTimeCal(), and DbiWriter< T >::Open(). { // // // Purpose: Return true if open and ready to receive/output data. if ( ! this->IsOpen(reportErrors) ) return kFALSE; if ( this->NeedsLogEntry() && ! fLogEntry.HasReason() ) { if ( reportErrors ) MSG("Dbi",Msg::kError) << "Cannot output validity set for table " << fTableName << ", writing to Master DB but no log comment has been supplied." << endl; return kFALSE; } UInt_t nstmts = fPacket->GetNumSqlStmts(); if ( nstmts == 0 ) { // not even a VLD insert if ( reportErrors ) MSG("Dbi",Msg::kError) << "Cannot output validity set for table " << fTableName << ", no data has been written." << endl; return kFALSE; } if ( nstmts == 1 ) { // if VLD insert present but no data rows, just issue a stern warning // as it may be intended to obscure now invalid data string stmt = fPacket->GetStmt(0); bool isvldentry = (stmt.find("INSERT INTO") != string::npos ) && (stmt.find("VLD VALUES") != string::npos); if ( isvldentry ) { if ( reportErrors ) MSG("Dbi",Msg::kWarning) << "VLD entry but no data for " << fTableName << endl; } else { // this should never, ever happen ... but let's be paranoid if ( reportErrors ) { MSG("Dbi",Msg::kError) << "Cannot output validity set for table " << fTableName << ", (no VLD info) no data has been written." << endl; fPacket->Print(); } return kFALSE; } } return kTRUE; }

template<class T> Bool_t DbiWriter< T >::Close (  const char *  fileSpec = 0  )

Definition at line 394 of file DbiWriter.tpl. References DbiCascader::AllocateSeqNo(), DbiWriter< T >::CanOutput(), DbiSqlValPacket::Clear(), DbiWriter< T >::fDbNo, DbiWriter< T >::fLogEntry, DbiWriter< T >::fPacket, DbiWriter< T >::fTableName, DbiWriter< T >::fTableProxy, DbiWriter< T >::fUseOverlayCreationDate, DbiWriter< T >::fValidRec, DbiTableProxy::GetCascader(), DbiLogEntry::HasReason(), MSG, DbiWriter< T >::NeedsLogEntry(), DbiTableProxy::QueryOverlayCreationDate(), DbiSqlValPacket::SetCreationDate(), DbiSqlValPacket::SetSeqNo(), DbiSqlValPacket::Store(), DbiLogEntry::Write(), DbiSqlValPacket::Write(), and DbiWriter< T >::WritingToMaster(). Referenced by BMFileSummaryFiller::Commit(), DbuDaqFileModule::CommitDbuDaqConfigFilesText(), BMSpillFiller::DBU(), DetailedTimeCal(), PulserDBModule::DoWriteGC(), PulserDBModule::DriftPoint(), BeamMonSwicPedsDbuModule::Dump(), Fill_MBSpill(), PhotonStatSummarizer::FillPmtDatabase(), FitNdNonlinQuad(), load_better_mipcal(), load_mc_mipcal(), LoadBeamMomentum(), LoadCERRange(), LoadCERTimeWin(), LoadOverlapWin(), LoadTOFRange(), lootSpillFile(), main(), LIPlexMaps::MakeCalAdcToPe(), LIPlexMaps::MakeCalMIPCalibration(), LIPlexMaps::MakeCalStripAtten(), LIPlexMaps::MakeCalStripToStrip(), MakeFilterChannelList(), LIPlexMaps::MakePlexStripEndToLed(), UgliGeometryReroot::MakeTempDbiGeometry(), UgliGeometryReroot::MakeTempDbiPosInfo(), UgliGeometryReroot::MakeTempDbiScintStruct(), MakeTimeCal(), DbiWriter< T >::Open(), DcsWriter::ProcessRawRecord(), AutoPIDMaker::Reco(), PulserGainFit::RunNearFarFits(), PulserGainFit::RunPinFits(), NDSgateTimeLooter::Write(), DbiConfigStream::Write(), CoilTools::Write(), BMCutsFiller::Write(), BadHardwareTableMaker::Write(), FitGC::WriteDB(), ChannelNoiseRates::WriteRates(), PulserFromRawCollectorModule::WriteRawCurveData(), PulserCollectorModule::WriteRawCurveData(), PulserFromRawCollectorModule::WriteRawDriftData(), PulserCollectorModule::WriteRawDriftData(), PulserFromRawCollectorModule::WriteReferenceDriftData(), PulserCollectorModule::WriteReferenceDriftData(), DbuDaqMonitorModule::WriteVaChipPedsEntry(), DbuDaqMonitorModule::WriteVaChipSparsEntry(), and BMWriteHadMuRel::~BMWriteHadMuRel(). { // // // Purpose: Close current validity set and write it to the database. // // Arguments: // // fileSpec in File pointer. If not null write to file instead of database. // // Return: kTRUE is I/O successful. // // Contact: N. West // // Specification:- // ============= // // o Close current validity set and write it to the database. // Program Notes:- // ============= // None. Bool_t ok = kFALSE; // Skip output unless good data to output. if ( CanOutput() ) { // Find the next free sequence number. It must be global if writing to a // to a file, otherwise it can be local if DB isn't authorising. int seqNoType = fileSpec ? 1 : fRequireGlobalSeqno; Int_t seqNo = fTableProxy->GetCascader().AllocateSeqNo(fTableName,seqNoType,fDbNo); if ( seqNo <= 0 ) { MSG("Dbi",Msg::kError) << "Cannot get sequence number for table " << fTableName << endl; } else { // Use overlay creation date if required. if ( fUseOverlayCreationDate && fValidRec ) fPacket->SetCreationDate(fTableProxy->QueryOverlayCreationDate(*fValidRec,fDbNo)); // Set SEQNO and perform I/O. fPacket->SetSeqNo(seqNo); if ( fileSpec ) { ofstream fs(fileSpec,ios_base::app); if ( ! fs ) MSG("Dbm", Msg::kError) << "Unable to open " << fileSpec << endl; else ok = fPacket->Write(fs,true); } else { ok = fPacket->Store(fDbNo); } // Record update if I/O successful and required. if ( ok && this->WritingToMaster() ) { if ( this->NeedsLogEntry() || fLogEntry.HasReason() ) ok = fLogEntry.Write(fDbNo,seqNo); } } } // Clear out ready for any further I/O. fPacket->Clear(); return ok; }

template<class T> void DbiWriter< T >::CompleteOpen (  UInt_t  dbNo = 0, const std::string &  logComment = "" )  [private]

Definition at line 467 of file DbiWriter.tpl. References DbiWriter< T >::fAggregateNo, DbiWriter< T >::fDbNo, DbiWriter< T >::fLogEntry, DbiWriter< T >::fPacket, DbiWriter< T >::fTableName, DbiWriter< T >::fTableProxy, DbiWriter< T >::fValidRec, DbiValidityRec::GetAggregateNo(), DbiValidityRec::GetCreationDate(), VldRange::GetDetectorMask(), VldRange::GetSimMask(), DbiTableProxy::GetTableName(), DbiValidityRec::GetTask(), DbiValidityRec::GetVldRange(), MSG, DbiLogEntry::Recreate(), DbiSqlValPacket::Recreate(), and DbiWriter< T >::Reset(). Referenced by DbiWriter< T >::Open(). { // // // Purpose: Complete the open process // // Arguments: // dbNo in Database number in cascade (starting at 0). // logComment in Reason for update. // // // Specification:- // ============= // // o Complete reinitialisation for new I/O // Program Notes:- // ============= // Assumes that fTableProxy, fUseOverlayCreationDate, fValidRec are // already initialised. fDbNo = dbNo; if ( (int) fDbNo < 0 ) { MSG("Dbi",Msg::kError) << "Bad database name/number selected. " << endl; this->Reset(); return; } fAggregateNo = fValidRec->GetAggregateNo(); fTableName = fTableProxy->GetTableName(), // Recreate validity packet. fPacket->Recreate(fTableName, fValidRec->GetVldRange(), fAggregateNo, fValidRec->GetTask(), fValidRec->GetCreationDate()); // Recreate log entry. const VldRange& vr = fValidRec->GetVldRange(); fLogEntry.Recreate(fTableName, logComment, vr.GetDetectorMask(), vr.GetSimMask(), fValidRec->GetTask()); }

template<class T> DbiTableProxy & DbiWriter< T >::GetTableProxy (  const std::string &  tableName  )  [static, private]

Definition at line 539 of file DbiWriter.tpl. References DbiResultPtr< T >::GetTableProxy(). { // // // Purpose: Private static function to find an alternative // associated DbiTableProxy. // // Arguments: // tableName in Alternative table name // // Return: Associated DbiTableProxy. // // Contact: N. West // // Specification:- // ============= // // o Ask Registry for alternative Table Proxy and return it. // As DbiResultPtr classes are in 1:1 correspondance with DbiWriter // classes, DbiWriter uses the static methods from DbiResultPtr // to find the associated DbiTableProxy. return DbiResultPtr<T>::GetTableProxy(tableName); }

template<class T> DbiTableProxy & DbiWriter< T >::GetTableProxy (   )  [static, private]

Definition at line 520 of file DbiWriter.tpl. References DbiResultPtr< T >::GetTableProxy(). Referenced by DbiWriter< T >::Open(), and DbiWriter< T >::Reset(). { // // // Purpose: Private static function to find default associated // DbiTableProxy. // Program Notes:- // ============= // As DbiResultPtr classes are in 1:1 correspondance with DbiWriter // classes, DbiWriter uses the static methods from DbiResultPtr // to find the associated DbiTableProxy. return DbiResultPtr<T>::GetTableProxy(); }

template<class T> Bool_t DbiWriter< T >::IsOpen (  Bool_t  reportErrors = kTRUE  )  const

Open and ready to receive data. Definition at line 568 of file DbiWriter.tpl. References DbiWriter< T >::fPacket, DbiWriter< T >::fTableName, DbiWriter< T >::fValidRec, DbiSqlValPacket::GetNumSqlStmts(), DbiTableProxyRegistry::IsActive(), and MSG. Referenced by DbiWriter< T >::CanOutput(), LIPlexMaps::MakeCalAdcToPe(), LIPlexMaps::MakeCalMIPCalibration(), LIPlexMaps::MakeCalStripAtten(), LIPlexMaps::MakeCalStripToStrip(), LIPlexMaps::MakePlexStripEndToLed(), DbiWriter< T >::operator<<(), PulserGainFit::RunNearFarFits(), and PulserGainFit::RunPinFits(). { // // // Purpose: Return true if open and ready to receive data. if ( ! DbiTableProxyRegistry::IsActive() ) { if ( reportErrors ) MSG("Dbi",Msg::kError) << "Cannot use DbiWriter, the DBI has been shutdown." << endl; } else if ( !fValidRec || fPacket->GetNumSqlStmts() < 1 ) { if ( reportErrors ) MSG("Dbi",Msg::kError) << "Cannot do I/O on DbiWriter for " << fTableName <<", it is currently closed." << endl; } else return kTRUE; return kFALSE; }

template<class T> Bool_t DbiWriter< T >::NeedsLogEntry (   )  const [private]

Definition at line 592 of file DbiWriter.tpl. References DbiWriter< T >::fTableName, and DbiWriter< T >::WritingToMaster(). Referenced by DbiWriter< T >::CanOutput(), and DbiWriter< T >::Close(). { // // // Purpose: Return true if a log entry is required. // Some tables are created automatically so don't require entries. string tableName(fTableName); if ( tableName.substr(0,7) == "BEAMMON" || tableName.substr(0,16) == "BFLDDBICOILSTATE" || tableName.substr(0,3) == "CAL" || tableName.substr(0,20) == "CANDDIGITBADCHANNELS" || tableName.substr(0,3) == "DBU" || tableName.substr(0,3) == "DCS" || tableName.substr(0,6) == "PULSER" || tableName.substr(0,9) == "SPILLTIME" ) return kFALSE; // All other tables need entries if writing to a Master database. return this->WritingToMaster(); }

template<class T> Bool_t DbiWriter< T >::Open (  const DbiValidityRec &  vrec, UInt_t  dbNo = 0, const std::string &  logComment = "" )

Definition at line 705 of file DbiWriter.tpl. References DbiWriter< T >::CanOutput(), DbiWriter< T >::Close(), DbiWriter< T >::CompleteOpen(), DbiWriter< T >::fTableProxy, DbiWriter< T >::fUseOverlayCreationDate, DbiWriter< T >::fValidRec, DbiValidityRec::GetCreationDate(), DbiTableProxy::GetTableName(), DbiValidityRec::GetTableProxy(), DbiWriter< T >::GetTableProxy(), DbiTableProxyRegistry::IsActive(), MSG, and DbiWriter< T >::Reset(). { // // Purpose: Output any existing data and open new validity set. // // Arguments: // vrec in Validity record for set. // MUST have an associated DbiTableProxy // dbNo in Database number in cascade (starting at 0). // logComment in Reason for update. // // // Return: kTRUE if no errors detected. // // Contact: N. West // // Specification:- // ============= // // o Output any existing data and open new validity set. // Program Notes:- // ============= // None. bool ok = true; if ( ! DbiTableProxyRegistry::IsActive() ) return kFALSE; if ( this->CanOutput(kFALSE) ) ok = Close(); // Check that vrec is associated with the right table, but waive // test for DbiConfigSet so that it can be used with any. const DbiTableProxy& proxyDefault = DbiWriter<T>::GetTableProxy(); const DbiTableProxy& proxyVrec = *vrec.GetTableProxy(); if ( proxyDefault.GetTableName() != "DBICONFIGSET" && proxyVrec.GetTableName() != proxyDefault.GetTableName() ) { MSG("Dbi",Msg::kError) << "Unable to create DbiWriter from query:" << endl << vrec << " was filled by " << proxyVrec.GetTableName() << " not by " << proxyDefault.GetTableName() << endl; this->Reset(); return false; } else { // Have to cast away const - DbiWriter needs a modifiable DbiTableProxy. fTableProxy = const_cast<DbiTableProxy*>(&proxyVrec); } fUseOverlayCreationDate = vrec.GetCreationDate() == VldTimeStamp(0,0); delete fValidRec; fValidRec = new DbiValidityRec(vrec); // Complete opening. this->CompleteOpen(dbNo,logComment); return ok; }

template<class T> Bool_t DbiWriter< T >::Open (  const DbiValidityRec &  vrec, const string &  dbName, const std::string &  logComment = "" )

Definition at line 773 of file DbiWriter.tpl. References DbiWriter< T >::fDbNo, DbiWriter< T >::Open(), and DbiWriter< T >::SetDbName(). { // // Purpose: Output any existing data and open new validity set. // // Arguments: // vrec in Validity record for set. // MUST have an associated DbiTableProxy // dbName in Database name. // logComment in Reason for update. // // // Return: kTRUE if no errors detected. this->SetDbName(dbName); return this->Open(vrec, fDbNo, logComment); }

template<class T> Bool_t DbiWriter< T >::Open (  const VldRange &  vr, Int_t  aggNo, Dbi::Task  task = 0, VldTimeStamp  creationDate = VldTimeStamp(), UInt_t  dbNo = 0, const std::string &  logComment = "" )

Definition at line 617 of file DbiWriter.tpl. References DbiWriter< T >::CanOutput(), DbiWriter< T >::Close(), DbiWriter< T >::CompleteOpen(), DbiWriter< T >::fTableName, DbiWriter< T >::fTableProxy, DbiWriter< T >::fUseOverlayCreationDate, DbiWriter< T >::fValidRec, DbiWriter< T >::GetTableProxy(), and DbiTableProxyRegistry::IsActive(). { // // // Purpose: Output any existing data and open new validity set. // // Arguments: // vr in Validity range of validity set. // aggNo in Aggregate number of validity set. // task in Task of validity set. // creationDate in Creation date of validity set. // dbNo in Database number in cascade (starting at 0). // logComment in Reason for update. // // Return: kTRUE if no errors detected. // // Contact: N. West // // Specification:- // ============= // // o Output any existing data and open new validity set. // Program Notes:- // ============= // None. bool ok = true; if ( ! DbiTableProxyRegistry::IsActive() ) return kFALSE; if ( this->CanOutput(kFALSE) ) ok = Close(); // Test for special creation date. fUseOverlayCreationDate = creationDate == VldTimeStamp(0,0); // Create a validity record. delete fValidRec; fValidRec = new DbiValidityRec(vr,task,aggNo,0,0,kFALSE,creationDate); // Get a proxy. fTableProxy = &DbiWriter<T>::GetTableProxy(fTableName); // Complete opening. this->CompleteOpen(dbNo,logComment); return ok; }

template<class T> Bool_t DbiWriter< T >::Open (  const VldRange &  vr, Int_t  aggNo, Dbi::Task  task, VldTimeStamp  creationDate, const string &  dbName, const std::string &  logComment = "" )

Definition at line 672 of file DbiWriter.tpl. References DbiWriter< T >::fDbNo, and DbiWriter< T >::SetDbName(). Referenced by DbiWriter< T >::DbiWriter(), DbiWriter< T >::Open(), PulserGainFit::RunNearFarFits(), PulserGainFit::RunPinFits(), and FitGC::WriteDB(). { // // // Purpose: Output any existing data and open new validity set. // // Arguments: // vr in Validity range of validity set. // aggNo in Aggregate number of validity set. // task in Task of validity set. // creationDate in Creation date of validity set. // dbName in Database name. // logComment in Reason for update. // // Return: kTRUE if no errors detected. this->SetDbName(dbName); return this->Open(vr, aggNo, task, creationDate, fDbNo, logComment); }

template<class T> DbiWriter< T > & DbiWriter< T >::operator<< (  const T &  row  )

Definition at line 306 of file DbiWriter.tpl. References DbiWriter< T >::Abort(), DbiSqlValPacket::AddDataRow(), DbiWriter< T >::fAggregateNo, DbiWriter< T >::fPacket, DbiWriter< T >::fTableName, DbiWriter< T >::fTableProxy, DbiWriter< T >::fValidRec, DbiValidityRec::GetAggregateNo(), DbiWriter< T >::IsOpen(), and MSG. { // // // Purpose: Stream row into this DbiWriter. if ( ! this->IsOpen() ) return *this; Int_t AggNoRow = row.GetAggregateNo(); if ( fAggregateNo != AggNoRow ) { MSG("Dbi",Msg::kError) << "Cannot store row data for table " << fTableName << ", current set has aggregate no.: " << fAggregateNo << ", but it has: " << AggNoRow << " \n closing DbiWriter" << endl; this->Abort(); return *this; } if ( ! fPacket->AddDataRow(*fTableProxy,fValidRec,row) ) { MSG("Dbi",Msg::kError) << "Closing DbiWriter due to above error." << endl; this->Abort(); } return *this; }

template<class T> DbiWriter& DbiWriter< T >::operator= (  const DbiWriter< T > &   )  [private]

template<class T> void DbiWriter< T >::Reset (   )  [private]

Definition at line 799 of file DbiWriter.tpl. References DbiSqlValPacket::Clear(), DbiWriter< T >::fAggregateNo, DbiWriter< T >::fDbNo, DbiWriter< T >::fPacket, DbiWriter< T >::fTableName, DbiWriter< T >::fTableProxy, DbiWriter< T >::fValidRec, DbiTableProxy::GetTableName(), and DbiWriter< T >::GetTableProxy(). Referenced by DbiWriter< T >::CompleteOpen(), DbiWriter< T >::Open(), and DbiWriter< T >::~DbiWriter(). { // // // Purpose: Clear out data and reset ready for any further I/O. // // Arguments: None. // // Return: None. // // Contact: N. West // // Specification:- // ============= // // o Clear out data and reset ready for any further I/O. // Program Notes:- // ============= // None. fAggregateNo = 0; fDbNo = 0; fPacket->Clear(); fTableProxy = &DbiWriter<T>::GetTableProxy(); fTableName = fTableProxy->GetTableName(); delete fValidRec; fValidRec = 0; }

template<class T> void DbiWriter< T >::SetDbName (  const string &  dbName  )

Definition at line 833 of file DbiWriter.tpl. References DbiWriter< T >::fDbNo, DbiTableProxyRegistry::GetCascader(), DbiCascader::GetDbNo(), and DbiTableProxyRegistry::Instance(). Referenced by PulserGainFit::ConfigModified(), PulserDBModule::DoWriteGC(), DbiWriter< T >::Open(), and FitGC::WriteDB(). { // // // Purpose: Set Database entry by name. Default: entry 0. if ( dbName == "" ) { fDbNo = 0; } else { fDbNo = DbiTableProxyRegistry::Instance().GetCascader().GetDbNo(dbName); } }

template<class T> void DbiWriter< T >::SetDbNo (  UInt_t  dbNo  )  [inline]

Definition at line 86 of file DbiWriter.h. { fDbNo = dbNo;}

template<class T> void DbiWriter< T >::SetLogComment (  const std::string &  reason  )

Definition at line 849 of file DbiWriter.tpl. References DbiWriter< T >::fLogEntry, and DbiLogEntry::SetReason(). Referenced by BMWriteHadMuRelImp::BMWriteHadMuRelImp(). { // // // Purpose: Set log comment. fLogEntry.SetReason(reason); }

template<class T> void DbiWriter< T >::SetOverlayCreationDate (   )  [inline]

Definition at line 91 of file DbiWriter.h. Referenced by DbiConfigStream::Write(), and FitGC::WriteDB(). {fUseOverlayCreationDate = kTRUE;}

template<class T> void DbiWriter< T >::SetRequireGlobalSeqno (  Int_t  requireGlobal  )  [inline]

Definition at line 90 of file DbiWriter.h. Referenced by DbiConfigStream::Write(), and BMCutsFiller::Write(). {fRequireGlobalSeqno = requireGlobal;}

template<class T> DbiTableProxy & DbiWriter< T >::TableProxy (   )  const

Definition at line 861 of file DbiWriter.tpl. Referenced by PulserDBModule::DoWriteGC(), UgliGeometryReroot::MakeTempDbiGeometry(), UgliGeometryReroot::MakeTempDbiPosInfo(), and UgliGeometryReroot::MakeTempDbiScintStruct(). { // // // Purpose: Return DbiTableProxy. // assert( DbiTableProxyRegistry::IsActive() ); return *fTableProxy; }

template<class T> Bool_t DbiWriter< T >::WritingToMaster (   )  const [private]

Definition at line 874 of file DbiWriter.tpl. References DbiWriter< T >::fDbNo, DbiWriter< T >::fTableName, DbiCascader::GetAuthorisingDbNo(), DbiTableProxyRegistry::GetCascader(), DbiTableProxyRegistry::Instance(), and DbiCascader::IsTemporaryTable(). Referenced by DbiWriter< T >::Close(), and DbiWriter< T >::NeedsLogEntry(). { // // // Purpose: Return true if writing permanent data to a Master Database. DbiCascader& cascader = DbiTableProxyRegistry::Instance().GetCascader(); return ( fDbNo == (UInt_t) cascader.GetAuthorisingDbNo() && ! cascader.IsTemporaryTable(fTableName,fDbNo)); }

---

Member Data Documentation

template<class T> Int_t DbiWriter< T >::fAggregateNo [private]

Aggregate noumber for set. Definition at line 139 of file DbiWriter.h. Referenced by DbiWriter< T >::CompleteOpen(), DbiWriter< T >::operator<<(), and DbiWriter< T >::Reset().

template<class T> UInt_t DbiWriter< T >::fDbNo [private]

Database number in cascade. Definition at line 142 of file DbiWriter.h. Referenced by DbiWriter< T >::Close(), DbiWriter< T >::CompleteOpen(), DbiWriter< T >::Open(), DbiWriter< T >::Reset(), DbiWriter< T >::SetDbName(), and DbiWriter< T >::WritingToMaster().

template<class T> DbiLogEntry DbiWriter< T >::fLogEntry [private]

Associated log entry (if any) for update. Definition at line 163 of file DbiWriter.h. Referenced by DbiWriter< T >::CanOutput(), DbiWriter< T >::Close(), DbiWriter< T >::CompleteOpen(), and DbiWriter< T >::SetLogComment().

template<class T> DbiSqlValPacket* DbiWriter< T >::fPacket [private]

The assembled record to be output. Never null. Definition at line 145 of file DbiWriter.h. Referenced by DbiWriter< T >::CanOutput(), DbiWriter< T >::Close(), DbiWriter< T >::CompleteOpen(), DbiWriter< T >::IsOpen(), DbiWriter< T >::operator<<(), DbiWriter< T >::Reset(), and DbiWriter< T >::~DbiWriter().

template<class T> Int_t DbiWriter< T >::fRequireGlobalSeqno [private]

Controls SEQNO type (see DbiCascader::AllocateSeqNo). Definition at line 148 of file DbiWriter.h.

template<class T> std::string DbiWriter< T >::fTableName [private]

Associated table name. Definition at line 154 of file DbiWriter.h. Referenced by DbiWriter< T >::CanOutput(), DbiWriter< T >::Close(), DbiWriter< T >::CompleteOpen(), DbiWriter< T >::DbiWriter(), DbiWriter< T >::IsOpen(), DbiWriter< T >::NeedsLogEntry(), DbiWriter< T >::Open(), DbiWriter< T >::operator<<(), DbiWriter< T >::Reset(), and DbiWriter< T >::WritingToMaster().

template<class T> DbiTableProxy* DbiWriter< T >::fTableProxy [private]

Proxy to associated table. Definition at line 151 of file DbiWriter.h. Referenced by DbiWriter< T >::Close(), DbiWriter< T >::CompleteOpen(), DbiWriter< T >::Open(), DbiWriter< T >::operator<<(), and DbiWriter< T >::Reset().

template<class T> Bool_t DbiWriter< T >::fUseOverlayCreationDate [private]

Use overlay creation date if true. Definition at line 157 of file DbiWriter.h. Referenced by DbiWriter< T >::Close(), and DbiWriter< T >::Open().

template<class T> DbiValidityRec* DbiWriter< T >::fValidRec [private]

Validity record. May be =0 if closed. Definition at line 160 of file DbiWriter.h. Referenced by DbiWriter< T >::Close(), DbiWriter< T >::CompleteOpen(), DbiWriter< T >::IsOpen(), DbiWriter< T >::Open(), DbiWriter< T >::operator<<(), DbiWriter< T >::Reset(), and DbiWriter< T >::~DbiWriter().

---

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

• DbiWriter.h
• DbiWriter.tpl

---