| # Gaudi Framework, version v22r0 |

Home |  | Generated: 9 Feb 2011

# OutputStream Class Reference

A small to stream Data I/O. More...

`#include <OutputStream.h>`

Inheritance diagram for OutputStream:
[legend]
Collaboration diagram for OutputStream:
[legend]

List of all members.

## Public Types
typedef std::vector < DataStoreItem * > | Items
typedef std::vector< std::string > | ItemNames
## Public Member Functions
| OutputStream (const std::string &name, ISvcLocator *pSvcLocator)
| Standard algorithm Constructor.
virtual | ~OutputStream ()
| Standard Destructor.
virtual StatusCode | initialize ()
| Initialize OutputStream.
virtual StatusCode | finalize ()
| Terminate OutputStream.
virtual StatusCode | execute ()
| Working entry point.
virtual StatusCode | connectConversionSvc ()
virtual bool | collect (IRegistry *dir, int level)
| Store agent's classback.
virtual StatusCode | collectObjects ()
| Collect all objects to be written to the output stream.
void | clearItems (Items &itms)
| Clear item list.
void | addItem (Items &itms, const std::string &descriptor)
| Add item to output streamer list.
void | clearSelection ()
| Clear list of selected objects.
IDataSelector * | selectedObjects ()
| Return the list of selected objects.
## Protected Member Functions
StatusCode | decodeAcceptAlgs ()
| Decode list of Algorithms that this stream accepts.
void | acceptAlgsHandler (Property &theProp)
| Handler for AcceptAlgs Property.
StatusCode | decodeRequireAlgs ()
| Decode list of Algorithms that this stream requires.
void | requireAlgsHandler (Property &theProp)
| Handler for RequireAlgs Property.
StatusCode | decodeVetoAlgs ()
| Decode list of Algorithms that this stream is vetoed by.
void | vetoAlgsHandler (Property &theProp)
| Handler for VetoAlgs Property.
StatusCode | decodeAlgorithms (StringArrayProperty &theNames, std::vector< Algorithm * > *theAlgs)
| Decode specified list of Algorithms.
bool | isEventAccepted () const
| Test whether this event should be output.
DataStoreItem * | findItem (const std::string &path)
| Find single item identified by its path (exact match).
virtual StatusCode | writeObjects ()
| Select the different objects and write them to file.
virtual bool | hasInput () const
| Tell if the instance has been configured with input items or not.
## Protected Attributes
SmartIF< IIncidentSvc > | m_incidentSvc
| Reference to the indicent service.
bool | m_doPreLoad
| Flag indicating wether data pre-loading should be performed.
bool | m_doPreLoadOpt
| Flag indicating whether optional items should be preloaded.
bool | m_verifyItems
| Flag to indicate that item consistency should be checked.
std::string | m_storeName
| Name of the service managing the data store.
std::string | m_persName
| Name of the persistency service capable to write data from the store.
std::string | m_output
| Name of the output file specification.
std::string | m_outputName
| Name of the output file.
std::string | m_outputType
| Output type: NEW(NEW,CREATE,WRITE,RECREATE), UPDATE).
OutputStreamAgent * | m_agent
| Keep reference of agent.
SmartIF< IDataProviderSvc > | m_pDataProvider
| Keep reference to the data provider service.
SmartIF< IDataManagerSvc > | m_pDataManager
| Keep reference to the data manager service.
SmartIF< IConversionSvc > | m_pConversionSvc
| Keep reference to the data conversion service.
DataStoreItem * | m_currentItem
| Keep track of the current item.
ItemNames | m_itemNames
| Vector of item names.
Items | m_itemList
| Vector of items to be saved to this stream.
ItemNames | m_optItemNames
| Vector of item names.
Items | m_optItemList
| Vector of optional items to be saved to this stream.
IDataSelector | m_objects
| Collection of objects being selected.
int | m_events
| Number of events written to this output stream.
StringArrayProperty | m_acceptNames
| Vector of names of Algorithms that this stream accepts.
StringArrayProperty | m_requireNames
| Vector of names of Algorithms that this stream requires.
StringArrayProperty | m_vetoNames
| Vector of names of Algorithms that this stream is vetoed by.
std::vector< Algorithm * > * | m_acceptAlgs
| Vector of Algorithms that this stream accepts.
std::vector< Algorithm * > * | m_requireAlgs
| Vector of Algorithms that this stream requires.
std::vector< Algorithm * > * | m_vetoAlgs
| Vector of Algorithms that this stream is vetoed by.
bool | m_fireIncidents
| should I fire incidents for writing opening/closing etc?
## Friends
class | AlgFactory< OutputStream >
class | Factory< OutputStream, IAlgorithm *(std::string, ISvcLocator *)>

## Detailed Description

A small to stream Data I/O.

Author: M.Frank author R. Lambert Version: 1.0

