JROOT::JRootClass Struct Reference

Auxiliary class to manage access to base classes and data members of ROOT class. More...

#include <JRootClass.hh>

Inheritance diagram for JROOT::JRootClass:

Public Member Functions
template<class JType_t >
	JRootClass (const JType< JType_t > &type)
	Constructor.
template<class JType_t , class JClass_t >
	JRootClass (JType_t JClass_t::*pd)
	Constructor.
TDictionary *	getDictionary () const
	Get dictionary.
int	getOffset () const
	Get offset of this class with respect to parent class.
TClass *	getClass () const
	Get class.
const char *	getTypename () const
	Get type name.
bool	is_valid () const
	Check validity of this class.
bool	equals (const JRootClass &object) const
	Test equality of ROOT classes.
JRootClass	find (const char *const name, const bool option=true) const
	Find base class or data member with given name within current class.
JRootClass	get (const TDataMember &data_member) const
	Get ROOT class of given data member.
JRootClass	get (const TBaseClass &base_class) const
	Get ROOT class of given base class.
void	print (std::ostream &out) const
	Print ROOT class information.

Static Public Member Functions
static bool	is_class (const char *const name)
	Check name of class against ROOT classes.
static bool	is_class (const TBaseClass &base_class)
	Check base class against ROOT class names.
static bool	is_class (const TDataMember &data_member)
	Check data member against ROOT class names.
static bool	is_STLcontainer (const TBaseClass &base_class)
	Check if base class is STL container.
static bool	is_STLcontainer (const TDataMember &data_member)
	Check if data member is STL container.
static bool	is_STLstring (const TDataMember &data_member)
	Check if data member is STL string.
static bool	is_static (const TDataMember &data_member)
	Check if data member is static.
static bool	is_tobject_member (const char *name)
	Check if name is one of TObject own data members (fBits or fUniqueID, for Root <= 6.30.04 at least)

Protected Member Functions
	JRootClass ()
	Default constructor.
	JRootClass (TDictionary *dictionary, int offset)
	Constructor.
void	print (std::ostream &out, const std::string &prefix) const
	Print ROOT class information.

Static Protected Member Functions
static void	print (std::ostream &out, const std::string &name, const std::string &type)
	Print ROOT class information.

Protected Attributes
TDictionary *	dictionary
	pointer to ROOT dictionary
int	offset
	offset with respect to data structure [B]

Detailed Description

Auxiliary class to manage access to base classes and data members of ROOT class.

Definition at line 41 of file JRootClass.hh.

Constructor & Destructor Documentation

JRootClass() [1/4]

template<class JType_t >

JROOT::JRootClass::JRootClass ( const JType< JType_t > & type )

inline

Constructor.

Parameters

type

data type

Definition at line 149 of file JRootClass.hh.

                                           :
      dictionary(TDictionary::GetDictionary(typeid(JType_t))),
      offset(0)
    {}

JRootClass() [2/4]

template<class JType_t , class JClass_t >

JROOT::JRootClass::JRootClass ( JType_t JClass_t::* pd )

inline

Constructor.

Parameters

pd	pointer to C++ data member

Definition at line 161 of file JRootClass.hh.

                                    :
      dictionary(TDictionary::GetDictionary(typeid(JType_t))),
      offset((char*) &(((JClass_t*) NULL)->*pd) - (char*) NULL)
    {}

JRootClass() [3/4]

JROOT::JRootClass::JRootClass ( )

inlineprotected

Default constructor.

Definition at line 333 of file JRootClass.hh.

                 :
      dictionary(NULL),
      offset(0)
    {}

JRootClass() [4/4]

JROOT::JRootClass::JRootClass ( TDictionary * dictionary, int offset )

inlineprotected

Constructor.

Parameters

dictionary	pointer to dictionary
offset	offset

Definition at line 345 of file JRootClass.hh.

                                    :
      dictionary(dictionary),
      offset    (offset)
    {}

Member Function Documentation

is_class() [1/3]

static bool JROOT::JRootClass::is_class ( const char *const name )

inlinestatic

Check name of class against ROOT classes.

Parameters

name	name of class

Returns

true if name of class corresponds to genuine class; else false

Definition at line 50 of file JRootClass.hh.

    {
      return (name                                      != NULL  &&
              strcmp(name, TClass ::Class()->GetName()) != 0     &&
              strcmp(name, TObject::Class()->GetName()) != 0     &&
              strcmp(name, "_Rb_tree_node_base")        != 0     &&
              strcmp(name, "fgIsA")                     != 0     &&
              strcmp(name, "atomic<TClass*>")           != 0);
    }

