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 » ANALYSIS » AliAnalysisDataContainer

class AliAnalysisDataContainer: public TNamed

   AliAnalysysDataContainer - Container of data of arbitrary type deriving
      from TObject used for analysis. A container must be connected to the
      output data slot of a single analysis task (producer) , but also as
      input slot for possibly several other tasks (consumers). The connected
      slots must enforce the same data type as the container (or a derived type).
      A container becomes the owner of the contained data once this was produced.

 Containers should be defined by the analysis module using:

   AliAnalysisModule::AddContainer(const char *name, TClass *type);

 A container should be connected to a producer:

Function Members (Methods)

public:

	AliAnalysisDataContainer()
	AliAnalysisDataContainer(const AliAnalysisDataContainer& cont)
	AliAnalysisDataContainer(const char* name, TClass* type)
virtual	~AliAnalysisDataContainer()
void	TObject::AbstractMethod(const char* method) const
void	AddConsumer(AliAnalysisTask* cons, Int_t islot)
virtual void	TObject::AppendPad(Option_t* option = "")
virtual void	TObject::Browse(TBrowser* b)
static TClass*	Class()
virtual const char*	TObject::ClassName() const
virtual void	TNamed::Clear(Option_t* option = "")
Bool_t	ClientsExecuted() const
virtual TObject*	TNamed::Clone(const char* newname = "") const
virtual Int_t	TNamed::Compare(const TObject* obj) const
virtual void	TNamed::Copy(TObject& named) const
virtual void	TObject::Delete(Option_t* option = "")MENU
void	DeleteData()
virtual Int_t	TObject::DistancetoPrimitive(Int_t px, Int_t py)
virtual void	TObject::Draw(Option_t* option = "")
virtual void	TObject::DrawClass() constMENU
virtual TObject*	TObject::DrawClone(Option_t* option = "") constMENU
virtual void	TObject::Dump() constMENU
virtual void	TObject::Error(const char* method, const char* msgfmt) const
virtual void	TObject::Execute(const char* method, const char* params, Int_t* error = 0)
virtual void	TObject::Execute(TMethod* method, TObjArray* params, Int_t* error = 0)
virtual void	TObject::ExecuteEvent(Int_t event, Int_t px, Int_t py)
AliAnalysisDataWrapper*	ExportData() const
virtual void	TObject::Fatal(const char* method, const char* msgfmt) const
virtual void	TNamed::FillBuffer(char*& buffer)
virtual TObject*	TObject::FindObject(const char* name) const
virtual TObject*	TObject::FindObject(const TObject* obj) const
TObjArray*	GetConsumers() const
TObject*	GetData() const
virtual Option_t*	TObject::GetDrawOption() const
static Long_t	TObject::GetDtorOnly()
virtual void	GetEntry(Long64_t ientry)
TFile*	GetFile() const
const char*	GetFileName() const
const char*	GetFolderName() const
virtual const char*	TObject::GetIconName() const
virtual const char*	TNamed::GetName() const
virtual char*	TObject::GetObjectInfo(Int_t px, Int_t py) const
static Bool_t	TObject::GetObjectStat()
virtual Option_t*	TObject::GetOption() const
AliAnalysisTask*	GetProducer() const
virtual const char*	TNamed::GetTitle() const
TClass*	GetType() const
virtual UInt_t	TObject::GetUniqueID() const
virtual Bool_t	TObject::HandleTimer(TTimer* timer)
Bool_t	HasConsumers() const
virtual ULong_t	TNamed::Hash() const
Bool_t	HasProducer() const
void	ImportData(AliAnalysisDataWrapper* pack)
virtual void	TObject::Info(const char* method, const char* msgfmt) const
virtual Bool_t	TObject::InheritsFrom(const char* classname) const
virtual Bool_t	TObject::InheritsFrom(const TClass* cl) const
virtual void	TObject::Inspect() constMENU
void	TObject::InvertBit(UInt_t f)
virtual TClass*	IsA() const
Bool_t	IsDataReady() const
virtual Bool_t	TObject::IsEqual(const TObject* obj) const
Bool_t	IsExchange() const
virtual Bool_t	TObject::IsFolder() const
Bool_t	TObject::IsOnHeap() const
Bool_t	IsOwnedData() const
Bool_t	IsPostEventLoop() const
Bool_t	IsRegisterDataset() const
virtual Bool_t	TNamed::IsSortable() const
Bool_t	IsSpecialOutput() const
Bool_t	IsTouched() const
Bool_t	TObject::IsZombie() const
virtual void	TNamed::ls(Option_t* option = "") const
void	TObject::MayNotUse(const char* method) const
virtual Long64_t	Merge(TCollection* list)
virtual Bool_t	TObject::Notify()
virtual void	NotifyChange(AliAnalysisDataContainer::ENotifyMessage)
void	TObject::Obsolete(const char* method, const char* asOfVers, const char* removedFromVers) const
static void	TObject::operator delete(void* ptr)
static void	TObject::operator delete(void* ptr, void* vp)
static void	TObject::operator delete[](void* ptr)
static void	TObject::operator delete[](void* ptr, void* vp)
void*	TObject::operator new(size_t sz)
void*	TObject::operator new(size_t sz, void* vp)
void*	TObject::operator new[](size_t sz)
void*	TObject::operator new[](size_t sz, void* vp)
AliAnalysisDataContainer&	operator=(const AliAnalysisDataContainer& cont)
virtual void	TObject::Paint(Option_t* option = "")
virtual void	TObject::Pop()
virtual void	TNamed::Print(Option_t* option = "") const
void	PrintContainer(Option_t* option = "all", Int_t indent = 0) const
virtual Int_t	TObject::Read(const char* name)
virtual void	TObject::RecursiveRemove(TObject* obj)
void	Reset()
void	TObject::ResetBit(UInt_t f)
void	ResetDataReady()
virtual void	TObject::SaveAs(const char* filename = "", Option_t* option = "") constMENU
virtual void	TObject::SavePrimitive(basic_ostream<char,char_traits<char> >& out, Option_t* option = "")
void	TObject::SetBit(UInt_t f)
void	TObject::SetBit(UInt_t f, Bool_t set)
virtual Bool_t	SetData(TObject* data, Option_t* option = "")
void	SetDataOwned(Bool_t flag)
virtual void	TObject::SetDrawOption(Option_t* option = "")MENU
static void	TObject::SetDtorOnly(void* obj)
void	SetExchange(Bool_t flag)
void	SetFile(TFile* f)
void	SetFileName(const char* filename)
virtual void	TNamed::SetName(const char* name)MENU
virtual void	TNamed::SetNameTitle(const char* name, const char* title)
static void	TObject::SetObjectStat(Bool_t stat)
void	SetPostEventLoop(Bool_t flag = kTRUE)
void	SetProducer(AliAnalysisTask* prod, Int_t islot)
void	SetRegisterDataset(Bool_t flag = kTRUE)
void	SetSpecialOutput(Bool_t flag = kTRUE)
virtual void	TNamed::SetTitle(const char* title = "")MENU
void	SetTouched(Bool_t flag = kTRUE)
virtual void	TObject::SetUniqueID(UInt_t uid)
virtual void	ShowMembers(TMemberInspector&)
virtual Int_t	TNamed::Sizeof() const
virtual void	Streamer(TBuffer&)
void	StreamerNVirtual(TBuffer& ClassDef_StreamerNVirtual_b)
virtual void	TObject::SysError(const char* method, const char* msgfmt) const
Bool_t	TObject::TestBit(UInt_t f) const
Int_t	TObject::TestBits(UInt_t f) const
virtual void	TObject::UseCurrentStyle()
virtual void	TObject::Warning(const char* method, const char* msgfmt) const
virtual Int_t	TObject::Write(const char* name = 0, Int_t option = 0, Int_t bufsize = 0)
virtual Int_t	TObject::Write(const char* name = 0, Int_t option = 0, Int_t bufsize = 0) const

