documentation

[u/mrichter/AliRoot.git] / HLT / BASE / util / AliHLTRootFilePublisherComponent.h

// -*- Mode: C++ -*-
// @(#) $Id$

#ifndef ALIHLTROOTFILEPUBLISHERCOMPONENT_H
#define ALIHLTROOTFILEPUBLISHERCOMPONENT_H
/* This file is property of and copyright by the ALICE HLT Project        * 
 * ALICE Experiment at CERN, All rights reserved.                         *
 * See cxx source for full Copyright notice                               */

/** @file   AliHLTRootFilePublisherComponent.h
    @author Matthias Richter
    @date   
    @brief  component for publishing of Root objects from a root file.
    @note   The class is used in Offline (AliRoot) context
*/

#include "AliHLTFilePublisher.h"
#include <TList.h>

/**
 * @class AliHLTRootFilePublisherComponent
 * \Note: This component is not what it pretends to be. So far it was just
 * used for debugging purpose. If you need a component like this make a
 * feature request at                                                  <br>
 * https://savannah.cern.ch/projects/alicehlt/
 * and assign it to richterm.                                          <br>
 * Any contributions are of course welcome.
 *
 * Component ID: \b RootFilePublisherComponent <br>
 * Library: \b libHLTBase (in order to use the component from the external
 * interface, it might be necessary to specify a dummy library with the
 * \em -componentlibrary argument).
 *
 * Mandatory arguments: <br>
 *
 * Optional arguments:<br>
 *
 * @see AliHLTFilePublisher for default arguments
 * @ingroup alihlt_component
 */
class AliHLTRootFilePublisherComponent : public AliHLTFilePublisher  {
 public:
  /** standard constructor */
  AliHLTRootFilePublisherComponent();
  /** destructor */
  virtual ~AliHLTRootFilePublisherComponent();

  const char* GetComponentID();
  AliHLTComponentDataType GetOutputDataType();
  void GetOutputDataSize( unsigned long& constBase, double& inputMultiplier );
  AliHLTComponent* Spawn();

  /**
   * Open all files.
   * Opens all files for all events from the event list @ref fEvents and adds TFile
   * opjects to the internal list.
   */
  int OpenFiles();

 protected:
  /**
   * Data processing method for the component.
   * The component uses the @ref alihltcomponent-high-level-interface
   * to put serialized Root object into the output stream. Despite of that it
   * implements the lox-level DumpEvent method in order to allow child classes
   * to use the low-level method.
   * @param evtData       event data structure
   * @param trigData	  trigger data structure
   * @return
   */
  int GetEvent( const AliHLTComponentEventData& evtData,
		AliHLTComponentTriggerData& trigData);

  /**
   * Scan one argument and adjacent parameters.
   * Can be overloaded by child classes in order to add additional arguments
   * beyond the standard arguments of the file publisher. The method is called
   * whenever a non-standard argument is recognized.
   * @param argc           size of the argument array
   * @param argv           agument array for component initialization
   * @return number of processed members of the argv <br>
   *         -EINVAL unknown argument <br>
   *         -EPROTO parameter for argument missing <br>
   */
  virtual int ScanArgument(int argc, const char** argv);

 private:
  /** copy constructor prohibited */
  AliHLTRootFilePublisherComponent(const AliHLTRootFilePublisherComponent&);
  /** assignment operator prohibited */
  AliHLTRootFilePublisherComponent& operator=(const AliHLTRootFilePublisherComponent&);

  ClassDef(AliHLTRootFilePublisherComponent, 0)
};
#endif