is_class() [2/3]

static bool JROOT::JRootClass::is_class ( const TBaseClass & base_class )

inlinestatic

Check base class against ROOT class names.

Parameters

base_class

base class

Returns

true if valid class name; else false

Definition at line 67 of file JRootClass.hh.

    {
      return is_class(base_class.GetName());
    }

is_class() [3/3]

static bool JROOT::JRootClass::is_class ( const TDataMember & data_member )

inlinestatic

Check data member against ROOT class names.

Parameters

data_member

data member

Returns

true if valid class name; else false

Definition at line 79 of file JRootClass.hh.

    {
      return is_class(data_member.GetTypeName());
    }

is_STLcontainer() [1/2]

static bool JROOT::JRootClass::is_STLcontainer ( const TBaseClass & base_class )

inlinestatic

Check if base class is STL container.

Parameters

base_class

base class

Returns

true if STL congtainer; else false

Definition at line 91 of file JRootClass.hh.

    {
      return (const_cast<TBaseClass&>(base_class).IsSTLContainer() != ROOT::kNotSTL);
    }

is_STLcontainer() [2/2]

static bool JROOT::JRootClass::is_STLcontainer ( const TDataMember & data_member )

inlinestatic

Check if data member is STL container.

Parameters

data_member

data member

Returns

true if STL congtainer; else false

Definition at line 103 of file JRootClass.hh.

    {
      return (const_cast<TDataMember&>(data_member).IsSTLContainer() != ROOT::kNotSTL);
    }

is_STLstring()

static bool JROOT::JRootClass::is_STLstring ( const TDataMember & data_member )

inlinestatic

Check if data member is STL string.

Parameters

data_member

data member

Returns

true if STL string; else false

Definition at line 115 of file JRootClass.hh.

    {
      return (strcmp(data_member.GetFullTypeName(), "string")       == 0 ||
              strcmp(data_member.GetFullTypeName(), "const string") == 0);
    }

is_static()

static bool JROOT::JRootClass::is_static ( const TDataMember & data_member )

inlinestatic

Check if data member is static.

Parameters

data_member

data member

Returns

true if static; else false

Definition at line 128 of file JRootClass.hh.

    {
      return (data_member.Property() & kIsStatic);
    }

is_tobject_member()

static bool JROOT::JRootClass::is_tobject_member ( const char * name )

inlinestatic

Check if name is one of TObject own data members (fBits or fUniqueID, for Root <= 6.30.04 at least)

Definition at line 138 of file JRootClass.hh.

    {
      TClass* o_class = TClass::GetClass<TObject>();
      return o_class->GetListOfRealData()->FindObject(name) != nullptr;
    }

getDictionary()

TDictionary * JROOT::JRootClass::getDictionary ( ) const

inline

Get dictionary.

Returns

pointer to dictionary

Definition at line 172 of file JRootClass.hh.

    {
      return dictionary;
    }

getOffset()

int JROOT::JRootClass::getOffset ( ) const

inline

Get offset of this class with respect to parent class.

Returns

offset

Definition at line 183 of file JRootClass.hh.

    {
      return offset;
    }

getClass()

TClass * JROOT::JRootClass::getClass ( ) const

inline

Get class.

Returns

pointer to class

Definition at line 194 of file JRootClass.hh.

    {
      return dynamic_cast<TClass*>(dictionary);
    }

getTypename()

const char * JROOT::JRootClass::getTypename ( ) const

inline

Get type name.

Returns

type name

Definition at line 205 of file JRootClass.hh.

    {
      if (dictionary != NULL)
        return dictionary->GetName();
      else
        return NULL;
    }

is_valid()

bool JROOT::JRootClass::is_valid ( ) const

inline

Check validity of this class.

Returns

true if valid class; else false

Definition at line 219 of file JRootClass.hh.

    {
      return (this->getDictionary() != NULL && is_class(this->getTypename()));
    }

equals()

bool JROOT::JRootClass::equals ( const JRootClass & object ) const

inline

Test equality of ROOT classes.

Parameters

object

ROOT class

Returns

true if both ROOT classes are same type; else false

Definition at line 231 of file JRootClass.hh.

    {
      return (this-> getTypename() != NULL &&
              object.getTypename() != NULL &&
              strcmp(this->getTypename(), object.getTypename()) == 0);
    }

find()

JRootClass JROOT::JRootClass::find ( const char *const name, const bool option = true ) const

inline

Find base class or data member with given name within current class.

Parameters

name	name of base class or data member
option	case sensitivity

