FMD1 position at 320 (see FMD TDR table 4.1)

[u/mrichter/AliRoot.git] / HLT / BASE / AliHLTComponent.h

// @(#) $Id$

#ifndef ALIHLTCOMPONENT_H
#define ALIHLTCOMPONENT_H
/* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
 * See cxx source for full Copyright notice                               */

/* AliHLTComponent
   base class for HLT components
 */

#include <errno.h>
#include "AliHLTDataTypes.h"
#include "TObject.h"

class AliHLTComponentHandler;

class AliHLTComponent {
 public:
  AliHLTComponent();
  virtual ~AliHLTComponent();

  enum TComponentType { kUnknown=0, kSource=1, kProcessor=2, kSink=3 };
  virtual int Init( AliHLTComponentEnvironment* environ, void* environ_param, int argc, const char** argv );
  virtual int Deinit();
  virtual int ProcessEvent( AliHLTComponent_EventData evtData, AliHLTComponent_BlockData* blocks, 
			    AliHLTComponent_TriggerData trigData, AliHLTUInt8_t* outputPtr, 
			    AliHLTUInt32_t* size, AliHLTUInt32_t* outputBlockCnt, 
			    AliHLTComponent_BlockData** outputBlocks,
			    AliHLTComponent_EventDoneData** edd ) = 0;

  // Information member functions for registration.
  virtual TComponentType GetComponentType() = 0; // Source, sink, or processor
  virtual const char* GetComponentID() = 0;
  virtual void GetInputDataTypes( vector<AliHLTComponent_DataType>& ) = 0;
  virtual AliHLTComponent_DataType GetOutputDataType() = 0;

  // Spawn function, return new class instance
  virtual AliHLTComponent* Spawn() = 0;
 
  static int SetGlobalComponentHandler(AliHLTComponentHandler* pCH, int bOverwrite=0) {
    int iResult=0;
    if (fpComponentHandler==NULL || bOverwrite!=0)
      fpComponentHandler=pCH;
    else
      iResult=-EPERM;
    return iResult;
  }
  static int UnsetGlobalComponentHandler() {
    return SetGlobalComponentHandler(NULL,1);
  }
 protected:
  
  virtual int DoInit( int argc, const char** argv ){
    return 0;
  }

  virtual int DoDeinit(){
    return 0;
  }

  void* AllocMemory( unsigned long size ) {
    if (fEnvironment.fAllocMemoryFunc)
      return (*fEnvironment.fAllocMemoryFunc)(fEnvironment.fParam, size );
    return NULL;
  }

  int MakeOutputDataBlockList( const vector<AliHLTComponent_BlockData>& blocks, AliHLTUInt32_t* blockCount,
			       AliHLTComponent_BlockData** outputBlocks ) {
    if (fEnvironment.fMakeOutputDataBlockListFunc)
      return (*fEnvironment.fMakeOutputDataBlockListFunc)(fEnvironment.fParam, blocks, blockCount, outputBlocks );
    return -ENOSYS;
  }

  int GetEventDoneData( unsigned long size, AliHLTComponent_EventDoneData** edd ) {
    if (fEnvironment.fGetEventDoneDataFunc)
      return (*fEnvironment.fGetEventDoneDataFunc)(fEnvironment.fParam, fCurrentEvent, size, edd );
    return -ENOSYS;
  }

  int Logging( AliHLTComponent_LogSeverity severity, const char* origin, const char* keyword, const char* message, ... );

 private:
  static AliHLTComponentHandler* fpComponentHandler;
  AliHLTComponentEnvironment fEnvironment;

  AliHLTEventID_t fCurrentEvent; // Set by ProcessEvent before actual processing starts (e.g. before calling AliHLTProcessor::DoEvent)

  ClassDef(AliHLTComponent, 0)
};
#endif