Definition at line 32 of file OutputStream.h.

## Member Typedef Documentation

typedef std::vector<std::string> OutputStream::ItemNames

Definition at line 38 of file OutputStream.h.

typedef std::vector<DataStoreItem*> OutputStream::Items

Definition at line 37 of file OutputStream.h.

## Constructor & Destructor Documentation

OutputStream::OutputStream | ( | const std::string & | name,
|  | ISvcLocator * | pSvcLocator |
| ) |  |  |

Standard algorithm Constructor.

in the baseclass, always fire the incidents by default in e.g. RecordStream this will be set to false, and configurable

in the baseclass, always fire the incidents by default in RecordStream this will be set to false, and configurable

Definition at line 31 of file OutputStream.cpp.

    00032  : Algorithm(name, pSvcLocator)
    00033 {
    00034   m_doPreLoad      = true;
    00035   m_doPreLoadOpt   = false;
    00036   m_verifyItems    = true;
    00037   m_output         = "";
    00038   m_outputName     = "";
    00039   m_outputType     = "UPDATE";
    00040   m_storeName      = "EventDataSvc";
    00041   m_persName       = "EventPersistencySvc";
    00042   m_agent          = new OutputStreamAgent(this);
    00043   m_acceptAlgs     = new std::vector<Algorithm*>();
    00044   m_requireAlgs    = new std::vector<Algorithm*>();
    00045   m_vetoAlgs       = new std::vector<Algorithm*>();
    00048   m_fireIncidents  = true;
    00049   declareProperty("ItemList",         m_itemNames);
    00050   declareProperty("OptItemList",      m_optItemNames);
    00051   declareProperty("Preload",          m_doPreLoad);
    00052   declareProperty("PreloadOptItems",  m_doPreLoadOpt);
    00053   declareProperty("Output",           m_output);
    00054   declareProperty("OutputFile",       m_outputName);
    00055   declareProperty("EvtDataSvc",       m_storeName);
    00056   declareProperty("EvtConversionSvc", m_persName);
    00057   declareProperty("AcceptAlgs",       m_acceptNames);
    00058   declareProperty("RequireAlgs",      m_requireNames);
    00059   declareProperty("VetoAlgs",         m_vetoNames);
    00060   declareProperty("VerifyItems",      m_verifyItems);
    00063
    00064   // Associate action handlers with the AcceptAlgs, RequireAlgs & VetoAlgs properties
    00065   m_acceptNames.declareUpdateHandler ( &OutputStream::acceptAlgsHandler , this );
    00066   m_requireNames.declareUpdateHandler( &OutputStream::requireAlgsHandler, this );
    00067   m_vetoNames.declareUpdateHandler   ( &OutputStream::vetoAlgsHandler   , this );
    00068 }

OutputStream::~OutputStream | ( |  | ) | `[virtual]`

Standard Destructor.

Definition at line 71 of file OutputStream.cpp.

    00071                               {
    00072   delete m_agent;
    00073   delete m_acceptAlgs;
    00074   delete m_requireAlgs;
    00075   delete m_vetoAlgs;
    00076 }

## Member Function Documentation

void OutputStream::acceptAlgsHandler | ( | Property & | theProp | ) | `[protected]`

Handler for AcceptAlgs Property.

Definition at line 452 of file OutputStream.cpp.

    00452                                                                {
    00453   StatusCode sc = decodeAlgorithms( m_acceptNames, m_acceptAlgs );
    00454   if (sc.isFailure()) {
    00455     throw GaudiException("Failure in OutputStream::decodeAlgorithms",
    00456                          "OutputStream::acceptAlgsHandler",sc);
    00457   }
    00458 }

void OutputStream::addItem | ( | Items & | itms,
|  | const std::string & | descriptor |
| ) |  |  |

Add item to output streamer list.

Definition at line 332 of file OutputStream.cpp.

    00332                                                                      {
    00333         MsgStream log(msgSvc(), name());
    00334   int level = 0;
    00335   size_t sep = descriptor.rfind("#");
    00336   std::string obj_path (descriptor,0,sep);
    00337   std::string slevel   (descriptor,sep+1,descriptor.length());
    00338   if ( slevel == "*" )  {
    00339     level = 9999999;
    00340   }
    00341   else   {
    00342     level = atoi(slevel.c_str());
    00343   }
    00344   if ( m_verifyItems )  {
    00345     size_t idx = obj_path.find("/",1);
    00346     while(idx != std::string::npos)  {
    00347       std::string sub_item = obj_path.substr(0,idx);
    00348       if ( 0 == findItem(sub_item) )   {
    00349         addItem(itms, sub_item+"#1");
    00350       }
    00351       idx = obj_path.find("/",idx+1);
    00352     }
    00353   }
    00354   DataStoreItem* item = new DataStoreItem(obj_path, level);
    00355   log << MSG::DEBUG << "Adding OutputStream item " << item->path()
    00356       << " with " << item->depth()
    00357       << " level(s)." << endmsg;
    00358   itms.push_back( item );
    00359 }

