Logo ROOT  
Reference Guide
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 26 of file TBits.h.

Classes

class  TReference
 

Public Member Functions

 TBits (const TBits &)
 TBits copy constructor. More...
 
 TBits (UInt_t nbits=8)
 TBits constructor. All bits set to 0. More...
 
virtual ~TBits ()
 TBits destructor. More...
 
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...
 
void Get (Char_t *array) const
 Copy all the byes. More...
 
void Get (Int_t *array) const
 
void Get (Long64_t *array) const
 
void Get (Short_t *array) const
 
void Get (UChar_t *array) const
 
void Get (UInt_t *array) const
 
void Get (ULong64_t *array) const
 
void Get (UShort_t *array) const
 
UInt_t GetNbits () const
 
UInt_t GetNbytes () const
 
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...
 
Bool_t operator!= (const TBits &other) const
 
TBitsoperator&= (const TBits &rhs)
 
TBits operator<< (UInt_t rhs)
 
TBitsoperator<<= (UInt_t rhs)
 
TBitsoperator= (const TBits &)
 TBits assignment operator. More...
 
Bool_t operator== (const TBits &other) const
 
TBits operator>> (UInt_t rhs)
 
TBitsoperator>>= (UInt_t rhs)
 
TBits::TReference operator[] (UInt_t bitnumber)
 
Bool_t operator[] (UInt_t bitnumber) const
 
TBitsoperator^= (const TBits &rhs)
 
TBitsoperator|= (const TBits &rhs)
 
TBits operator~ () const
 
void Output (std::ostream &) const
 Print the value to the std::ostream. More...
 
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 ResetAllBits (Bool_t value=kFALSE)
 Reset all bits to 0 (false). More...
 
void ResetBitNumber (UInt_t bitnumber)
 
void Set (UInt_t nbits, const Char_t *array)
 Set all the bytes. More...
 
void Set (UInt_t nbits, const Int_t *array)
 
void Set (UInt_t nbits, const Long64_t *array)
 
void Set (UInt_t nbits, const Short_t *array)
 
void Set (UInt_t nbits, const UChar_t *array)
 
void Set (UInt_t nbits, const UInt_t *array)
 
void Set (UInt_t nbits, const ULong64_t *array)
 
void Set (UInt_t nbits, const UShort_t *array)
 
void SetBitNumber (UInt_t bitnumber, Bool_t value=kTRUE)
 
Bool_t TestBitNumber (UInt_t bitnumber) const
 
- Public Member Functions inherited from TObject
 TObject ()
 TObject constructor. More...
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
virtual ~TObject ()
 TObject destructor. 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...
 
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...
 
ULong_t CheckedHash ()
 Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object. 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 selected pad for instance with: gROOT->SetSelectedPad(gPad). More...
 
virtual void Dump () const
 Dump contents of object on stdout. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. 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 void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. 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 const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
 
virtual Option_tGetOption () const
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual UInt_t GetUniqueID () const
 Return the unique object id. 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...
 
Bool_t HasInconsistentHash () const
 Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e. More...
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. 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...
 
void InvertBit (UInt_t f)
 
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 IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
 
R__ALWAYS_INLINE Bool_t IsOnHeap () const
 
virtual Bool_t IsSortable () const
 
R__ALWAYS_INLINE Bool_t IsZombie () const
 
virtual void ls (Option_t *option="") const
 The ls function lists the contents of a class on stdout. 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...
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. More...
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete. More...
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. More...
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz)
 
voidoperator new[] (size_t sz, void *vp)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator. 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...
 
void ResetBit (UInt_t f)
 
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...
 
void SetBit (UInt_t f)
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. 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 SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
R__ALWAYS_INLINE Bool_t TestBit (UInt_t f) const
 
Int_t TestBits (UInt_t f) const
 
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 void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. 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...
 

Protected Member Functions

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 DoFlip ()
 Execute ~(*this) More...
 
void DoLeftShift (UInt_t shift)
 Execute the left shift operation. 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 DoRightShift (UInt_t shift)
 Execute the left shift operation. 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 ReserveBytes (UInt_t nbytes)
 Reverse each bytes. More...
 
void Resize (UInt_t newlen)
 
- Protected Member Functions inherited from TObject
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected). More...
 
void MakeZombie ()
 

Protected Attributes

UChar_tfAllBits
 
UInt_t fNbits
 
UInt_t fNbytes
 

Additional Inherited Members

- Public Types inherited from TObject
enum  {
  kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kInconsistent = 0x08000000,
  kBitMask = 0x00ffffff
}
 
enum  { kSingleKey = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) }
 
enum  EDeprecatedStatusBits { kObjInCanvas = BIT(3) }
 
enum  EStatusBits {
  kCanDelete = BIT(0), kMustCleanup = BIT(3), kIsReferenced = BIT(4), kHasUUID = BIT(5),
  kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13)
}
 
- Static Public Member Functions inherited from TObject
static Long_t GetDtorOnly ()
 Return destructor only flag. More...
 
static Bool_t GetObjectStat ()
 Get status of object stat flag. More...
 
static void SetDtorOnly (void *obj)
 Set destructor only 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() [1/2]

TBits::TBits ( UInt_t  nbits = 8)

TBits constructor. All bits set to 0.

Definition at line 33 of file TBits.cxx.

◆ TBits() [2/2]

TBits::TBits ( const TBits original)

TBits copy constructor.

Definition at line 45 of file TBits.cxx.

◆ ~TBits()

TBits::~TBits ( )
virtual

TBits destructor.

Definition at line 76 of file TBits.cxx.

Member Function Documentation

◆ Clear()

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

Clear the value.

Reimplemented from TObject.

Definition at line 84 of file TBits.cxx.

◆ Compact()