Returns

ROOT class

Definition at line 246 of file JRootClass.hh.

    {
      if (name != NULL && strlen(name) != 0) {
 
        if (strcmp(getTypename(), name) == 0) {
          return *this;
        }
 
        if (this->getClass() != NULL) {
 
          // check for data member
          
          for (std::unique_ptr<TIterator> i(this->getClass()->GetListOfDataMembers(kFALSE)->MakeIterator()); const TDataMember* p = (const TDataMember*) i->Next(); ) {
            if (( option  &&  strcmp    (p->GetName(), name) == 0) ||
                (!option  &&  strcasecmp(p->GetName(), name) == 0)) { 
              return this->get(*p);
            }
          }
          
          // check for base classes
          
          for (std::unique_ptr<TIterator> i(this->getClass()->GetListOfBases()->MakeIterator()); TBaseClass* p = (TBaseClass*) i->Next(); ) {
            
            if (is_class(*p) && !is_STLcontainer(*p)) {
              
              JRootClass rcs = this->get(*p);
 
              rcs = rcs.find(name);
              
              if (rcs.is_valid()) {
                return rcs;
              }
            }
          }
        }
      }
 
      return JRootClass();  // invalid value
    }

get() [1/2]

JRootClass JROOT::JRootClass::get ( const TDataMember & data_member ) const

inline

Get ROOT class of given data member.

Parameters

data_member

data member

Returns

ROOT class

Definition at line 293 of file JRootClass.hh.

    {
      return JRootClass(TDictionary::GetDictionary(data_member.GetTypeName()), 
                        this->getOffset() + data_member.GetOffset());
    }

get() [2/2]

JRootClass JROOT::JRootClass::get ( const TBaseClass & base_class ) const

inline

Get ROOT class of given base class.

Parameters

base_class

base class

Returns

ROOT class

Definition at line 306 of file JRootClass.hh.

    {
      return JRootClass(TDictionary::GetDictionary(base_class.GetName()),
                        this->getOffset() + const_cast<TBaseClass&>(base_class).GetDelta());
    }

print() [1/3]

void JROOT::JRootClass::print ( std::ostream & out ) const

inline

Print ROOT class information.

Parameters

out	output stream

Definition at line 318 of file JRootClass.hh.

    {
      print(out, getTypename());
    }

print() [2/3]

void JROOT::JRootClass::print ( std::ostream & out, const std::string & prefix ) const

inlineprotected

Print ROOT class information.

Parameters

out	output stream
prefix	prefix

Definition at line 358 of file JRootClass.hh.

    {
      if (this->is_valid()) {
 
        print(out, prefix, this->getTypename());
 
        if (this->getClass() != NULL) {
 
          if (this->getClass()->GetListOfBases() != NULL) {
          
            for (std::unique_ptr<TIterator> i(this->getClass()->GetListOfBases()->MakeIterator()); const TBaseClass* p = (const TBaseClass*) i->Next(); ) {
              if (!is_STLcontainer(*p))
                this->get(*p).print(out, prefix + "::" + p->GetName());
              else
                print(out, prefix + "::" + p->GetName(), this->get(*p).getTypename());
            }
          }
          
          if (this->getClass()->GetListOfDataMembers(kFALSE) != NULL) {
            
            for (std::unique_ptr<TIterator> i(this->getClass()->GetListOfDataMembers(kFALSE)->MakeIterator()); const TDataMember* p = (const TDataMember*) i->Next(); ) {
              if (!is_STLstring(*p) && !is_STLcontainer(*p))
                this->get(*p).print(out, prefix + (is_static(*p) ?  "::" : ".") + p->GetName());
              else
                print(out, prefix + (is_static(*p) ?  "::" : ".") + p->GetName(), this->get(*p).getTypename());
            }
          }
        }
      }
    }

print() [3/3]

static void JROOT::JRootClass::print ( std::ostream & out, const std::string & name, const std::string & type )

inlinestaticprotected

Print ROOT class information.

Parameters

out	output stream
name	name
type	type

Definition at line 397 of file JRootClass.hh.

    {
      using namespace std; 
 
      out << name << "  " << '(' << type << ')' << endl;
    }

Member Data Documentation

dictionary

TDictionary* JROOT::JRootClass::dictionary

protected

pointer to ROOT dictionary

Definition at line 326 of file JRootClass.hh.

offset

int JROOT::JRootClass::offset

protected

offset with respect to data structure [B]

Definition at line 327 of file JRootClass.hh.

---

The documentation for this struct was generated from the following file:

• JRootClass.hh