void OutputStream::clearItems | ( | Items & | itms | ) |

Clear item list.

Definition at line 312 of file OutputStream.cpp.

    00312                                              {
    00313   for ( Items::iterator i = itms.begin(); i != itms.end(); i++ )    {
    00314     delete (*i);
    00315   }
    00316   itms.erase(itms.begin(), itms.end());
    00317 }

void OutputStream::clearSelection | ( |  | ) |

Clear list of selected objects.

Definition at line 307 of file OutputStream.cpp.

    00307                                       {
    00308   m_objects.erase(m_objects.begin(), m_objects.end());
    00309 }

bool OutputStream::collect | ( | IRegistry * | dir,
|  | int | level |
| ) |  |  | `[virtual]`

Store agent's classback.

Definition at line 235 of file OutputStream.cpp.

    00235                                                        {
    00236   if ( level < m_currentItem->depth() )   {
    00237     if ( dir->object() != 0 )   {
    00238       /*
    00239       std::cout << "Analysing ("
    00240                 << dir->name()
    00241                 << ") Object:"
    00242                 << ((dir->object()==0) ? "UNLOADED" : "LOADED")
    00243                 << std::endl;
    00244       */
    00245       m_objects.push_back(dir->object());
    00246       return true;
    00247     }
    00248   }
    00249   return false;
    00250 }

StatusCode OutputStream::collectObjects | ( |  | ) | `[virtual]`

Collect all objects to be written to the output stream.

Reimplemented in InputCopyStream.

Definition at line 253 of file OutputStream.cpp.

    00253                                           {
    00254   MsgStream log(msgSvc(), name());
    00255   StatusCode status = StatusCode::SUCCESS;
    00256   Items::iterator i;
    00257   // Traverse the tree and collect the requested objects
    00258   for ( i = m_itemList.begin(); i != m_itemList.end(); i++ )    {
    00259     DataObject* obj = 0;
    00260     m_currentItem = (*i);
    00261     StatusCode iret = m_pDataProvider->retrieveObject(m_currentItem->path(), obj);
    00262     if ( iret.isSuccess() )  {
    00263       iret = m_pDataManager->traverseSubTree(obj, m_agent);
    00264       if ( !iret.isSuccess() )  {
    00265         status = iret;
    00266       }
    00267     }
    00268     else  {
    00269       log << MSG::ERROR << "Cannot write mandatory object(s) (Not found) "
    00270           << m_currentItem->path() << endmsg;
    00271       status = iret;
    00272     }
    00273   }
    00274   // Traverse the tree and collect the requested objects (tolerate missing items here)
    00275   for ( i = m_optItemList.begin(); i != m_optItemList.end(); i++ )    {
    00276     DataObject* obj = 0;
    00277     m_currentItem = (*i);
    00278     StatusCode iret = m_pDataProvider->retrieveObject(m_currentItem->path(), obj);
    00279     if ( iret.isSuccess() )  {
    00280       iret = m_pDataManager->traverseSubTree(obj, m_agent);
    00281     }
    00282     if ( !iret.isSuccess() )    {
    00283       log << MSG::DEBUG << "Ignore request to write non-mandatory object(s) "
    00284           << m_currentItem->path() << endmsg;
    00285     }
    00286   }
    00287
    00288   if (status.isSuccess()){
    00289     // Remove duplicates from the list of objects, preserving the order in the list
    00290     std::set<DataObject*> unique;
    00291     std::vector<DataObject*> tmp; // temporary vector with the reduced list
    00292     tmp.reserve(m_objects.size());
    00293     for (std::vector<DataObject*>::iterator o = m_objects.begin(); o != m_objects.end(); ++o) {
    00294       if (!unique.count(*o)) {
    00295         // if the pointer is not in the set, add it to both the set and the temporary vector
    00296         unique.insert(*o);
    00297         tmp.push_back(*o);
    00298       }
    00299     }
    00300     m_objects.swap(tmp); // swap the data of the two vectors
    00301   }
    00302
    00303   return status;
    00304 }

StatusCode OutputStream::connectConversionSvc | ( |  | ) | `[virtual]`

