DbiConfigStream Class Reference

#include <DbiConfigStream.h>

List of all members.

Public Member Functions
	DbiConfigStream ()
	DbiConfigStream (const std::string &SoftwName, const std::string &ConfigName="default", VldContext vc=DbiConfigStream::fgDefaultContext, Dbi::Task task=0, const std::string &tableName="SOFTWARE_CONFIGURATION")
virtual	~DbiConfigStream ()
const DbiConfigStream &	operator>> (Registry *reg)
const DbiConfigSet *	GetConfigSet () const
DbiConfigStream &	operator<< (const Registry *reg)
Bool_t	IsEmpty ()
DbiValidityRec &	GetValidityRec ()
Bool_t	Write (UInt_t dbNo=0, const std::string &logComment="", Bool_t localTest=false)
Static Public Attributes
static VldContext	fgDefaultContext
Private Member Functions
	DbiConfigStream (const DbiConfigStream &)
Private Attributes
const DbiConfigSet *	fCFSet
DbiResultPtr< DbiConfigSet >	fCFSetTable
	Pointer to ConfigSet table.
DbiConfigSet	fCFSetModified
	Local DbiConfigSet (empty until/unless filled using operator <<).
DbiValidityRec	fVRec
	Associated validity rec (used when writing back to the database).
std::string	fConfigName
	Name of the configuration set.
std::string	fSoftwName
	Name of the software system to be configured.

---

Detailed Description

Id

DbiConfigStream.h,v 1.13 2006/10/11 08:25:54 west Exp

Definition at line 38 of file DbiConfigStream.h.

---

Constructor & Destructor Documentation

DbiConfigStream::DbiConfigStream

(

)

Definition at line 34 of file DbiConfigStream.cxx.

References Msg::kDebug, LEA_CTOR, and MSG.

                                 :
fCFSet(0)
{
//
//
//  Purpose:  Default constructor
//
//  Arguments: None.  
//
//  Return:    n/a
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o Create dummy ConfigStream.


//  Program Notes:-
//  =============

//  None.

  LEA_CTOR    //Leak Checker

  MSG("Dbi", Msg::kDebug) << "Creating DbiConfigStream" << endl;
}

DbiConfigStream::DbiConfigStream	(	const std::string &	SoftwName,
		const std::string &	ConfigName = "default",
		VldContext	vc = DbiConfigStream::fgDefaultContext,
		Dbi::Task	task = 0,
		const std::string &	tableName = "SOFTWARE_CONFIGURATION"
	)

DbiConfigStream::~DbiConfigStream

(

)

[virtual]

Definition at line 146 of file DbiConfigStream.cxx.

References Msg::kDebug, LEA_DTOR, and MSG.

                                  {
//
//
//  Purpose: Destructor
//
//  Arguments: 
//    None.
//
//  Return:    n/a
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o  Destroy ConfigStream.


//  Program Notes:-
//  =============

//  None.

  LEA_DTOR    //Leak Checker

  MSG("Dbi", Msg::kDebug) << "Destroying DbiConfigStream" << endl;

}

DbiConfigStream::DbiConfigStream

(

const DbiConfigStream &

)

[private]

---

Member Function Documentation

const DbiConfigSet* DbiConfigStream::GetConfigSet

(

)

const [inline]

Definition at line 57 of file DbiConfigStream.h.

References fCFSet.

Referenced by AlgFactory::GetAlgHandle(), and operator<<().

{ return fCFSet; }

DbiValidityRec& DbiConfigStream::GetValidityRec

(

)

[inline]

Definition at line 63 of file DbiConfigStream.h.

References fVRec.

{ return fVRec; }

Bool_t DbiConfigStream::IsEmpty

(

)

[inline]

Definition at line 62 of file DbiConfigStream.h.

References fCFSet.

{ return fCFSet == 0; }

DbiConfigStream & DbiConfigStream::operator<<

(

const Registry *

reg

)

Definition at line 268 of file DbiConfigStream.cxx.

