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

// @(#) $Id$

#ifndef ALIHLT_C_COMPONENT_WARAPPERINTERFACE_H
#define ALIHLT_C_COMPONENT_WARAPPERINTERFACE_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   AliHLT_C_Component_WrapperInterface.h
    @author Matthias Richter, Timm Steinbeck
    @date   
    @brief  Pure C interface to the AliRoot HLT component handler
    @note   Utilized by the HLT Online (PubSub) framework
*/

/** 
 * @defgroup alihlt_wrapper_interface_deprecated First version of the HLT wrapper
 * interface.
 * This is the first version of the wrapper interface and became deprecated in
 * July 2008. See @ref alihlt_wrapper_interface for current interface
 * description. The interface is fixed and can not be extended.
 * @ingroup alihlt_wrapper_interface
 */

#include <AliHLTDataTypes.h>
/* Matthias Dec 2006
 * The names have been changed for Aliroot's coding conventions sake
 * The old names are defined for backward compatibility with the 
 * PublisherSubscriber framework
 */
typedef AliHLTComponentLogSeverity AliHLTComponent_LogSeverity;
typedef AliHLTComponentEventData AliHLTComponent_EventData;
typedef AliHLTComponentShmData AliHLTComponent_ShmData;
typedef AliHLTComponentDataType AliHLTComponent_DataType;
typedef AliHLTComponentBlockData AliHLTComponent_BlockData;
typedef AliHLTComponentTriggerData AliHLTComponent_TriggerData;
typedef AliHLTComponentEventDoneData AliHLTComponent_EventDoneData;
const AliHLTUInt32_t gkAliHLTComponent_InvalidShmType = gkAliHLTComponentInvalidShmType;
const AliHLTUInt64_t gkAliHLTComponent_InvalidShmID = gkAliHLTComponentInvalidShmID;

#ifdef __cplusplus
extern "C" {
#endif

/**
 * 
 * @ingroup alihlt_wrapper_interface_deprecated
 */
int AliHLT_C_Component_InitSystem( AliHLTComponentEnvironment* environ );

/**
 * 
 * @ingroup alihlt_wrapper_interface_deprecated
 */
int AliHLT_C_Component_DeinitSystem();

/**
 * 
 * @ingroup alihlt_wrapper_interface_deprecated
 */
int AliHLT_C_Component_LoadLibrary( const char* libraryPath );

/**
 * 
 * @ingroup alihlt_wrapper_interface_deprecated
 */
int AliHLT_C_Component_UnloadLibrary( const char* libraryPath );

/**
 * 
 * @ingroup alihlt_wrapper_interface_deprecated
 */
int AliHLT_C_CreateComponent( const char* componentType, void* environ_param, int argc, const char** argv, AliHLTComponentHandle* handle );

/**
 * 
 * @ingroup alihlt_wrapper_interface_deprecated
 */
void AliHLT_C_DestroyComponent( AliHLTComponentHandle );

/**
 * 
 * @ingroup alihlt_wrapper_interface_deprecated
 */
int AliHLT_C_SetRunDescription(const AliHLTRunDesc* desc, const char* runType);

/**
 * 
 * @ingroup alihlt_wrapper_interface_deprecated
 */
int AliHLT_C_ProcessEvent( AliHLTComponentHandle handle, const AliHLTComponent_EventData* evtData, const AliHLTComponent_BlockData* blocks, 
                           AliHLTComponent_TriggerData* trigData, AliHLTUInt8_t* outputPtr,
                           AliHLTUInt32_t* size, AliHLTUInt32_t* outputBlockCnt, 
                           AliHLTComponent_BlockData** outputBlocks,
                           AliHLTComponent_EventDoneData** edd );

/**
 * 
 * @ingroup alihlt_wrapper_interface_deprecated
 */
int AliHLT_C_GetOutputDataType( AliHLTComponentHandle, AliHLTComponent_DataType* dataType );

/**
 * 
 * @ingroup alihlt_wrapper_interface_deprecated
 */
int AliHLT_C_GetOutputSize( AliHLTComponentHandle, unsigned long* constBase, double* inputMultiplier );

#ifdef __cplusplus
}
#endif

