Quick Links: ROOT Homepage Class Index Class Hierarchy

Source: header file source file inheritance tree (.pdf)

Sections: class description function members data members class charts

AliRoot » HLT » BASE » AliHLTDataBuffer::AliHLTRawBuffer

class AliHLTDataBuffer::AliHLTRawBuffer

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)

public:

virtual	~AliHLTRawBuffer()
AliHLTDataBuffer::AliHLTRawBuffer	AliHLTRawBuffer()
AliHLTDataBuffer::AliHLTRawBuffer	AliHLTRawBuffer(AliHLTUInt32_t size)
AliHLTDataBuffer::AliHLTRawBuffer	AliHLTRawBuffer(AliHLTUInt32_t size, AliHLTUInt8_t* buffer)
int	CheckPattern(const char* pattern, int size) const
int	CheckSize(AliHLTUInt32_t size) const
AliHLTUInt8_t*	GetPointer() const
AliHLTUInt32_t	GetTotalSize() const
AliHLTUInt32_t	GetUsedSize() const
int	Merge(const AliHLTDataBuffer::AliHLTRawBuffer& succ)
AliHLTUInt8_t*	operator AliHLTUInt8_t*() const
void*	operator void*() const
int	operator-(void* ptr) const
int	operator<(void* ptr) const
int	operator<(const AliHLTDataBuffer::AliHLTRawBuffer& op) const
int	operator<=(void* ptr) const
int	operator<=(const AliHLTDataBuffer::AliHLTRawBuffer& op) const
int	operator==(void* ptr) const
int	operator==(AliHLTUInt8_t* ptr) const
int	operator>(void* ptr) const
int	operator>(const AliHLTDataBuffer::AliHLTRawBuffer& op) const
virtual void	Print(const char* option) const
int	Reset()
AliHLTDataBuffer::AliHLTRawBuffer*	Split(AliHLTUInt32_t size)
AliHLTUInt8_t*	UseBuffer(AliHLTUInt32_t size)
int	WritePattern(const char* pattern, int size)

private:

AliHLTUInt8_t	AliHLTRawBuffer(const AliHLTDataBuffer::AliHLTRawBuffer&)
AliHLTDataBuffer::AliHLTRawBuffer&	operator=(const AliHLTDataBuffer::AliHLTRawBuffer&)

Data Members

private:

AliHLTUInt8_t*	fExternalPtr	! transient
AliHLTUInt32_t	fLastEventCount	! transient
AliHLTUInt8_t*	fPtr	! transient
AliHLTUInt32_t	fSize	see above
AliHLTUInt32_t	fTotalSize	see above

Class Charts

Inheritance Chart:

AliHLTDataBuffer::AliHLTRawBuffer

Function documentation

AliHLTRawBuffer(AliHLTUInt32_t size)

 see header file for class documentation
 or
 refer to README to build package
 or
 visit http://web.ift.uib.no/~kjeks/doc/alice-hlt

AliHLTRawBuffer(AliHLTUInt32_t size, AliHLTUInt8_t* buffer)

 see header file for class documentation

~AliHLTRawBuffer()

 see header file for class documentation

int operator==(void* ptr) const

 see header file for function documentation

int operator<(void* ptr) const

 see header file for function documentation

int operator<=(void* ptr) const

 see header file for function documentation

int operator>(void* ptr) const

 see header file for function documentation

int operator-(void* ptr) const

 see header file for function documentation

int operator<(const AliHLTDataBuffer::AliHLTRawBuffer& op) const

 see header file for function documentation

int operator<=(const AliHLTDataBuffer::AliHLTRawBuffer& op) const

 see header file for function documentation

int operator>(const AliHLTDataBuffer::AliHLTRawBuffer& op) const

 see header file for function documentation

AliHLTUInt8_t* UseBuffer(AliHLTUInt32_t size)

 mark a portion of the buffer as used

AliHLTDataBuffer::AliHLTRawBuffer* Split(AliHLTUInt32_t size)

 split a buffer at specified size
 only possible for buffers with external memory

int CheckSize(AliHLTUInt32_t size) const

 see header file for function documentation

int Reset()

 see header file for function documentation

int WritePattern(const char* pattern, int size)

 see header file for function documentation

int CheckPattern(const char* pattern, int size) const

 see header file for function documentation

int Merge(const AliHLTDataBuffer::AliHLTRawBuffer& succ)

 Merge buffer with neighboring buffer.
 Only possible if the buffers are consecutive with out any gap.

void Print(const char* option) const

 print buffer information

AliHLTDataSegment& operator=(const AliHLTDataBuffer::AliHLTRawBuffer& )

 AliHLTDataSegment just stores external pointers and properties

int operator==(AliHLTUInt8_t* ptr) const

operator AliHLTUInt8_t*() const

{return fPtr+fSegmentOffset;}

AliHLTRawBuffer()

 standard constructor

{}

AliHLTRawBuffer(AliHLTUInt32_t size)

 constructor

AliHLTUInt32_t GetUsedSize() const

     * Get used size of the buffer

{return fSize;}

AliHLTUInt32_t GetTotalSize() const

     * Get total size of the buffer

{return fTotalSize;}

AliHLTUInt8_t* GetPointer() const

     * Get pointer of data buffer

{return fPtr;}

operator void*() const

{return fPtr;}