Definition at line 362 of file OutputStream.cpp.

    00362                                                 {
    00363   StatusCode status = StatusCode(StatusCode::FAILURE, true);
    00364   MsgStream log(msgSvc(), name());
    00365   // Get output file from input
    00366   std::string dbType, svc, shr;
    00367   Tokenizer tok(true);
    00368   tok.analyse(m_output, " ", "", "", "=", "'", "'");
    00369   for(Tokenizer::Items::iterator i = tok.items().begin(); i != tok.items().end(); ++i)   {
    00370     const std::string& tag = (*i).tag();
    00371     const std::string& val = (*i).value();
    00372     switch( ::toupper(tag[0]) )    {
    00373     case 'D':
    00374       m_outputName = val;
    00375       break;
    00376     case 'T':
    00377       dbType = val;
    00378       break;
    00379     case 'S':
    00380       switch( ::toupper(tag[1]) )   {
    00381       case 'V':    svc = val;      break;
    00382       case 'H':    shr = "YES";    break;
    00383       }
    00384       break;
    00385     case 'O':   // OPT='<NEW<CREATE,WRITE,RECREATE>, UPDATE>'
    00386       switch( ::toupper(val[0]) )   {
    00387       case 'R':
    00388         if ( ::strncasecmp(val.c_str(),"RECREATE",3)==0 )
    00389           m_outputType = "RECREATE";
    00390         else if ( ::strncasecmp(val.c_str(),"READ",3)==0 )
    00391           m_outputType = "READ";
    00392         break;
    00393       case 'C':
    00394       case 'N':
    00395       case 'W':
    00396         m_outputType = "NEW";
    00397         break;
    00398       case 'U':
    00399         m_outputType = "UPDATE";
    00400         break;
    00401       default:
    00402         m_outputType = "???";
    00403         break;
    00404       }
    00405       break;
    00406     default:
    00407       break;
    00408     }
    00409   }
    00410   if ( !shr.empty() ) m_outputType += "|SHARED";
    00411   // Get access to the default Persistency service
    00412   // The default service is the same for input as for output.
    00413   // If this is not desired, then a specialized OutputStream must overwrite
    00414   // this value.
    00415   if ( dbType.length() > 0 && svc.length()==0 )   {
    00416     SmartIF<IPersistencySvc> ipers(serviceLocator()->service(m_persName));
    00417     if( !ipers.isValid() )   {
    00418       log << MSG::FATAL << "Unable to locate IPersistencySvc interface of " << m_persName << endmsg;
    00419       return StatusCode::FAILURE;
    00420     }
    00421     IConversionSvc *cnvSvc = 0;
    00422     status = ipers->getService(dbType, cnvSvc);
    00423     if( !status.isSuccess() )   {
    00424       log << MSG::FATAL << "Unable to locate IConversionSvc interface of database type " << dbType << endmsg;
    00425       return status;
    00426     }
    00427     // Increase reference count and keep service.
    00428     m_pConversionSvc = cnvSvc;
    00429   }
    00430   else if ( svc.length() > 0 )    {
    00431     // On success reference count is automatically increased.
    00432     m_pConversionSvc = serviceLocator()->service(svc);
    00433     if( !m_pConversionSvc.isValid() )   {
    00434       log << MSG::FATAL << "Unable to locate IConversionSvc interface of " << svc << endmsg;
    00435       return StatusCode::FAILURE;
    00436     }
    00437   }
    00438   else    {
    00439     log << MSG::FATAL
    00440         << "Unable to locate IConversionSvc interface (Unknown technology) " << endmsg
    00441         << "You either have to specify a technology name or a service name!" << endmsg
    00442         << "Please correct the job option \"" << name() << ".Output\" !"     << endmsg;
    00443     return StatusCode::FAILURE;
    00444   }
    00445   return StatusCode::SUCCESS;
    00446 }

StatusCode OutputStream::decodeAcceptAlgs | ( |  | ) | `[protected]`

Decode list of Algorithms that this stream accepts.

Definition at line 448 of file OutputStream.cpp.

    00448                                            {
    00449   return decodeAlgorithms( m_acceptNames, m_acceptAlgs );
    00450 }

StatusCode OutputStream::decodeAlgorithms | ( | StringArrayProperty & | theNames,
|  | std::vector< Algorithm * > * | theAlgs |
| ) |  |  | `[protected]`

Decode specified list of Algorithms.