void TBits::Compact ( )

Reduce the storage used by the object to a minimun.

Definition at line 95 of file TBits.cxx.

◆ CountBits()

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

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

Definition at line 118 of file TBits.cxx.

◆ DoAndEqual()

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 165 of file TBits.cxx.

◆ DoFlip()

void TBits::DoFlip ( )
protected

Execute ~(*this)

Definition at line 205 of file TBits.cxx.

◆ DoLeftShift()

void TBits::DoLeftShift ( UInt_t  shift)
protected

Execute the left shift operation.

Note: This does extent the number of bits (i.e. no data loss)

Definition at line 217 of file TBits.cxx.

◆ DoOrEqual()

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 181 of file TBits.cxx.

◆ DoRightShift()

void TBits::DoRightShift ( UInt_t  shift)
protected

Execute the left shift operation.

Definition at line 242 of file TBits.cxx.

◆ DoXorEqual()

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 194 of file TBits.cxx.

◆ FirstNullBit()

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

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

Definition at line 275 of file TBits.cxx.

◆ FirstSetBit()

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 359 of file TBits.cxx.

◆ Get() [1/8]

void TBits::Get ( Char_t array) const

Copy all the byes.

Definition at line 516 of file TBits.cxx.

◆ Get() [2/8]

void TBits::Get ( Int_t array) const

Definition at line 651 of file TBits.cxx.

◆ Get() [3/8]

void TBits::Get ( Long64_t array) const

Definition at line 672 of file TBits.cxx.

◆ Get() [4/8]

void TBits::Get ( Short_t array) const

Definition at line 633 of file TBits.cxx.

◆ Get() [5/8]

void TBits::Get ( UChar_t array) const
inline

Definition at line 117 of file TBits.h.

◆ Get() [6/8]

void TBits::Get ( UInt_t array) const
inline

Definition at line 121 of file TBits.h.

◆ Get() [7/8]

void TBits::Get ( ULong64_t array) const
inline

Definition at line 123 of file TBits.h.

◆ Get() [8/8]

void TBits::Get ( UShort_t array) const
inline

Definition at line 119 of file TBits.h.

◆ GetNbits()

UInt_t TBits::GetNbits ( ) const
inline

Definition at line 133 of file TBits.h.

◆ GetNbytes()

UInt_t TBits::GetNbytes ( ) const
inline

Definition at line 134 of file TBits.h.

◆ LastNullBit()

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

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

Definition at line 320 of file TBits.cxx.

◆ LastSetBit()

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 404 of file TBits.cxx.

◆ operator!=()

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

Definition at line 137 of file TBits.h.

◆ operator&=()

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

Definition at line 85 of file TBits.h.

◆ operator<<()

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

Definition at line 90 of file TBits.h.

◆ operator<<=()

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

Definition at line 88 of file TBits.h.

◆ operator=()

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

TBits assignment operator.

Definition at line 56 of file TBits.cxx.

◆ operator==()

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

Definition at line 699 of file TBits.cxx.

◆ operator>>()

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

Definition at line 91 of file TBits.h.

◆ operator>>=()

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

Definition at line 89 of file TBits.h.

◆ operator[]() [1/2]

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

Definition at line 82 of file TBits.h.

◆ operator[]() [2/2]

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

Definition at line 239 of file TBits.h.

◆ operator^=()

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

Definition at line 87 of file TBits.h.

◆ operator|=()

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

Definition at line 86 of file TBits.h.

◆ operator~()

TBits TBits::operator~ ( ) const
inline

Definition at line 92 of file TBits.h.

◆ Output()

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

Print the value to the std::ostream.

Definition at line 443 of file TBits.cxx.

◆ Paint()

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 458 of file TBits.cxx.

◆ Print()

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

Print the list of active bits.

Reimplemented from TObject.

Definition at line 465 of file TBits.cxx.

◆ ReserveBytes()

void TBits::ReserveBytes ( UInt_t  nbytes)
protected

Reverse each bytes.

Definition at line 489 of file TBits.cxx.

◆ ResetAllBits()

void TBits::ResetAllBits ( Bool_t  value = kFALSE)

Reset all bits to 0 (false).

Definition at line 481 of file TBits.cxx.

◆ ResetBitNumber()

void TBits::ResetBitNumber ( UInt_t  bitnumber)
inline

Definition at line 234 of file TBits.h.

◆ Resize()

void TBits::Resize ( UInt_t  newlen)
inlineprotected

Definition at line 190 of file TBits.h.

◆ Set() [1/8]

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

Set all the bytes.

Definition at line 503 of file TBits.cxx.

◆ Set() [2/8]

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

Definition at line 593 of file TBits.cxx.

◆ Set() [3/8]

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

Definition at line 611 of file TBits.cxx.

◆ Set() [4/8]

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

Definition at line 577 of file TBits.cxx.

◆ Set() [5/8]

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

Definition at line 99 of file TBits.h.

◆ Set() [6/8]

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

Definition at line 103 of file TBits.h.

◆ Set() [7/8]

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

Definition at line 105 of file TBits.h.

◆ Set() [8/8]

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

Definition at line 101 of file TBits.h.

◆ SetBitNumber()

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

Definition at line 205 of file TBits.h.

◆ TestBitNumber()

Bool_t TBits::TestBitNumber ( UInt_t  bitnumber) const
inline

Definition at line 221 of file TBits.h.

Member Data Documentation

◆ fAllBits

UChar_t* TBits::fAllBits
protected

Definition at line 32 of file TBits.h.

◆ fNbits

UInt_t TBits::fNbits
protected

Definition at line 30 of file TBits.h.

◆ fNbytes

UInt_t TBits::fNbytes
protected

Definition at line 31 of file TBits.h.


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