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 T >
	JRootClass (const JType< T > &type)
	Constructor. More...
TDictionary *	getDictionary () const
	Get dictionary. More...
int	getOffset () const
	Get offset of this class with respect to parent class. More...
TClass *	getClass () const
	Get class. More...
const char *	getTypename () const
	Get type name. More...
bool	is_valid () const
	Check validity of this class. More...
JRootClass	find (const char *name) const
	Find base class or data member with given name within current class. More...
JRootClass	get (const TDataMember &data_member) const
	Get ROOT class of given data member. More...
JRootClass	get (const TBaseClass &base_class) const
	Get ROOT class of given base class. More...
void	print (std::ostream &out) const
	Print ROOT class information. More...

Static Public Member Functions
static bool	is_class (const char *const class_name)
	Check class name against ROOT class names. More...
static bool	is_class (const TBaseClass &base_class)
	Check base class against ROOT class names. More...
static bool	is_class (const TDataMember &data_member)
	Check data member against ROOT class names. More...
static bool	is_STLcontainer (const TBaseClass &base_class)
	Check if base class is STL container. More...
static bool	is_STLcontainer (const TDataMember &data_member)
	Check if data member is STL container. More...
static bool	is_STLstring (const TDataMember &data_member)
	Check if data member is STL string. More...
static bool	is_static (const TDataMember &data_member)
	Check if data member is static. More...

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

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

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

Friends
bool	operator== (const JRootClass &first, const JRootClass &second)
	Test equality of ROOT classes. More...

Detailed Description

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

Definition at line 38 of file JRootClass.hh.

Constructor & Destructor Documentation

template<class T >

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

inline

Constructor.

Parameters

type

data type

Definition at line 134 of file JRootClass.hh.

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

JROOT::JRootClass::JRootClass ( )

inlineprotected

Default constructor.

Definition at line 305 of file JRootClass.hh.

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

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

inlineprotected

Constructor.

Parameters

dictionary	pointer to dictionary
offset	offset

Definition at line 317 of file JRootClass.hh.

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

Member Function Documentation

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

inlinestatic

Check class name against ROOT class names.

Parameters

class_name

class name

Returns

true if valid class name; else false

Definition at line 45 of file JRootClass.hh.

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

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 61 of file JRootClass.hh.

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

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 73 of file JRootClass.hh.

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

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 85 of file JRootClass.hh.

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

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 97 of file JRootClass.hh.

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

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 109 of file JRootClass.hh.

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

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 122 of file JRootClass.hh.

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

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

inline

Get dictionary.

Returns

pointer to dictionary

Definition at line 145 of file JRootClass.hh.

    {
      return dictionary;
    }

int JROOT::JRootClass::getOffset ( ) const

inline

Get offset of this class with respect to parent class.

Returns

offset

Definition at line 156 of file JRootClass.hh.

    {
      return offset;
    }

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

inline

Get class.

Returns

pointer to class

Definition at line 167 of file JRootClass.hh.

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

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

inline

Get type name.

Returns

type name

Definition at line 178 of file JRootClass.hh.

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

bool JROOT::JRootClass::is_valid ( ) const

inline

Check validity of this class.

Returns

true if valid class; else false

Definition at line 192 of file JRootClass.hh.

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

JRootClass JROOT::JRootClass::find ( const char *  name ) const

inline

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

Parameters

name	name of base class or data member

Definition at line 219 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
          
          const TDataMember* p = this->getClass()->GetDataMember(name);
         
          if (p != NULL) {
            return this->get(*p);
          }
          
          // check for base classes
          
          TIterator* i = this->getClass()->GetListOfBases()->MakeIterator();
          
          for (TBaseClass* p; (p = (TBaseClass*) i->Next()) != NULL; ) {
            
            if (is_class(*p) && !is_STLcontainer(*p)) {
              
              JRootClass cls = this->get(*p);

              cls = cls.find(name);
              
              if (cls.is_valid()) {
                return cls;
              }
            }
          }
        }
      }

      return JRootClass();  // invalid value
    }

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

inline

Get ROOT class of given data member.

Parameters

data_member

data member

Definition at line 266 of file JRootClass.hh.

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

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

inline

Get ROOT class of given base class.

Parameters

base_class

base class

Definition at line 278 of file JRootClass.hh.

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

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

inline

Print ROOT class information.

Parameters

out	output stream

Definition at line 290 of file JRootClass.hh.

    {
      print(out, getTypename());
    }

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 330 of file JRootClass.hh.

    {
      if (this->is_valid()) {

        print(out, prefix, this->getTypename());

        if (this->getClass() != NULL) {

          if (this->getClass()->GetListOfBases() != NULL) {
          
            TIterator* i = this->getClass()->GetListOfBases()->MakeIterator();
            
            for (const TBaseClass* p; (p = (const TBaseClass*) i->Next()) != NULL; ) {
              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() != NULL) {
            
            TIterator* i = this->getClass()->GetListOfDataMembers()->MakeIterator();
          
            for (const TDataMember* p; (p = (const TDataMember*) i->Next()) != NULL; ) {
              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());
            }
          }
        }
      }
    }

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 373 of file JRootClass.hh.

    {
      using namespace std; 

      out << name << "  " << '(' << type << ')' << endl;
    }

Friends And Related Function Documentation

bool operator== ( const JRootClass &  first, const JRootClass &  second  )

friend

Test equality of ROOT classes.

Parameters

first	first ROOT class
second	second ROOT class

Returns

true if both ROOT classes are same type; else false

Definition at line 205 of file JRootClass.hh.

    {
      return (first .getTypename() != NULL &&
              second.getTypename() != NULL &&
              strcmp(first.getTypename(), second.getTypename()) == 0);
    }

Member Data Documentation

TDictionary* JROOT::JRootClass::dictionary

protected

pointer to ROOT dictionary

Definition at line 298 of file JRootClass.hh.

int JROOT::JRootClass::offset

protected

offset with respect to data structure [B]

Definition at line 299 of file JRootClass.hh.

---

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

• JRootClass.hh