References DbiConfigSet::Clear(), fCFSet, fCFSetModified, fConfigName, fSoftwName, fVRec, DbiValidityRec::GetAggregateNo(), Msg::kError, Dbi::kString, MAXMSG, Registry::PrintStream(), DbiConfigSet::PushBack(), reg, and DbiConfigSet::SetAggregateNo().

                                                                {
//
//
//  Purpose:  Stream configuration data from Registry object.
//
//  Arguments: 
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o Refill internal fCFSetModified from reg..

//  Program Notes:-
//  =============

//  This does NOT write to the database.  To do that first use this
//  method to refill the configuration and then call the Write method.

  if ( fSoftwName == "" ) {
    MAXMSG("Dbi",Msg::kError,20) << "Cannot fill (<<): No software name defined." << endl;
    return *this;
  }

  DbiFieldType stringType(Dbi::kString);

  ostringstream os;
  reg->PrintStream(os);
  fCFSetModified.Clear();
  fCFSetModified.PushBack("SOFTW_NAME", fSoftwName,  stringType);
  fCFSetModified.PushBack("CONFIG_NAME",fConfigName, stringType);
  fCFSetModified.PushBack("CONFIG_DATA",os.str(),    stringType);
  if ( fVRec.GetAggregateNo() > 0 ) fCFSetModified.SetAggregateNo( fVRec.GetAggregateNo());
  fCFSet =  &fCFSetModified; 
  return *this;

}

const DbiConfigStream & DbiConfigStream::operator>>

(

Registry *

reg

)

Definition at line 211 of file DbiConfigStream.cxx.

References Registry::Clear(), fCFSet, DbiConfigSet::GetNumParams(), DbiConfigSet::GetParamName(), DbiConfigSet::GetParamValue(), Msg::kError, Registry::KeysLocked(), Registry::LockKeys(), Registry::LockValues(), MAXMSG, Registry::ReadStream(), reg, Registry::UnLockKeys(), Registry::UnLockValues(), and Registry::ValuesLocked().

                                                                {
//
//
//  Purpose:  Stream configuration data into Registry object.
//
//  Arguments: 
//    reg          in    Empty Registry object (contents ignored)
//                 out   Filled Registry object.
//
//  Return:    Original DbiConfigStream object.
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o Erase the contents of reg and refill from the DbiConfigSet
//    owned by this DbiConfigStream.

//  Program Notes:-
//  =============

//  None.

  if ( ! reg ) return *this;
   
//  Record the current state of reg and then clear it.

  Bool_t keysLocked   = reg->KeysLocked();
  Bool_t valuesLocked = reg->ValuesLocked();
  reg->UnLockKeys();
  reg->UnLockValues();
  reg->Clear();

//  Use the owned DbiConfigSet to fill reg.

  if ( fCFSet ) {
    UInt_t numParams = fCFSet->GetNumParams();

//  Handle configuration tables.

    if ( numParams == 3 && fCFSet->GetParamName(2) == "CONFIG_DATA" ) {
      istringstream is(fCFSet->GetParamValue(2));
      reg->ReadStream(is);
    }
    else {
      MAXMSG("Dbi",Msg::kError,20) << "Attempting to fill Registry  from a table with "
                             << numParams << " columns (should be 3) using column named "
                             << fCFSet->GetParamName(2) << " (should be CONFIG_DATA)." << endl;
    }
  }
  if ( keysLocked   ) reg->LockKeys();
  if ( valuesLocked ) reg->LockValues();
  return *this;
}

Bool_t DbiConfigStream::Write	(	UInt_t	dbNo = 0,
		const std::string &	logComment = "",
		Bool_t	localTest = false
	)

Definition at line 310 of file DbiConfigStream.cxx.

