Fixing in/out tags in documentation

[u/mrichter/AliRoot.git] / HLT / TPCLib / offline / AliHLTTPCDigitPublisherComponent.h

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

#ifndef ALIHLTTPCDIGITPUBLISHERCOMPONENT_H
#define ALIHLTTPCDIGITPUBLISHERCOMPONENT_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   AliHLTTPCDigitPublisherComponent.h
    @author Matthias Richter
    @date   
    @brief  TPC digit publisher component (input from offline).
*/

// see below for class documentation
// or
// refer to README to build package
// or
// visit http://web.ift.uib.no/~kjeks/doc/alice-hlt   

#include "AliHLTOfflineDataSource.h"

class AliHLTTPCFileHandler;

/**
 * @class AliHLTTPCDigitPublisherComponent
 * A digit publisher component for the TPC.
 * 
 * Component ID: \b TPCDigitPublisher <br>
 * Library: \b libAliHLTTPC.
 *
 * Mandatory arguments: <br>
 * <!-- NOTE: ignore the \li. <i> and </i>: it's just doxygen formatting -->
 * \li -slice     <i> no </i> <br>
 *      TPC slice no (slice = inner + outer sector)
 * \li -partition     <i> no </i> <br>
 *      readout partition no
 *
 * Optional arguments:<br>
 *
 *
 * @ingroup alihlt_system
 */
class AliHLTTPCDigitPublisherComponent : public AliHLTOfflineDataSource {
 public:
  /** standard constructor */
  AliHLTTPCDigitPublisherComponent();
  /** destructor */
  virtual ~AliHLTTPCDigitPublisherComponent();

  /**
   * Get the id of the component.
   * Each component is identified by a unique id.
   * The function is pure virtual and must be implemented by the child class.
   * @return component id (string)
   */
  const char* GetComponentID();

  /**
   * Get the output data type of the component.
   * The function is pure virtual and must be implemented by the child class.
   * @return output data type
   */
  AliHLTComponentDataType GetOutputDataType();

  /**
   * Get a ratio by how much the data volume is shrinked or enhanced.
   * The function is pure virtual and must be implemented by the child class.
   * @param constBase        <i>return</i>: additive part, independent of the
   *                                   input data volume  
   * @param inputMultiplier  <i>return</i>: multiplication ratio
   * @return values in the reference variables
   */
  void GetOutputDataSize( unsigned long& constBase, double& inputMultiplier );

  /**
   * Spawn function.
   * Each component must implement a spawn function to create a new instance of 
   * the class. Basically the function must return <i>new <b>my_class_name</b></i>.
   * @return new class instance
   */
  virtual AliHLTComponent* Spawn();

 protected:

  using AliHLTOfflineDataSource::GetEvent;

  /**
   * Init method.
   */
  int DoInit( int argc, const char** argv );

  /**
   * Deinit method.
   */
  int DoDeinit();

  /**
   * Data source method.
   * @param [in] evtData       event data structure
   * @param [in] trigData	  trigger data structure
   * @param [in] outputPtr	  pointer to target buffer
   * @param [in,out] size	  <i>input</i>: size of target buffer
   *            	  <i>output</i>:size of produced data
   * @param [in] outputBlocks  list to receive output block descriptors
   * @return neg. error code if failed
   */
  int GetEvent( const AliHLTComponentEventData& evtData,
		AliHLTComponentTriggerData& trigData,
		AliHLTUInt8_t* outputPtr, 
		AliHLTUInt32_t& size,
		vector<AliHLTComponentBlockData>& outputBlocks );

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

  /** max output block size, estimate during DoInit */
  UInt_t                  fMaxSize;                                //!transient

  /** first slice (range of slices currently not implemented) */
  int                     fMinSlice;                               //!transient

  /** first partition (range of partitions currently not implemented) */
  int                     fMinPart;                                //!transient

  /** instance of the file handler */
  static AliHLTTPCFileHandler*   fgpFileHandler;                   //!transient

  /** no of file handler instances */
  static int              fgFileHandlerInstances;                  //!transient

  /** event no the file handler is currently initialized for */
  static int              fgCurrEvent;                             //!transient

  ClassDef(AliHLTTPCDigitPublisherComponent, 0);
};

#endif