3 #ifndef ALIHLT_C_COMPONENT_WARAPPERINTERFACE_H
4 #define ALIHLT_C_COMPONENT_WARAPPERINTERFACE_H
5 /* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
6 * See cxx source for full Copyright notice */
8 /** @file AliHLT_C_Component_WrapperInterface.h
9 @author Matthias Richter, Timm Steinbeck
11 @brief Pure C interface to the AliRoot HLT component handler
12 @note Utilized by the HLT Online (PubSub) framework
16 * @defgroup alihlt_wrapper_interface The HLT wrapper interface
17 * The wrapper interface is a pure C interface which allows to use the
18 * analysis components in external applications. The interface is utilized
19 * to bind the analysis code to the PubSub framework.
21 * \image html PubSub_WrapperComponent.png "Wrapper interface"
25 #include <AliHLTDataTypes.h>
27 * The names have been changed for Aliroot's coding conventions sake
28 * The old names are defined for backward compatibility with the
29 * PublisherSubscriber framework
31 typedef AliHLTComponentLogSeverity AliHLTComponent_LogSeverity;
32 typedef AliHLTComponentEventData AliHLTComponent_EventData;
33 typedef AliHLTComponentShmData AliHLTComponent_ShmData;
34 typedef AliHLTComponentDataType AliHLTComponent_DataType;
35 typedef AliHLTComponentBlockData AliHLTComponent_BlockData;
36 typedef AliHLTComponentTriggerData AliHLTComponent_TriggerData;
37 typedef AliHLTComponentEventDoneData AliHLTComponent_EventDoneData;
38 const AliHLTUInt32_t gkAliHLTComponent_InvalidShmType = gkAliHLTComponentInvalidShmType;
39 const AliHLTUInt64_t gkAliHLTComponent_InvalidShmID = gkAliHLTComponentInvalidShmID;
47 * @ingroup alihlt_wrapper_interface
49 typedef void* AliHLTComponentHandle;
53 * @ingroup alihlt_wrapper_interface
55 const AliHLTComponentHandle kEmptyHLTComponentHandle = 0;
59 * @ingroup alihlt_wrapper_interface
61 int AliHLT_C_Component_InitSystem( AliHLTComponentEnvironment* environ );
65 * @ingroup alihlt_wrapper_interface
67 int AliHLT_C_Component_DeinitSystem();
71 * @ingroup alihlt_wrapper_interface
73 int AliHLT_C_Component_LoadLibrary( const char* libraryPath );
77 * @ingroup alihlt_wrapper_interface
79 int AliHLT_C_Component_UnloadLibrary( const char* libraryPath );
83 * @ingroup alihlt_wrapper_interface
85 int AliHLT_C_CreateComponent( const char* componentType, void* environ_param, int argc, const char** argv, AliHLTComponentHandle* handle );
89 * @ingroup alihlt_wrapper_interface
91 void AliHLT_C_DestroyComponent( AliHLTComponentHandle );
95 * @ingroup alihlt_wrapper_interface
97 int AliHLT_C_ProcessEvent( AliHLTComponentHandle handle, const AliHLTComponent_EventData* evtData, const AliHLTComponent_BlockData* blocks,
98 AliHLTComponent_TriggerData* trigData, AliHLTUInt8_t* outputPtr,
99 AliHLTUInt32_t* size, AliHLTUInt32_t* outputBlockCnt,
100 AliHLTComponent_BlockData** outputBlocks,
101 AliHLTComponent_EventDoneData** edd );
105 * @ingroup alihlt_wrapper_interface
107 int AliHLT_C_GetOutputDataType( AliHLTComponentHandle, AliHLTComponent_DataType* dataType );
111 * @ingroup alihlt_wrapper_interface
113 int AliHLT_C_GetOutputSize( AliHLTComponentHandle, unsigned long* constBase, double* inputMultiplier );
119 #endif //ALIHLT_C_COMPONENT_WARAPPERINTERFACE_H