Definition at line 484 of file OutputStream.cpp.

    00486 {
    00487   // Reset the list of Algorithms
    00488   theAlgs->clear( );
    00489
    00490   MsgStream log( msgSvc( ), name( ) );
    00491
    00492   StatusCode result = StatusCode::FAILURE;
    00493
    00494   SmartIF<IAlgManager> theAlgMgr(serviceLocator());
    00495   if ( theAlgMgr.isValid() ) {
    00496     // Build the list of Algorithms from the names list
    00497     const std::vector<std::string> nameList = theNames.value( );
    00498     std::vector<std::string>::const_iterator it;
    00499     std::vector<std::string>::const_iterator itend = nameList.end( );
    00500     for (it = nameList.begin(); it != itend; ++it) {
    00501       // Check whether the supplied name corresponds to an existing
    00502       // Algorithm object.
    00503       const std::string &theName = (*it);
    00504       SmartIF<IAlgorithm> &theIAlg = theAlgMgr->algorithm(theName);
    00505       Algorithm*  theAlgorithm;
    00506       if ( theIAlg.isValid() ) {
    00507         result = StatusCode::SUCCESS;
    00508         try{
    00509           theAlgorithm = dynamic_cast<Algorithm*>(theIAlg.get());
    00510         } catch(...){
    00511           result = StatusCode::FAILURE;
    00512         }
    00513       }
    00514       if ( result.isSuccess( ) ) {
    00515         // Check that the specified algorithm doesn't already exist in the list
    00516         std::vector<Algorithm*>::iterator ita;
    00517         std::vector<Algorithm*>::iterator itaend = theAlgs->end( );
    00518         for (ita = theAlgs->begin(); ita != itaend; ++ita) {
    00519           Algorithm* existAlgorithm = (*ita);
    00520           if ( theAlgorithm == existAlgorithm ) {
    00521             result = StatusCode::FAILURE;
    00522             break;
    00523           }
    00524         }
    00525         if ( result.isSuccess( ) ) {
    00526           theAlgorithm->addRef();
    00527           theAlgs->push_back( theAlgorithm );
    00528         }
    00529       }
    00530       else {
    00531         log << MSG::INFO << theName << " doesn't exist - ignored" << endmsg;
    00532       }
    00533     }
    00534     result = StatusCode::SUCCESS;
    00535   }
    00536   else {
    00537     log << MSG::FATAL << "Can't locate ApplicationMgr!!!" << endmsg;
    00538   }
    00539   return result;
    00540 }

StatusCode OutputStream::decodeRequireAlgs | ( |  | ) | `[protected]`

Decode list of Algorithms that this stream requires.

Definition at line 460 of file OutputStream.cpp.

    00460                                              {
    00461   return decodeAlgorithms( m_requireNames, m_requireAlgs );
    00462 }

StatusCode OutputStream::decodeVetoAlgs | ( |  | ) | `[protected]`

Decode list of Algorithms that this stream is vetoed by.

Definition at line 472 of file OutputStream.cpp.

    00472                                           {
    00473   return decodeAlgorithms( m_vetoNames, m_vetoAlgs );
    00474 }

StatusCode OutputStream::execute | ( |  | ) | `[virtual]`

Working entry point.

Reimplemented in RecordStream, RunRecordStream, and SequentialOutputStream.

Definition at line 174 of file OutputStream.cpp.

    00174                                  {
    00175   // Clear any previously existing item list
    00176   clearSelection();
    00177   // Test whether this event should be output
    00178   if ( isEventAccepted() )  {
    00179     StatusCode sc = writeObjects();
    00180     clearSelection();
    00181     m_events++;
    00182     if(sc.isSuccess() && m_fireIncidents)
    00183       m_incidentSvc->fireIncident(Incident(m_outputName,
    00184                                            IncidentType::WroteToOutputFile));
    00185     else if(m_fireIncidents)
    00186       m_incidentSvc->fireIncident(Incident(m_outputName,
    00187                                            IncidentType::FailOutputFile));
    00188     return sc;
    00189   }
    00190   return StatusCode::SUCCESS;
    00191 }

StatusCode OutputStream::finalize | ( |  | ) | `[virtual]`

Terminate OutputStream.

Reimplemented from Algorithm.

Reimplemented in InputCopyStream, RecordStream, RunRecordStream, and TagCollectionStream.

Definition at line 159 of file OutputStream.cpp.

    00159                                   {
    00160   MsgStream log(msgSvc(), name());
    00161   log << MSG::INFO << "Events output: " << m_events << endmsg;
    00162   if(m_fireIncidents) m_incidentSvc->fireIncident(Incident(m_outputName,
    00163                                        IncidentType::EndOutputFile));
    00164   m_incidentSvc.reset();
    00165   m_pDataProvider.reset();
    00166   m_pDataManager.reset();
    00167   m_pConversionSvc.reset();
    00168   clearItems(m_optItemList);
    00169   clearItems(m_itemList);
    00170   return StatusCode::SUCCESS;
    00171 }

DataStoreItem * OutputStream::findItem | ( | const std::string & | path | ) | `[protected]`

Find single item identified by its path (exact match).

Definition at line 321 of file OutputStream.cpp.

    00321                                              {
    00322   for(Items::const_iterator i=m_itemList.begin(); i != m_itemList.end(); ++i)  {
    00323     if ( (*i)->path() == path )  return (*i);
    00324   }
    00325   for(Items::const_iterator j=m_optItemList.begin(); j != m_optItemList.end(); ++j)  {
    00326     if ( (*j)->path() == path )  return (*j);
    00327   }
    00328   return 0;
    00329 }

bool OutputStream::hasInput | ( |  | ) | const`[protected, virtual]`

Tell if the instance has been configured with input items or not.

