Minor cleanup of code.

[u/mrichter/AliRoot.git] / HLT / MUON / AliHLTMUONSinglesDecisionBlockStruct.h

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

/* $Id$ */

/**
 * @file   AliHLTMUONSinglesDecisionBlockStruct.h
 * @author Artur Szostak <artursz@iafrica.com>
 * @date   
 * @brief  Definition of internal dimuon HLT trigger decision data structure
 *         containing decision information for single tracks.
 * 
 * The structures are defined with C linkage since C generally gives us more
 * binary compatibility between compilers.
 */

#include "AliHLTMUONDataTypes.h"

extern "C"
{

/**
 * Structure contains information about the trigger decision for a single track.
 */
struct AliHLTMUONTrackDecisionStruct
{
	AliHLTInt32_t fTrackId; // The ID number of the track we are referring to.
	                        // This could also be a trigger record ID.
	
	// The trigger bits have the following meaning:
	// bit:  [31 --- 2][  1 ][  0 ]
	// field: reserved  hipt  lopt
	// Reserved bits should be set to zero.
	// hipt == passed high pt cut. lopt == passed low pt cut.
	AliHLTUInt32_t fTriggerBits;
};

/**
 * AliHLTMUONSinglesDecisionBlockStruct defines the format of the internal
 * dimuon HLT decision data block for individual tracks.
 */
struct AliHLTMUONSinglesDecisionBlockStruct
{
	AliHLTMUONDataBlockHeader fHeader; // Common data block header.
	AliHLTUInt32_t fNlowPt;  // Number of low pt triggers.
	AliHLTUInt32_t fNhighPt; // Number of high pt triggers.

	// Array of decisions for individual tracks.
#ifndef __SUNPRO_CC
	AliHLTMUONTrackDecisionStruct fDecision[/*fHeader.fNrecords*/];
#else
	AliHLTMUONTrackDecisionStruct fDecision[1];
#endif
};

} // extern "C"


/**
 * Stream operator for usage with std::ostream classes which prints the
 * trigger decision information for individual tracks in the following format:
 *  {fTrackId = xx, fTriggerBits = 0xYY}
 */
inline std::ostream& operator << (
		std::ostream& stream, const AliHLTMUONTrackDecisionStruct& trig
	)
{
	stream	<< "{fTrackId = " << trig.fTrackId << ", fTriggerBits = "
		<< std::showbase << std::hex << trig.fTriggerBits << std::dec
		<< "}";
	return stream;
}

/**
 * Stream operator for usage with std::ostream classes which prints the
 * AliHLTMUONSinglesDecisionBlockStruct in the following format:
 *   {fHeader = xx, fNlowPt = yy, fNhighPt = zz, fDecision[] = [{..}, {..}, ...]}
 */
std::ostream& operator << (
		std::ostream& stream,
		const AliHLTMUONSinglesDecisionBlockStruct& block
	);


inline bool operator == (
		const AliHLTMUONTrackDecisionStruct& a,
		const AliHLTMUONTrackDecisionStruct& b
	)
{
	return a.fTrackId == b.fTrackId and a.fTriggerBits == b.fTriggerBits;
}

inline bool operator != (
		const AliHLTMUONTrackDecisionStruct& a,
		const AliHLTMUONTrackDecisionStruct& b
	)
{
	return not operator == (a, b);
}


bool operator == (
		const AliHLTMUONSinglesDecisionBlockStruct& a,
		const AliHLTMUONSinglesDecisionBlockStruct& b
	);

inline bool operator != (
		const AliHLTMUONSinglesDecisionBlockStruct& a,
		const AliHLTMUONSinglesDecisionBlockStruct& b
	)
{
	return not operator == (a, b);
}

#endif // ALIHLTMUONSINGLESDECISIONBLOCKSTRUCT_H