Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
ROOT::Detail::TSchemaRuleSet Class Reference

Definition at line 24 of file TSchemaRuleSet.h.

Classes

class  TMatches
 

Public Types

enum  EConsistencyCheck { kNoCheck = 0 , kCheckAll = 1 , kCheckConflict = 2 }
 
- Public Types inherited from TObject
enum  {
  kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 ,
  kBitMask = 0x00ffffff
}
 
enum  { kSingleKey = (1ULL << ( 0 )) , kOverwrite = (1ULL << ( 1 )) , kWriteDelete = (1ULL << ( 2 )) }
 
enum  EDeprecatedStatusBits { kObjInCanvas = (1ULL << ( 3 )) }
 
enum  EStatusBits {
  kCanDelete = (1ULL << ( 0 )) , kMustCleanup = (1ULL << ( 3 )) , kIsReferenced = (1ULL << ( 4 )) , kHasUUID = (1ULL << ( 5 )) ,
  kCannotPick = (1ULL << ( 6 )) , kNoContextMenu = (1ULL << ( 8 )) , kInvalidObject = (1ULL << ( 13 ))
}
 

Public Member Functions

 TSchemaRuleSet ()
 Default constructor.
 
virtual ~TSchemaRuleSet ()
 Destructor.
 
Bool_t AddRule (TSchemaRule *rule, EConsistencyCheck checkConsistency=kCheckAll, TString *errmsg=nullptr)
 The consistency check always fails if the TClass object was not set! if checkConsistency is: kNoCheck: no check is done, register the rule as is kCheckConflict: check only for conflicting rules kCheckAll: check for conflict and check for rule about members that are not in the current class layout.
 
Bool_t AddRules (TSchemaRuleSet *rules, EConsistencyCheck checkConsistency=kCheckAll, TString *errmsg=nullptr)
 
void AsString (TString &out) const
 Fill the string 'out' with the string representation of the rule.
 
const TMatches FindRules (const TString &source) const
 Return all the rules that are about the given 'source' class.
 
const TMatches FindRules (const TString &source, Int_t version) const
 Return all the rules that applies to the specified version of the given 'source' class.
 
const TMatches FindRules (const TString &source, Int_t version, UInt_t checksum) const
 Return all the rules that applies to the specified version OR checksum of the given 'source' class.
 
const TMatches FindRules (const TString &source, UInt_t checksum) const
 Return all the rules that applies to the specified checksum of the given 'source' class.
 
TClassGetClass ()
 
UInt_t GetClassCheckSum () const
 
TString GetClassName () const
 
Int_t GetClassVersion () const
 
const TObjArrayGetPersistentRules () const
 
const TObjArrayGetRules () const
 
Bool_t HasRuleWithSourceClass (const TString &source) const
 Return True if we have any rule whose source class is 'source'.
 
TClassIsA () const override
 
void ls (Option_t *option="") const override
 The ls function lists the contents of a class on stdout.
 
void RemoveRule (TSchemaRule *rule)
 Remove given rule from the set - the rule is not being deleted!
 
void RemoveRules (TObjArray *rules)
 remove given array of rules from the set - the rules are not being deleted!
 
void SetClass (TClass *cls)
 Set the TClass associated with this rule set.
 
void Streamer (TBuffer &) override
 Stream an object of class ROOT::TSchemaRuleSet.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
- Public Member Functions inherited from TObject
 TObject ()
 TObject constructor.
 
 TObject (const TObject &object)
 TObject copy ctor.
 
virtual ~TObject ()
 TObject destructor.
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract.
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad.
 
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action.
 
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.
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs.
 
virtual void Clear (Option_t *="")
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility.
 
virtual Int_t Compare (const TObject *obj) const
 Compare abstract method.
 
virtual void Copy (TObject &object) const
 Copy this to obj.
 
virtual void Delete (Option_t *option="")
 Delete this object.
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object.
 
virtual void Draw (Option_t *option="")
 Default Draw method for all objects.
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs.
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad with: gROOT->SetSelectedPad(c1).
 
virtual void Dump () const
 Dump contents of object on stdout.
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message.
 
virtual void Execute (const char *method, const char *params, Int_t *error=nullptr)
 Execute method on this object with the given parameter string, e.g.
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=nullptr)
 Execute method on this object with parameters stored in the TObjArray.
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py).
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message.
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes.
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes.
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object.
 
virtual const char * GetIconName () const
 Returns mime type name of object.
 
virtual const char * GetName () const
 Returns name of object.
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py).
 
virtual Option_tGetOption () const
 
virtual const char * GetTitle () const
 Returns title of object.
 
virtual UInt_t GetUniqueID () const
 Return the unique object id.
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out.
 
virtual ULong_t Hash () const
 Return hash value for this object.
 
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.
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message.
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname".
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl.
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas.
 
void InvertBit (UInt_t f)
 
Bool_t IsDestructed () const
 IsDestructed.
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory).
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).
 
R__ALWAYS_INLINE Bool_t IsOnHeap () const
 
virtual Bool_t IsSortable () const
 
