ROOT  6.07/01
Reference Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Classes | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
TBits Class Reference

Container of bits.

This class provides a simple container of bits. Each bit can be set and tested via the functions SetBitNumber and TestBitNumber.The default value of all bits is kFALSE. The size of the container is automatically extended when a bit number is either set or tested. To reduce the memory size of the container use the Compact function, this will discard the memory occupied by the upper bits that are 0.

Definition at line 33 of file TBits.h.

Classes

class  TReference
 

Public Member Functions

 TBits (UInt_t nbits=8)
 
 TBits (const TBits &)
 TBits copy constructor. More...
 
TBitsoperator= (const TBits &)
 TBits assignment operator. More...
 
virtual ~TBits ()
 TBits destructor. More...
 
void ResetAllBits (Bool_t value=kFALSE)
 Reset all bits to 0 (false). More...
 
void ResetBitNumber (UInt_t bitnumber)
 
void SetBitNumber (UInt_t bitnumber, Bool_t value=kTRUE)
 
Bool_t TestBitNumber (UInt_t bitnumber) const
 
TBits::TReference operator[] (UInt_t bitnumber)
 
Bool_t operator[] (UInt_t bitnumber) const
 
TBitsoperator&= (const TBits &rhs)
 
TBitsoperator|= (const TBits &rhs)
 
TBitsoperator^= (const TBits &rhs)
 
TBitsoperator<<= (UInt_t rhs)
 
TBitsoperator>>= (UInt_t rhs)
 
TBits operator<< (UInt_t rhs)
 
TBits operator>> (UInt_t rhs)
 
TBits operator~ ()
 
void Set (UInt_t nbits, const Char_t *array)
 Set all the bytes. More...
 
void Set (UInt_t nbits, const UChar_t *array)
 
void Set (UInt_t nbits, const Short_t *array)
 
void Set (UInt_t nbits, const UShort_t *array)
 
void Set (UInt_t nbits, const Int_t *array)
 
void Set (UInt_t nbits, const UInt_t *array)
 
void Set (UInt_t nbits, const Long64_t *array)
 
void Set (UInt_t nbits, const ULong64_t *array)
 
void Get (Char_t *array) const
 Copy all the byes. More...
 
void Get (UChar_t *array) const
 
void Get (Short_t *array) const
 
void Get (UShort_t *array) const
 
void Get (Int_t *array) const
 
void Get (UInt_t *array) const
 
void Get (Long64_t *array) const
 
void Get (ULong64_t *array) const
 
void Clear (Option_t *option="")
 Clear the value. More...
 
void Compact ()
 Reduce the storage used by the object to a minimun. More...
 
UInt_t CountBits (UInt_t startBit=0) const
 Return number of bits set to 1 starting at bit startBit. More...
 
UInt_t FirstNullBit (UInt_t startBit=0) const
 Return position of first null bit (starting from position 0 and up) More...
 
UInt_t FirstSetBit (UInt_t startBit=0) const
 Return position of first non null bit (starting from position 0 and up) More...
 
UInt_t LastNullBit (UInt_t startBit=999999999) const
 Return position of first null bit (starting from position 0 and up) More...
 
UInt_t LastSetBit (UInt_t startBit=999999999) const
 Return position of first non null bit (starting from position 0 and up) More...
 
UInt_t GetNbits () const
 
UInt_t GetNbytes () const
 
Bool_t operator== (const TBits &other) const
 
Bool_t operator!= (const TBits &other) const
 
void Paint (Option_t *option="")
 Once implemented, it will draw the bit field as an histogram. More...
 
void Print (Option_t *option="") const
 Print the list of active bits. More...
 
void Output (std::ostream &) const
 Print the value to the std::ostream. More...
 
- Public Member Functions inherited from TObject
 TObject ()
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator. More...
 
virtual ~TObject ()
 TObject destructor. More...
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad. More...
 
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action. More...
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs. More...
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility. More...
 