protected:

virtual void	TObject::DoError(int level, const char* location, const char* fmt, va_list va) const
void	TObject::MakeZombie()

private:

void	SetType(TClass* type)

Data Members

public:

enum ENotifyMessage {	kDeleteData
	kSaveData
	kFileChange
};
enum EAnalysisContainerFlags {	kPostEventLoop
	kSpecialOutput
	kRegisterDataset
	kExchangeData
	kTouchedFlag
};
enum TObject::EStatusBits {	kCanDelete
	kMustCleanup
	kObjInCanvas
	kIsReferenced
	kHasUUID
	kCannotPick
	kNoContextMenu
	kInvalidObject
};
enum TObject::[unnamed] {	kIsOnHeap
	kNotDeleted
	kZombie
	kBitMask
	kSingleKey
	kOverwrite
	kWriteDelete
};

protected:

TObjArray*	fConsumers	List of consumers of the data
TObject*	fData	Contained data
Bool_t	fDataReady	Flag that data is ready
TFile*	fFile	! Opened file
TString	fFileName	File storing the data
TString	fFolderName	Folder name in the output file
TString	TNamed::fName	object identifier
Bool_t	fOwnedData	Flag data ownership
AliAnalysisTask*	fProducer	Analysis task to which the slot belongs
TString	TNamed::fTitle	object title
TClass*	fType	! Type of contained data

