Prepare for new code

[u/mrichter/AliRoot.git] / RALICE / AliObjMatrix.h

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

// $Id$

#include "TNamed.h"
#include "TObjArray.h"
#include "TArrayI.h"

class AliObjMatrix : public TNamed
{
 public:
  AliObjMatrix();                                                   // Default constructor
  virtual ~AliObjMatrix();                                          // Default destructor
  AliObjMatrix(const AliObjMatrix& m);                              // Copy constructor
  virtual TObject* Clone(const char* name="") const;                // Make a deep copy and provide its pointer
  virtual void Reset();                                             // Reset the whole matrix structure
  virtual void SetOwner(Int_t own=1);                               // Set the owner flag for the stored objects
  virtual Int_t GetOwner() const;                                   // Provide the owner flag for the stored objects
  virtual void SetSwapMode(Int_t swap=1);                           // Set the swap mode flag for this matrix
  virtual Int_t GetSwapMode() const;                                // Provide the swap mode flag for this matrix
  virtual void EnterObject(Int_t row,Int_t col,TObject* obj);       // Enter an object into the matrix
  void RemoveObject(Int_t row,Int_t col);                           // Remove object at (row,col) from the matrix
  void RemoveObjects(TObject* obj,Int_t row=0,Int_t col=0);         // Remove specified object(s) from the matrix
  virtual TObject* GetObject(Int_t row,Int_t col) const;            // Provide an object from the matrix
  virtual Int_t GetMaxRow() const;                                  // Provide the maximum row number index
  virtual Int_t GetMaxColumn() const;                               // Provide the maximum column number index
  virtual Int_t GetNobjects() const;                                // Provide the number of stored objects
  virtual TObject* GetObject(Int_t j) const;                        // Provide pointer to the j-th object
  virtual TObjArray* GetObjects();                                  // Provide pointers of all stored onjects
  Int_t GetNrefs(TObject* obj) const;                               // Number of stored references to this object
  Int_t GetIndices(TObject* obj,TArrayI& rows,TArrayI& cols) const; // All (row,col) indices of this object
  Int_t GetIndices(TObject* obj,Int_t row,TArrayI& cols) const;     // Column indices in a specific row
  Int_t GetIndices(TObject* obj,TArrayI& rows,Int_t col) const;     // Row indices in a specific column
 
 protected:
  TObjArray* fRows;    // Pointers to the various arrays representing the matrix rows
  Int_t fOwn;          // Flag to indicate whether the objects are owned by the matrix structure
  Int_t fSwap;         // Flag to indicate swapped mode for internal matrix storage
  Int_t fMaxrow;       // The maximum row number index
  Int_t fMaxcol;       // The maximum column number index
  TObjArray* fObjects; // Linear reference array for fast looping over the stored objects
 
 ClassDef(AliObjMatrix,7) // Handling of a matrix structure of objects.
};
#endif