virtual Int_t Compare (const TObject *obj) const
 Compare abstract method. More...
 
virtual void Copy (TObject &object) const
 Copy this to obj. More...
 
virtual void Delete (Option_t *option="")
 Delete this object. More...
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object. More...
 
virtual void Draw (Option_t *option="")
 Default Draw method for all objects. More...
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs. More...
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current pad. More...
 
virtual void Dump () const
 Dump contents of object on stdout. More...
 
virtual void Execute (const char *method, const char *params, Int_t *error=0)
 Execute method on this object with the given parameter string, e.g. More...
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=0)
 Execute method on this object with parameters stored in the TObjArray. More...
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py). More...
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes. More...
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes. More...
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object. More...
 
virtual UInt_t GetUniqueID () const
 Return the unique object id. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual Option_tGetOption () const
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out. More...
 
virtual ULong_t Hash () const
 Return hash value for this object. More...
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname". More...
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl. More...
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas. More...
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory). More...
 
virtual Bool_t IsSortable () const
 
Bool_t IsOnHeap () const
 
Bool_t IsZombie () const
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. More...
 
virtual void ls (Option_t *option="") const
 The ls function lists the contents of a class on stdout. More...
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list. More...
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory. More...
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list. More...
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename. More...
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out". More...
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object. More...
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id. More...
 
virtual void UseCurrentStyle ()
 Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory. More...
 
voidoperator new (size_t sz)
 
voidoperator new[] (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz, void *vp)
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. More...
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. More...
 
void SetBit (UInt_t f)
 
void ResetBit (UInt_t f)
 
Bool_t TestBit (UInt_t f) const
 
Int_t TestBits (UInt_t f) const
 
void InvertBit (UInt_t f)
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. More...
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. More...
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. More...
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract. More...
 
void MayNotUse (const char *method) const
 Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary). More...
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete. More...
 

Protected Member Functions

void ReserveBytes (UInt_t nbytes)
 Reverse each bytes. More...
 
void DoAndEqual (const TBits &rhs)
 Execute (*this) &= rhs; Extra bits in rhs are ignored Missing bits in rhs are assumed to be zero. More...
 
void DoOrEqual (const TBits &rhs)
 Execute (*this) &= rhs; Extra bits in rhs are ignored Missing bits in rhs are assumed to be zero. More...
 
void DoXorEqual (const TBits &rhs)
 Execute (*this) ^= rhs; Extra bits in rhs are ignored Missing bits in rhs are assumed to be zero. More...
 
void DoLeftShift (UInt_t shift)
 Execute the left shift operation. More...
 
void DoRightShift (UInt_t shift)
 Execute the left shift operation. More...
 
void DoFlip ()
 Execute ~(*this) More...
 
- Protected Member Functions inherited from TObject
void MakeZombie ()
 
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected). More...
 

Protected Attributes

UInt_t fNbits
 
UInt_t fNbytes
 
UChar_tfAllBits
 

Additional Inherited Members

- Public Types inherited from TObject
enum  EStatusBits {
  kCanDelete = BIT(0), kMustCleanup = BIT(3), kObjInCanvas = BIT(3), kIsReferenced = BIT(4),
  kHasUUID = BIT(5), kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13)
}
 
enum  { kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kBitMask = 0x00ffffff }
 
enum  { kSingleKey = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) }
 
- Static Public Member Functions inherited from TObject
static Long_t GetDtorOnly ()
 Return destructor only flag. More...
 
static void SetDtorOnly (void *obj)
 Set destructor only flag. More...
 
static Bool_t GetObjectStat ()
 Get status of object stat flag. More...
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable. More...
 

#include <TBits.h>

Inheritance diagram for TBits:
[legend]

Constructor & Destructor Documentation

TBits::TBits ( UInt_t  nbits = 8)

Referenced by operator<<(), and operator>>().

TBits::TBits ( const TBits original)

TBits copy constructor.

Definition at line 42 of file TBits.cxx.

TBits::~TBits ( )
virtual

