class AliHLTOUTHandler: public AliHLTLogging

This file is property of and copyright by the
ALICE Experiment at CERN, All rights reserved.

Primary Authors: Matthias Richter <Matthias.Richter@ift.uib.no>
for The ALICE HLT Project.

Permission to use, copy, modify and distribute this software and its
documentation strictly for non-commercial purposes is hereby granted
without fee, provided that the above copyright notice appears in all
copies and that both the copyright notice and this permission notice
appear in the supporting documentation. The authors make no claims
about the suitability of this software for any purpose. It is
provided "as is" without express or implied warranty.

Function Members (Methods)

This is an abstract class, constructors will not be documented.
Look at the header to check for available constructors.

public:

virtual	~AliHLTOUTHandler()
static const char*	AliHLTLogging::BuildLogString(const char* format, va_list& ap, bool bAppend = false)
int	AliHLTLogging::CheckFilter(AliHLTComponentLogSeverity severity) const
int	AliHLTLogging::CheckGroup(const char* originClass) const
bool	CheckStatus(unsigned int flag) const
static TClass*	Class()
virtual int	FinishEvent()
static AliHLTComponentLogSeverity	AliHLTLogging::GetGlobalLoggingLevel()
const char*	AliHLTLogging::GetKeyword() const
static AliHLTComponentLogSeverity	AliHLTLogging::GetLocalLoggingDefault()
AliHLTComponentLogSeverity	AliHLTLogging::GetLocalLoggingLevel()
virtual void*	AliHLTLogging::GetParameter() const
virtual int	GetProcessedData(const AliHLTUInt8_t*& pData)
static int	AliHLTLogging::Init(AliHLTfctLogging pFun)
static int	AliHLTLogging::InitAliLogFunc(AliHLTComponentHandler* pHandler)
static int	AliHLTLogging::InitAliLogTrap(AliHLTComponentHandler* pHandler)
virtual TClass*	IsA() const
int	AliHLTLogging::Logging(AliHLTComponentLogSeverity severity, const char* origin, const char* keyword, const char* message)
virtual int	AliHLTLogging::LoggingVarargs(AliHLTComponentLogSeverity severity, const char* originClass, const char* originFunc, const char* file, int line) const
static int	AliHLTLogging::Message(void* param, AliHLTComponentLogSeverity severity, const char* origin, const char* keyword, const char* message)
virtual int	ProcessData(AliHLTOUT* pData)
virtual int	ReleaseProcessedData(const AliHLTUInt8_t* pData, int size)
void	ResetState()
int	AliHLTLogging::SendMessage(AliHLTComponentLogSeverity severity, const char* originClass, const char* originFunc, const char* file, int line, const char* message) const
static int	AliHLTLogging::SetBlackList(const char* classnames)
void	AliHLTLogging::SetDefaultKeyword(const char* keyword)
static void	AliHLTLogging::SetGlobalLoggingLevel(AliHLTComponentLogSeverity level)
const char*	AliHLTLogging::SetKeyword(const char* keyword)
static void	AliHLTLogging::SetLocalLoggingDefault(AliHLTComponentLogSeverity level)
virtual void	AliHLTLogging::SetLocalLoggingLevel(AliHLTComponentLogSeverity level)
static const char*	AliHLTLogging::SetLogString(const void* p, const char* pfmt, const char* format)
static int	AliHLTLogging::SetWhiteList(const char* classnames)
virtual void	ShowMembers(TMemberInspector&)
virtual void	Streamer(TBuffer&)
void	StreamerNVirtual(TBuffer& ClassDef_StreamerNVirtual_b)
void	AliHLTLogging::SwitchAliLog(int sw)

protected:

void	ClearStatusFlag(unsigned int flag)
void	SetStatusFlag(unsigned int flag)

private:

AliHLTOUTHandler&

operator=(const AliHLTOUTHandler&)

Data Members

public:

enum {	kHandlerUndefined
	kHandlerOK
	kHandlerError
};

public:

static ostringstream	AliHLTLogging::fgLogstr	! transient

protected:

static void*	AliHLTLogging::fgAliLoggingFunc	! transient

private:

int	fState	!transient

Class Charts

Inheritance Chart:

AliHLTLogging

←

AliHLTOUTHandler

←

AliHLTOUTHandlerChain

AliHLTOUTHandlerEquId

←

AliHLTOUTHandlerDetectorDDL

AliHLTOUTHandlerEsdBranch

AliHLTOUTHandlerIgnore

Function documentation

~AliHLTOUTHandler()

 destructor

int GetProcessedData(const AliHLTUInt8_t*& pData)

 get pointer to processed data

int ReleaseProcessedData(const AliHLTUInt8_t* pData, int size)

 release the data pointer previously retrieved by GetProcessedData

int FinishEvent()

 cleanup the current event processing.

int ProcessData(AliHLTOUT* pData)

   * Process the data.
   * The data blocks can be selected by AliHLTOUT::SelectFirstDataBlock() and
   * AliHLTOUT::SelectNextDataBlock()
   *
   * Properties of the current data block can be retrieved by the following member
   * functions of AliHLTOUT:
   * - AliHLTOUT::GetDataBlockDescription(AliHLTComponentDataType& dt, AliHLTUInt32_t& spec)
   * - AliHLTOUT::GetDataBlockIndex()
   * - AliHLTOUT::GetDataBuffer(const AliHLTUInt8_t* &pBuffer, AliHLTUInt32_t& size)
   * - AliHLTOUT::ReleaseDataBuffer(const AliHLTUInt8_t* pBuffer)
   *
   * The handler might decode the data block and produce new data as a
   * replacement, see GetProcessedData()
   * @param pData     instance of the AliHLTOUT data
   * @return depending on the overloaded function, neg. error code if failed

bool CheckStatus(unsigned int flag) const

   * Check state flag of the handler.
   * @return true if flag matches

void ResetState()

   * Reset the state flag.

void SetStatusFlag(unsigned int flag)

void ClearStatusFlag(unsigned int flag)

AliHLTOUTHandler& operator=(const AliHLTOUTHandler& )

 assignment operator prohibited