References DbiCascader::AllocateSeqNo(), DbiWriter< T >::Close(), fCFSet, fCFSetModified, fConfigName, fSoftwName, fVRec, DbiValidityRec::GetAggregateNo(), DbiTableProxyRegistry::GetCascader(), DbiTableProxy::GetTableName(), DbiValidityRec::GetTableProxy(), DbiTableProxyRegistry::Instance(), Msg::kDebug, Msg::kError, Dbi::kMAXLOCALSEQNO, MAXMSG, MSG, DbiConfigSet::SetAggregateNo(), DbiValidityRec::SetAggregateNo(), DbiWriter< T >::SetOverlayCreationDate(), and DbiWriter< T >::SetRequireGlobalSeqno().

                                                 {
//
//
//  Purpose:  Write configuration data to the database.
//
//  Arguments: 
//    dbNo         in    Database number in cascade (starting at 0).
//                         Default: 0.
//    logComment   in    Reason for update.
//                         Default: "".
//    localTest    in    Set true to use local SEQNOs (doesn't require authorising DB).
//                         Default: false.
//
//  Return:        True if I/O successful.

  if ( ! fCFSet ) {
    MAXMSG("Dbi",Msg::kError,20) << "No configuration data to write out." << endl;
    return false;
  }

  // If no aggregate number has been asigned so far, but fCFSet non-zero, then must
  // be creating a new software/config combination with the data in fCFSetModified.
  // Use a global seqno number (or local if localTest) to define a unique aggregate number.
  int requireGlobal = localTest ? -1 : 1;
  if ( fVRec.GetAggregateNo() < 0 ) {
    DbiCascader& cas = DbiTableProxyRegistry::Instance().GetCascader();
    Int_t aggNo = cas.AllocateSeqNo(fVRec.GetTableProxy()->GetTableName(),requireGlobal,dbNo);
    if ( aggNo <= Dbi::kMAXLOCALSEQNO && ! localTest ) {
      MAXMSG("Dbi",Msg::kError,20) << "Cannot write out configuration data: no authorising entry in cascade." << endl;
      return false;
    }
    fVRec.SetAggregateNo(aggNo);
    fCFSetModified.SetAggregateNo(aggNo);
    MSG("Dbi",Msg::kDebug) << "Aggregate number: " << aggNo 
                      << " allocated to entry " << fSoftwName
                      << "," << fConfigName
                      << " in table " << fVRec.GetTableProxy()->GetTableName() << endl;
  }
  DbiWriter<DbiConfigSet> writer(fVRec,dbNo,logComment);
  writer.SetRequireGlobalSeqno(requireGlobal);
  writer.SetOverlayCreationDate();
  writer << *fCFSet;
  return writer.Close();

}

---

Member Data Documentation

const DbiConfigSet* DbiConfigStream::fCFSet [private]

Pointer to the associated configuration set. May point either to a row of fCFSetTable (or 0) or, after operator <<, to fCFSetModified

Definition at line 77 of file DbiConfigStream.h.

Referenced by GetConfigSet(), IsEmpty(), operator<<(), operator>>(), and Write().

DbiConfigSet DbiConfigStream::fCFSetModified [private]

Local DbiConfigSet (empty until/unless filled using operator <<).

Definition at line 84 of file DbiConfigStream.h.

Referenced by operator<<(), and Write().

DbiResultPtr<DbiConfigSet> DbiConfigStream::fCFSetTable [private]

Pointer to ConfigSet table.

Definition at line 81 of file DbiConfigStream.h.

std::string DbiConfigStream::fConfigName [private]

Name of the configuration set.

Definition at line 90 of file DbiConfigStream.h.

Referenced by operator<<(), and Write().

VldContext DbiConfigStream::fgDefaultContext [static]

Definition at line 44 of file DbiConfigStream.h.

std::string DbiConfigStream::fSoftwName [private]

Name of the software system to be configured.

Definition at line 93 of file DbiConfigStream.h.

Referenced by operator<<(), and Write().

DbiValidityRec DbiConfigStream::fVRec [private]

Associated validity rec (used when writing back to the database).

Definition at line 87 of file DbiConfigStream.h.

Referenced by GetValidityRec(), operator<<(), and Write().

---

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

• DbiConfigStream.h
• DbiConfigStream.cxx

---