Class Charts

Inheritance Chart:

TNamed

←

AliAnalysisDataContainer

Function documentation

AliAnalysisDataContainer()

 Dummy ctor.

AliAnalysisDataContainer(const char* name, TClass* type)

 Default constructor.

AliAnalysisDataContainer(const AliAnalysisDataContainer& cont)

 Copy ctor.

~AliAnalysisDataContainer()

 Destructor. Deletes data ! (What happens if data is a container ???)

AliAnalysisDataContainer & operator=(const AliAnalysisDataContainer& cont)

 Assignment.

void AddConsumer(AliAnalysisTask* cons, Int_t islot)

 Add a consumer for contained data;

Bool_t ClientsExecuted() const

 Check if all client tasks have executed.

void DeleteData()

 Delete data if not needed anymore.

TClass * GetType() const

 Get class type for this slot.

void GetEntry(Long64_t ientry)

 If data is ready and derives from TTree or from TBranch, this will get the
 requested entry in memory if not already loaded.

Long64_t Merge(TCollection* list)

 Merge a list of containers with this one. Containers in the list must have
 data of the same type.

void PrintContainer(Option_t* option = "all", Int_t indent = 0) const

 Print info about this container.

Bool_t SetData(TObject* data, Option_t* option = "")

 Set the data as READY only if it was published by the producer.
 If there is no producer declared, this is a top level container.

void SetFileName(const char* filename)

 The filename field can be actually composed by the actual file name followed
 by :dirname (optional):
 filename = file_name[:dirname]
 No slashes (/) allowed

void SetProducer(AliAnalysisTask* prod, Int_t islot)

 Set the producer of data. The slot number is required for data type checking.

AliAnalysisDataWrapper * ExportData() const

 Wraps data for sending it through the net.

void ImportData(AliAnalysisDataWrapper* pack)

 Unwraps data from a data wrapper.

TObject * GetData() const

 Getters

{return fData;}

const char * GetFileName() const

{return fFileName.Data();}

const char * GetFolderName() const

{return fFolderName.Data();}

TFile * GetFile() const

{return fFile;}

AliAnalysisTask * GetProducer() const

{return fProducer;}

TObjArray * GetConsumers() const

{return fConsumers;}

void Reset()

 Setters

{fData = 0; fDataReady = kFALSE; SetTouched(kFALSE);}

void ResetDataReady()

{fDataReady = kFALSE;}

void SetDataOwned(Bool_t flag)

{fOwnedData = flag;}

void SetExchange(Bool_t flag)

{TObject::SetBit(kExchangeData,flag);}

void SetPostEventLoop(Bool_t flag = kTRUE)

{TObject::SetBit(kPostEventLoop,flag);}

void SetSpecialOutput(Bool_t flag = kTRUE)

{TObject::SetBit(kSpecialOutput,flag);}

void SetRegisterDataset(Bool_t flag = kTRUE)

{TObject::SetBit(kRegisterDataset,flag);}

void SetFile(TFile* f)

{fFile = f;}

void SetTouched(Bool_t flag = kTRUE)

{TObject::SetBit(kTouchedFlag,flag);}

Bool_t IsDataReady() const

 Container status checking

{return fDataReady;}

Bool_t IsExchange() const

{return TObject::TestBit(kExchangeData);}

Bool_t IsPostEventLoop() const

{return TObject::TestBit(kPostEventLoop);}

Bool_t IsSpecialOutput() const

{return TObject::TestBit(kSpecialOutput);}

Bool_t IsRegisterDataset() const

{return TObject::TestBit(kRegisterDataset);}

Bool_t IsTouched() const

{return TObject::TestBit(kTouchedFlag);}

Bool_t IsOwnedData() const

{return fOwnedData;}

Bool_t HasConsumers() const

{return (fConsumers != 0);}

Bool_t HasProducer() const

 Container merging

{return (fProducer != 0);}

void NotifyChange(AliAnalysisDataContainer::ENotifyMessage )

 Send a notify signal to the container

{;}

void SetType(TClass* type)

{fType = type;}