#endif //ALIHLT_C_COMPONENT_WARAPPERINTERFACE_H
Commit	Line	Data
	1	// @(#) $Id$
	2
	3	#ifndef ALIHLT_C_COMPONENT_WARAPPERINTERFACE_H
	4	#define ALIHLT_C_COMPONENT_WARAPPERINTERFACE_H
	5	//* This file is property of and copyright by the ALICE HLT Project *
	6	//* ALICE Experiment at CERN, All rights reserved. *
	7	//* See cxx source for full Copyright notice *
	8
	9	/** @file AliHLT_C_Component_WrapperInterface.h
	10	@author Matthias Richter, Timm Steinbeck
	11	@date
	12	@brief Pure C interface to the AliRoot HLT component handler
	13	@note Utilized by the HLT Online (PubSub) framework
	14	*/
	15
	16	/**
	17	* @defgroup alihlt_wrapper_interface_deprecated First version of the HLT wrapper
	18	* interface.
	19	* This is the first version of the wrapper interface and became deprecated in
	20	* July 2008. See @ref alihlt_wrapper_interface for current interface
	21	* description. The interface is fixed and can not be extended.
	22	* @ingroup alihlt_wrapper_interface
	23	*/
	24
	25	#include <AliHLTDataTypes.h>
	26	/* Matthias Dec 2006
	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
	30	*/
	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;
	40
	41	#ifdef __cplusplus
	42	extern "C" {
	43	#endif
	44
	45	/**
	46	*
	47	* @ingroup alihlt_wrapper_interface_deprecated
	48	*/
	49	int AliHLT_C_Component_InitSystem( AliHLTComponentEnvironment* environ );
	50
	51	/**
	52	*
	53	* @ingroup alihlt_wrapper_interface_deprecated
	54	*/
	55	int AliHLT_C_Component_DeinitSystem();
	56
	57	/**
	58	*
	59	* @ingroup alihlt_wrapper_interface_deprecated
	60	*/
	61	int AliHLT_C_Component_LoadLibrary( const char* libraryPath );
	62
	63	/**
	64	*
	65	* @ingroup alihlt_wrapper_interface_deprecated
	66	*/
	67	int AliHLT_C_Component_UnloadLibrary( const char* libraryPath );
	68
	69	/**
	70	*
	71	* @ingroup alihlt_wrapper_interface_deprecated
	72	*/
	73	int AliHLT_C_CreateComponent( const char* componentType, void* environ_param, int argc, const char** argv, AliHLTComponentHandle* handle );
	74
	75	/**
	76	*
	77	* @ingroup alihlt_wrapper_interface_deprecated
	78	*/
	79	void AliHLT_C_DestroyComponent( AliHLTComponentHandle );
	80
	81	/**
	82	*
	83	* @ingroup alihlt_wrapper_interface_deprecated
	84	*/
	85	int AliHLT_C_SetRunDescription(const AliHLTRunDesc* desc, const char* runType);
	86
	87	/**
	88	*
	89	* @ingroup alihlt_wrapper_interface_deprecated
	90	*/
	91	int AliHLT_C_ProcessEvent( AliHLTComponentHandle handle, const AliHLTComponent_EventData* evtData, const AliHLTComponent_BlockData* blocks,
	92	AliHLTComponent_TriggerData* trigData, AliHLTUInt8_t* outputPtr,
	93	AliHLTUInt32_t* size, AliHLTUInt32_t* outputBlockCnt,
	94	AliHLTComponent_BlockData** outputBlocks,
	95	AliHLTComponent_EventDoneData** edd );
	96
	97	/**
	98	*
	99	* @ingroup alihlt_wrapper_interface_deprecated
	100	*/
	101	int AliHLT_C_GetOutputDataType( AliHLTComponentHandle, AliHLTComponent_DataType* dataType );
	102
	103	/**
	104	*
	105	* @ingroup alihlt_wrapper_interface_deprecated
	106	*/
	107	int AliHLT_C_GetOutputSize( AliHLTComponentHandle, unsigned long* constBase, double* inputMultiplier );
	108
	109	#ifdef __cplusplus
	110	}
	111	#endif
	112
	113	#endif //ALIHLT_C_COMPONENT_WARAPPERINTERFACE_H