R__ALWAYS_INLINE Bool_t IsZombie () const
 
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).
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification (the base implementation is no-op).
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete.
 
void operator delete (void *ptr)
 Operator delete.
 
void operator delete (void *ptr, void *vp)
 Only called by placement new when throwing an exception.
 
void operator delete[] (void *ptr)
 Operator delete [].
 
void operator delete[] (void *ptr, void *vp)
 Only called by placement new[] when throwing an exception.
 
void * operator new (size_t sz)
 
void * operator new (size_t sz, void *vp)
 
void * operator new[] (size_t sz)
 
void * operator new[] (size_t sz, void *vp)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator.
 
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself.
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list.
 
virtual void Print (Option_t *option="") const
 This method must be overridden when a class wants to print itself.
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory.
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list.
 
void ResetBit (UInt_t f)
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename.
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out".
 
void SetBit (UInt_t f)
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f.
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object.
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message.
 
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.
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message.
 
virtual Int_t Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory.
 
virtual Int_t Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory.
 

Static Public Member Functions

static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
- Static Public Member Functions inherited from TObject
static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
static Longptr_t GetDtorOnly ()
 Return destructor only flag.
 
static Bool_t GetObjectStat ()
 Get status of object stat flag.
 
static void SetDtorOnly (void *obj)
 Set destructor only flag.
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable.
 

Private Attributes

TObjArrayfAllRules
 Array of non-persistent rules - just for cleanup purposes - owns the elements.
 
UInt_t fCheckSum
 
TClassRef fClass
 Array of all rules.
 
TString fClassName
 Target class pointer (for consistency checking)
 
TObjArrayfPersistentRules
 
TObjArrayfRemainingRules
 
Int_t fVersion
 

Additional Inherited Members

- Protected Types inherited from TObject
enum  { kOnlyPrepStep = (1ULL << ( 3 )) }
 
- 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).
 
void MakeZombie ()
 

#include <TSchemaRuleSet.h>

Inheritance diagram for ROOT::Detail::TSchemaRuleSet:
[legend]

Member Enumeration Documentation

◆ EConsistencyCheck

Enumerator
kNoCheck 
kCheckAll 
kCheckConflict 

Definition at line 38 of file TSchemaRuleSet.h.

Constructor & Destructor Documentation

◆ TSchemaRuleSet()

TSchemaRuleSet::TSchemaRuleSet ( )

Default constructor.

Definition at line 28 of file TSchemaRuleSet.cxx.

◆ ~TSchemaRuleSet()

TSchemaRuleSet::~TSchemaRuleSet ( )
virtual

Destructor.

Definition at line 40 of file TSchemaRuleSet.cxx.

Member Function Documentation

◆ AddRule()

Bool_t TSchemaRuleSet::AddRule ( TSchemaRule rule,
EConsistencyCheck  checkConsistency = kCheckAll,
TString errmsg = nullptr 
)

The consistency check always fails if the TClass object was not set! if checkConsistency is: kNoCheck: no check is done, register the rule as is kCheckConflict: check only for conflicting rules kCheckAll: check for conflict and check for rule about members that are not in the current class layout.

return kTRUE if the layout is accepted, in which case we take ownership of the rule object. return kFALSE if the rule failed one of the test, the rule now needs to be deleted by the caller.

Definition at line 81 of file TSchemaRuleSet.cxx.

◆ AddRules()

Bool_t TSchemaRuleSet::AddRules ( TSchemaRuleSet rules,
EConsistencyCheck  checkConsistency = kCheckAll,
TString errmsg = nullptr 
)

Definition at line 66 of file TSchemaRuleSet.cxx.

◆ AsString()

void TSchemaRuleSet::AsString ( TString out) const

Fill the string 'out' with the string representation of the rule.

Definition at line 186 of file TSchemaRuleSet.cxx.

◆ Class()

static TClass * ROOT::Detail::TSchemaRuleSet::Class ( )
static
Returns
TClass describing this class

◆ Class_Name()

static const char * ROOT::Detail::TSchemaRuleSet::Class_Name ( )
static
Returns
Name of this class

◆ Class_Version()

static constexpr Version_t ROOT::Detail::TSchemaRuleSet::Class_Version ( )
inlinestaticconstexpr
Returns
Version of this class

Definition at line 76 of file TSchemaRuleSet.h.

◆ DeclFileName()

static const char * ROOT::Detail::TSchemaRuleSet::DeclFileName ( )
inlinestatic
Returns
Name of the file containing the class declaration

Definition at line 76 of file TSchemaRuleSet.h.

◆ FindRules() [1/4]

const TSchemaRuleSet::TMatches TSchemaRuleSet::FindRules ( const TString source) const

Return all the rules that are about the given 'source' class.

User has to delete the returned array

Definition at line 289 of file TSchemaRuleSet.cxx.

◆ FindRules() [2/4]

const TSchemaRuleSet::TMatches TSchemaRuleSet::FindRules ( const TString source,
Int_t  version 
) const

Return all the rules that applies to the specified version of the given 'source' class.