Reimplemented in InputCopyStream.

Definition at line 588 of file OutputStream.cpp.

    00588                                   {
    00589   return !(m_itemNames.empty() && m_optItemNames.empty());
    00590 }

StatusCode OutputStream::initialize | ( |  | ) | `[virtual]`

Initialize OutputStream.

Reimplemented from Algorithm.

Reimplemented in InputCopyStream, and TagCollectionStream.

Definition at line 79 of file OutputStream.cpp.

    00079                                     {
    00080   MsgStream log(msgSvc(), name());
    00081
    00082   // Reset the number of events written
    00083   m_events = 0;
    00084   // Get access to the DataManagerSvc
    00085   m_pDataManager = serviceLocator()->service(m_storeName);
    00086   if( !m_pDataManager.isValid() )   {
    00087     log << MSG::FATAL << "Unable to locate IDataManagerSvc interface" << endmsg;
    00088     return StatusCode::FAILURE;
    00089   }
    00090   // Get access to the IncidentService
    00091   m_incidentSvc = serviceLocator()->service("IncidentSvc");
    00092   if( !m_incidentSvc.isValid() )  {
    00093     log << MSG::WARNING << "Error retrieving IncidentSvc." << endmsg;
    00094     return StatusCode::FAILURE;
    00095   }
    00096   // Get access to the assigned data service
    00097   m_pDataProvider = serviceLocator()->service(m_storeName);
    00098   if( !m_pDataProvider.isValid() )   {
    00099     log << MSG::FATAL << "Unable to locate IDataProviderSvc interface of " << m_storeName << endmsg;
    00100     return StatusCode::FAILURE;
    00101   }
    00102   if ( hasInput() )  {
    00103     StatusCode status = connectConversionSvc();
    00104     if( !status.isSuccess() )   {
    00105       log << MSG::FATAL << "Unable to connect to conversion service." << endmsg;
    00106       if(m_outputName!="" && m_fireIncidents) m_incidentSvc->fireIncident(Incident(m_outputName,
    00107                                            IncidentType::FailOutputFile));
    00108       return status;
    00109     }
    00110   }
    00111
    00112   // Clear the list with optional items
    00113   clearItems(m_optItemList);
    00114   // Clear the item list
    00115   clearItems(m_itemList);
    00116
    00117   ItemNames::iterator i;
    00118   // Take the new item list from the properties.
    00119   for(i = m_itemNames.begin(); i != m_itemNames.end(); i++)   {
    00120     addItem( m_itemList, *i );
    00121   }
    00122
    00123   // Take the new item list from the properties.
    00124   for(i = m_optItemNames.begin(); i != m_optItemNames.end(); i++)   {
    00125     addItem( m_optItemList, *i );
    00126   }
    00127
    00128   // Take the item list to the data service preload list.
    00129   if ( m_doPreLoad )    {
    00130     for(Items::iterator j = m_itemList.begin(); j != m_itemList.end(); j++)   {
    00131       m_pDataProvider->addPreLoadItem( *(*j) ).ignore();
    00132     }
    00133     // Not working: bad reference counting! pdataSvc->release();
    00134   }
    00135
    00136   if ( m_doPreLoadOpt )    {
    00137     for(Items::iterator j=m_optItemList.begin(); j!=m_optItemList.end(); j++) {
    00138       m_pDataProvider->addPreLoadItem( *(*j) );
    00139     }
    00140   }
    00141   log << MSG::INFO << "Data source: " << m_storeName  << " output: " << m_output << endmsg;
    00142
    00143   // Decode the accept, required and veto Algorithms. The logic is the following:
    00144   //  a. The event is accepted if all lists are empty.
    00145   //  b. The event is provisionally accepted if any Algorithm in the accept list
    00146   //     has been executed and has indicated that its filter is passed. This
    00147   //     provisional acceptance can be overridden by the other lists.
    00148   //  c. The event is rejected unless all Algorithms in the required list have
    00149   //     been executed and have indicated that their filter passed.
    00150   //  d. The event is rejected if any Algorithm in the veto list has been
    00151   //     executed and has indicated that its filter has passed.
    00152   decodeAcceptAlgs ().ignore();
    00153   decodeRequireAlgs().ignore();
    00154   decodeVetoAlgs   ().ignore();
    00155   return StatusCode::SUCCESS;
    00156 }

bool OutputStream::isEventAccepted | ( |  | ) | const`[protected]`

Test whether this event should be output.