TBits destructor.

Definition at line 73 of file TBits.cxx.

Member Function Documentation

void TBits::Clear ( Option_t option = "")
virtual

Clear the value.

Reimplemented from TObject.

Definition at line 81 of file TBits.cxx.

Referenced by TLinearFitter::Clear().

void TBits::Compact ( )

Reduce the storage used by the object to a minimun.

Definition at line 92 of file TBits.cxx.

UInt_t TBits::CountBits ( UInt_t  startBit = 0) const

Return number of bits set to 1 starting at bit startBit.

Definition at line 115 of file TBits.cxx.

void TBits::DoAndEqual ( const TBits rhs)
protected

Execute (*this) &= rhs; Extra bits in rhs are ignored Missing bits in rhs are assumed to be zero.

Definition at line 162 of file TBits.cxx.

Referenced by operator&=().

void TBits::DoFlip ( )
protected

Execute ~(*this)

Definition at line 202 of file TBits.cxx.

Referenced by operator~().

void TBits::DoLeftShift ( UInt_t  shift)
protected

Execute the left shift operation.

Definition at line 213 of file TBits.cxx.

Referenced by operator<<=().

void TBits::DoOrEqual ( const TBits rhs)
protected

Execute (*this) &= rhs; Extra bits in rhs are ignored Missing bits in rhs are assumed to be zero.

Definition at line 178 of file TBits.cxx.

Referenced by operator|=().

void TBits::DoRightShift ( UInt_t  shift)
protected

Execute the left shift operation.

Definition at line 236 of file TBits.cxx.

Referenced by operator>>=().

void TBits::DoXorEqual ( const TBits rhs)
protected

Execute (*this) ^= rhs; Extra bits in rhs are ignored Missing bits in rhs are assumed to be zero.

Definition at line 191 of file TBits.cxx.

Referenced by operator^=().

UInt_t TBits::FirstNullBit ( UInt_t  startBit = 0) const

Return position of first null bit (starting from position 0 and up)

Definition at line 261 of file TBits.cxx.

Referenced by TProcessUUID::AddUUID().

UInt_t TBits::FirstSetBit ( UInt_t  startBit = 0) const

Return position of first non null bit (starting from position 0 and up)

Definition at line 345 of file TBits.cxx.

Referenced by operator==(), and TSelectorDraw::ProcessFillObject().

void TBits::Get ( Char_t array) const

Copy all the byes.

Definition at line 502 of file TBits.cxx.

void TBits::Get ( UChar_t array) const
inline

Definition at line 125 of file TBits.h.

Referenced by Get().

void TBits::Get ( Short_t array) const

Definition at line 619 of file TBits.cxx.

void TBits::Get ( UShort_t array) const
inline

Definition at line 127 of file TBits.h.

Referenced by Get().

void TBits::Get ( Int_t array) const

Definition at line 637 of file TBits.cxx.

void TBits::Get ( UInt_t array) const
inline

Definition at line 129 of file TBits.h.

Referenced by Get().

void TBits::Get ( Long64_t array) const

Definition at line 658 of file TBits.cxx.

void TBits::Get ( ULong64_t array) const
inline

Definition at line 131 of file TBits.h.

Referenced by Get().

UInt_t TBits::GetNbits ( ) const
inline

Definition at line 141 of file TBits.h.

Referenced by TSelectorDraw::ProcessFillObject().

UInt_t TBits::GetNbytes ( ) const
inline

Definition at line 142 of file TBits.h.

UInt_t TBits::LastNullBit ( UInt_t  startBit = 999999999) const

Return position of first null bit (starting from position 0 and up)

Definition at line 306 of file TBits.cxx.

UInt_t TBits::LastSetBit ( UInt_t  startBit = 999999999) const

Return position of first non null bit (starting from position 0 and up)

Definition at line 390 of file TBits.cxx.

Bool_t TBits::operator!= ( const TBits other) const
inline

Definition at line 145 of file TBits.h.