User has to delete the returned array

Definition at line 328 of file TSchemaRuleSet.cxx.

◆ FindRules() [3/4]

const TSchemaRuleSet::TMatches TSchemaRuleSet::FindRules ( const TString source,
Int_t  version,
UInt_t  checksum 
) const

Return all the rules that applies to the specified version OR checksum of the given 'source' class.

User has to delete the returned array

Definition at line 368 of file TSchemaRuleSet.cxx.

◆ FindRules() [4/4]

const TSchemaRuleSet::TMatches TSchemaRuleSet::FindRules ( const TString source,
UInt_t  checksum 
) const

Return all the rules that applies to the specified checksum of the given 'source' class.

User has to delete the returned array

Definition at line 348 of file TSchemaRuleSet.cxx.

◆ GetClass()

TClass * TSchemaRuleSet::GetClass ( )

Definition at line 386 of file TSchemaRuleSet.cxx.

◆ GetClassCheckSum()

UInt_t TSchemaRuleSet::GetClassCheckSum ( ) const

Definition at line 393 of file TSchemaRuleSet.cxx.

◆ GetClassName()

TString TSchemaRuleSet::GetClassName ( ) const

Definition at line 403 of file TSchemaRuleSet.cxx.

◆ GetClassVersion()

Int_t TSchemaRuleSet::GetClassVersion ( ) const

Definition at line 410 of file TSchemaRuleSet.cxx.

◆ GetPersistentRules()

const TObjArray * TSchemaRuleSet::GetPersistentRules ( ) const

Definition at line 424 of file TSchemaRuleSet.cxx.

◆ GetRules()

const TObjArray * TSchemaRuleSet::GetRules ( ) const

Definition at line 417 of file TSchemaRuleSet.cxx.

◆ HasRuleWithSourceClass()

Bool_t TSchemaRuleSet::HasRuleWithSourceClass ( const TString source) const

Return True if we have any rule whose source class is 'source'.

Definition at line 199 of file TSchemaRuleSet.cxx.

◆ IsA()

TClass * ROOT::Detail::TSchemaRuleSet::IsA ( ) const
inlineoverridevirtual
Returns
TClass describing current object

Reimplemented from TObject.

Definition at line 76 of file TSchemaRuleSet.h.

◆ ls()

void TSchemaRuleSet::ls ( Option_t option = "") const
overridevirtual

The ls function lists the contents of a class on stdout.

Ls output is typically much less verbose then Dump().

Reimplemented from TObject.

Definition at line 51 of file TSchemaRuleSet.cxx.

◆ RemoveRule()

void TSchemaRuleSet::RemoveRule ( TSchemaRule rule)

Remove given rule from the set - the rule is not being deleted!

Definition at line 432 of file TSchemaRuleSet.cxx.

◆ RemoveRules()

void TSchemaRuleSet::RemoveRules ( TObjArray rules)

remove given array of rules from the set - the rules are not being deleted!

Definition at line 442 of file TSchemaRuleSet.cxx.

◆ SetClass()

void TSchemaRuleSet::SetClass ( TClass cls)

Set the TClass associated with this rule set.

Definition at line 457 of file TSchemaRuleSet.cxx.

◆ Streamer()

void TSchemaRuleSet::Streamer ( TBuffer R__b)
overridevirtual

Stream an object of class ROOT::TSchemaRuleSet.

Reimplemented from TObject.

Definition at line 555 of file TSchemaRuleSet.cxx.

◆ StreamerNVirtual()

void ROOT::Detail::TSchemaRuleSet::StreamerNVirtual ( TBuffer ClassDef_StreamerNVirtual_b)
inline

Definition at line 76 of file TSchemaRuleSet.h.

Member Data Documentation

◆ fAllRules

TObjArray* ROOT::Detail::TSchemaRuleSet::fAllRules
private

Array of non-persistent rules - just for cleanup purposes - owns the elements.

Definition at line 70 of file TSchemaRuleSet.h.

◆ fCheckSum

UInt_t ROOT::Detail::TSchemaRuleSet::fCheckSum
private

Definition at line 74 of file TSchemaRuleSet.h.

◆ fClass

TClassRef ROOT::Detail::TSchemaRuleSet::fClass
private

Array of all rules.

Definition at line 71 of file TSchemaRuleSet.h.

◆ fClassName

TString ROOT::Detail::TSchemaRuleSet::fClassName
private

Target class pointer (for consistency checking)

Definition at line 72 of file TSchemaRuleSet.h.

◆ fPersistentRules

TObjArray* ROOT::Detail::TSchemaRuleSet::fPersistentRules
private

Definition at line 68 of file TSchemaRuleSet.h.

◆ fRemainingRules

TObjArray* ROOT::Detail::TSchemaRuleSet::fRemainingRules
private

Definition at line 69 of file TSchemaRuleSet.h.

◆ fVersion

Int_t ROOT::Detail::TSchemaRuleSet::fVersion
private

Definition at line 73 of file TSchemaRuleSet.h.

Libraries for ROOT::Detail::TSchemaRuleSet:

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