Definition at line 542 of file OutputStream.cpp.

    00542                                            {
    00543   typedef std::vector<Algorithm*>::iterator AlgIter;
    00544   bool result = true;
    00545
    00546   // Loop over all Algorithms in the accept list to see
    00547   // whether any have been executed and have their filter
    00548   // passed flag set. Any match causes the event to be
    00549   // provisionally accepted.
    00550   if ( ! m_acceptAlgs->empty() ) {
    00551     result = false;
    00552     for(AlgIter i=m_acceptAlgs->begin(),end=m_acceptAlgs->end(); i != end; ++i) {
    00553       if ( (*i)->isExecuted() && (*i)->filterPassed() ) {
    00554         result = true;
    00555         break;
    00556       }
    00557     }
    00558   }
    00559
    00560   // Loop over all Algorithms in the required list to see
    00561   // whether all have been executed and have their filter
    00562   // passed flag set. Any mismatch causes the event to be
    00563   // rejected.
    00564   if ( result && ! m_requireAlgs->empty() ) {
    00565     for(AlgIter i=m_requireAlgs->begin(),end=m_requireAlgs->end(); i != end; ++i) {
    00566       if ( !(*i)->isExecuted() || !(*i)->filterPassed() ) {
    00567         result = false;
    00568         break;
    00569       }
    00570     }
    00571   }
    00572
    00573   // Loop over all Algorithms in the veto list to see
    00574   // whether any have been executed and have their filter
    00575   // passed flag set. Any match causes the event to be
    00576   // rejected.
    00577   if ( result && ! m_vetoAlgs->empty() ) {
    00578     for(AlgIter i=m_vetoAlgs->begin(),end=m_vetoAlgs->end(); i != end; ++i) {
    00579       if ( (*i)->isExecuted() && (*i)->filterPassed() ) {
    00580         result = false;
    00581         break;
    00582       }
    00583     }
    00584   }
    00585   return result;
    00586 }

void OutputStream::requireAlgsHandler | ( | Property & | theProp | ) | `[protected]`

Handler for RequireAlgs Property.

Definition at line 464 of file OutputStream.cpp.

    00464                                                                 {
    00465   StatusCode sc = decodeAlgorithms( m_requireNames, m_requireAlgs );
    00466   if (sc.isFailure()) {
    00467     throw GaudiException("Failure in OutputStream::decodeAlgorithms",
    00468                          "OutputStream::requireAlgsHandler",sc);
    00469   }
    00470 }

IDataSelector* OutputStream::selectedObjects | ( |  | ) | `[inline]`

Return the list of selected objects.

Definition at line 147 of file OutputStream.h.

    00147                                       {
    00148     return &m_objects;
    00149   }

void OutputStream::vetoAlgsHandler | ( | Property & | theProp | ) | `[protected]`

Handler for VetoAlgs Property.

Definition at line 476 of file OutputStream.cpp.

    00476                                                              {
    00477   StatusCode sc = decodeAlgorithms( m_vetoNames, m_vetoAlgs );
    00478   if (sc.isFailure()) {
    00479     throw GaudiException("Failure in OutputStream::decodeAlgorithms",
    00480                          "OutputStream::vetoAlgsHandler",sc);
    00481   }
    00482 }

StatusCode OutputStream::writeObjects | ( |  | ) | `[protected, virtual]`

Select the different objects and write them to file.

Reimplemented in SequentialOutputStream, and TagCollectionStream.

Definition at line 194 of file OutputStream.cpp.

    00194                                        {
    00195   // Connect the output file to the service
    00196   StatusCode status = collectObjects();
    00197   if ( status.isSuccess() )   {
    00198     IDataSelector*  sel = selectedObjects();
    00199     if ( sel->begin() != sel->end() )  {
    00200       status = m_pConversionSvc->connectOutput(m_outputName, m_outputType);
    00201       if ( status.isSuccess() )   {
    00202         // Now pass the collection to the persistency service
    00203         IDataSelector::iterator j;
    00204         IOpaqueAddress* pAddress = 0;
    00205         for ( j = sel->begin(); j != sel->end(); j++ )    {
    00206           StatusCode iret = m_pConversionSvc->createRep( *j, pAddress );
    00207           if ( !iret.isSuccess() )      {
    00208             status = iret;
    00209             continue;
    00210           }
    00211           IRegistry* pReg = (*j)->registry();
    00212           pReg->setAddress(pAddress);
    00213         }
    00214         for ( j = sel->begin(); j != sel->end(); j++ )    {
    00215           IRegistry* pReg = (*j)->registry();
    00216           StatusCode iret = m_pConversionSvc->fillRepRefs( pReg->address(), *j );
    00217           if ( !iret.isSuccess() )      {
    00218             status = iret;
    00219           }
    00220         }
    00221               // Commit the data if there was no error; otherwise possibly discard
    00222         if ( status.isSuccess() )  {
    00223           status = m_pConversionSvc->commitOutput(m_outputName, true);
    00224         }
    00225         else   {
    00226           m_pConversionSvc->commitOutput(m_outputName, false);
    00227         }
    00228       }
    00229     }
    00230   }
    00231   return status;
    00232 }

## Friends And Related Function Documentation

friend class AlgFactory< OutputStream >`[friend]`

Definition at line 33 of file OutputStream.h.

friend class Factory< OutputStream, IAlgorithm *(std::string, ISvcLocator *)>`[friend]`

Definition at line 34 of file OutputStream.h.

## Member Data Documentation

std::vector<Algorithm*>* OutputStream::m_acceptAlgs`[protected]`

Vector of Algorithms that this stream accepts.

Definition at line 87 of file OutputStream.h.

StringArrayProperty OutputStream::m_acceptNames`[protected]`

Vector of names of Algorithms that this stream accepts.

Definition at line 81 of file OutputStream.h.

OutputStreamAgent* OutputStream::m_agent`[protected]`

Keep reference of agent.

Definition at line 59 of file OutputStream.h.

DataStoreItem* OutputStream::m_currentItem`[protected]`

Keep track of the current item.

Definition at line 67 of file OutputStream.h.

bool OutputStream::m_doPreLoad`[protected]`

Flag indicating wether data pre-loading should be performed.

Definition at line 43 of file OutputStream.h.

bool OutputStream::m_doPreLoadOpt`[protected]`

Flag indicating whether optional items should be preloaded.

Definition at line 45 of file OutputStream.h.

int OutputStream::m_events`[protected]`

Number of events written to this output stream.

Reimplemented in SequentialOutputStream.

Definition at line 79 of file OutputStream.h.

bool OutputStream::m_fireIncidents`[protected]`

should I fire incidents for writing opening/closing etc?

Definition at line 122 of file OutputStream.h.

SmartIF<IIncidentSvc> OutputStream::m_incidentSvc`[protected]`

Reference to the indicent service.

Definition at line 41 of file OutputStream.h.

Items OutputStream::m_itemList`[protected]`

Vector of items to be saved to this stream.

Definition at line 71 of file OutputStream.h.

ItemNames OutputStream::m_itemNames`[protected]`

Vector of item names.

Definition at line 69 of file OutputStream.h.

IDataSelector OutputStream::m_objects`[protected]`

Collection of objects being selected.

Definition at line 77 of file OutputStream.h.

Items OutputStream::m_optItemList`[protected]`

Vector of optional items to be saved to this stream.

Definition at line 75 of file OutputStream.h.

ItemNames OutputStream::m_optItemNames`[protected]`

Vector of item names.

Definition at line 73 of file OutputStream.h.

std::string OutputStream::m_output`[protected]`

Name of the output file specification.

Definition at line 53 of file OutputStream.h.

std::string OutputStream::m_outputName`[protected]`

Name of the output file.

Definition at line 55 of file OutputStream.h.

std::string OutputStream::m_outputType`[protected]`

Output type: NEW(NEW,CREATE,WRITE,RECREATE), UPDATE).

Definition at line 57 of file OutputStream.h.

SmartIF<IConversionSvc> OutputStream::m_pConversionSvc`[protected]`

Keep reference to the data conversion service.

Definition at line 65 of file OutputStream.h.

SmartIF<IDataManagerSvc> OutputStream::m_pDataManager`[protected]`

Keep reference to the data manager service.

Definition at line 63 of file OutputStream.h.

SmartIF<IDataProviderSvc> OutputStream::m_pDataProvider`[protected]`

Keep reference to the data provider service.

Definition at line 61 of file OutputStream.h.

std::string OutputStream::m_persName`[protected]`

Name of the persistency service capable to write data from the store.

Definition at line 51 of file OutputStream.h.

std::vector<Algorithm*>* OutputStream::m_requireAlgs`[protected]`

Vector of Algorithms that this stream requires.

Definition at line 89 of file OutputStream.h.

StringArrayProperty OutputStream::m_requireNames`[protected]`

Vector of names of Algorithms that this stream requires.

Definition at line 83 of file OutputStream.h.

std::string OutputStream::m_storeName`[protected]`

Name of the service managing the data store.

Definition at line 49 of file OutputStream.h.

bool OutputStream::m_verifyItems`[protected]`

Flag to indicate that item consistency should be checked.

Definition at line 47 of file OutputStream.h.

std::vector<Algorithm*>* OutputStream::m_vetoAlgs`[protected]`

Vector of Algorithms that this stream is vetoed by.

Definition at line 91 of file OutputStream.h.

StringArrayProperty OutputStream::m_vetoNames`[protected]`

Vector of names of Algorithms that this stream is vetoed by.

Definition at line 85 of file OutputStream.h.

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

- /afs/cern.ch/sw/Gaudi/releases/GAUDI/GAUDI_v22r0/GaudiSvc/src/PersistencySvc/OutputStream.h
- /afs/cern.ch/sw/Gaudi/releases/GAUDI/GAUDI_v22r0/GaudiSvc/src/PersistencySvc/OutputStream.cpp

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Defines