TBits& TBits::operator&= ( const TBits rhs)
inline

Definition at line 93 of file TBits.h.

TBits TBits::operator<< ( UInt_t  rhs)
inline

Definition at line 98 of file TBits.h.

TBits& TBits::operator<<= ( UInt_t  rhs)
inline

Definition at line 96 of file TBits.h.

TBits & TBits::operator= ( const TBits rhs)

TBits assignment operator.

Definition at line 53 of file TBits.cxx.

Bool_t TBits::operator== ( const TBits other) const

Definition at line 685 of file TBits.cxx.

TBits TBits::operator>> ( UInt_t  rhs)
inline

Definition at line 99 of file TBits.h.

TBits& TBits::operator>>= ( UInt_t  rhs)
inline

Definition at line 97 of file TBits.h.

TBits::TReference TBits::operator[] ( UInt_t  bitnumber)
inline

Definition at line 90 of file TBits.h.

Bool_t TBits::operator[] ( UInt_t  bitnumber) const
inline

Definition at line 241 of file TBits.h.

TBits& TBits::operator^= ( const TBits rhs)
inline

Definition at line 95 of file TBits.h.

TBits& TBits::operator|= ( const TBits rhs)
inline

Definition at line 94 of file TBits.h.

TBits TBits::operator~ ( )
inline

Definition at line 100 of file TBits.h.

void TBits::Output ( std::ostream &  os) const

Print the value to the std::ostream.

Definition at line 429 of file TBits.cxx.

Referenced by operator<<().

void TBits::Paint ( Option_t option = "")
virtual

Once implemented, it will draw the bit field as an histogram.

use the TVirtualPainter as the usual trick

Reimplemented from TObject.

Definition at line 444 of file TBits.cxx.

void TBits::Print ( Option_t option = "") const
virtual

Print the list of active bits.

Reimplemented from TObject.

Definition at line 451 of file TBits.cxx.

void TBits::ReserveBytes ( UInt_t  nbytes)
protected

Reverse each bytes.

Definition at line 475 of file TBits.cxx.

Referenced by Set().

void TBits::ResetAllBits ( Bool_t  value = kFALSE)

Reset all bits to 0 (false).

Definition at line 467 of file TBits.cxx.

Referenced by TMessage::WriteObject().

void TBits::ResetBitNumber ( UInt_t  bitnumber)
inline

Definition at line 236 of file TBits.h.

void TBits::Set ( UInt_t  nbits,
const Char_t array 
)

Set all the bytes.

Definition at line 489 of file TBits.cxx.

void TBits::Set ( UInt_t  nbits,
const UChar_t array 
)
inline

Definition at line 107 of file TBits.h.

Referenced by Set().

void TBits::Set ( UInt_t  nbits,
const Short_t array 
)

Definition at line 563 of file TBits.cxx.

void TBits::Set ( UInt_t  nbits,
const UShort_t array 
)
inline

Definition at line 109 of file TBits.h.

Referenced by Set().

void TBits::Set ( UInt_t  nbits,
const Int_t array 
)

Definition at line 579 of file TBits.cxx.

void TBits::Set ( UInt_t  nbits,
const UInt_t array 
)
inline

Definition at line 111 of file TBits.h.

Referenced by Set().

void TBits::Set ( UInt_t  nbits,
const Long64_t array 
)

Definition at line 597 of file TBits.cxx.

void TBits::Set ( UInt_t  nbits,
const ULong64_t array 
)
inline

Definition at line 113 of file TBits.h.

Referenced by Set().

void TBits::SetBitNumber ( UInt_t  bitnumber,
Bool_t  value = kTRUE 
)
inline
Bool_t TBits::TestBitNumber ( UInt_t  bitnumber) const
inline

Member Data Documentation

UChar_t* TBits::fAllBits
protected
UInt_t TBits::fNbits
protected
UInt_t TBits::fNbytes
protected
Collaboration diagram for TBits:
[legend]

The documentation for this class was generated from the following files: