JROOT::JRootAddressableClass< JPointer_t > Struct Template Reference

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

#include <JRootClass.hh>

Inheritance diagram for JROOT::JRootAddressableClass< JPointer_t >:

Public Types
typedef JAddress< JPointer_t >	JAddress_t
typedef JAddress_t::pointer_type	pointer_type

Public Member Functions
template<class T >
	JRootAddressableClass (T &object)
	Constructor. More...
pointer_type	getAddress () const
	Get address. More...
bool	is_valid () const
	Check validity of this addressable class. More...
JRootAddressableClass	find (const char *const name) const
	Find addressable base class or data member with given name within current class. More...
JRootAddressableClass	get (const TDataMember &data_member) const
	Get addressable class of given data member. More...
JRootAddressableClass	get (const TBaseClass &base_class) const
	Get addressable class of given base class. More...
JRootAddressableClass	operator[] (const char *const name) const
	Find addressable base class or data member with given name within current class. 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	equals (const JRootClass &object) const
	Test equality of ROOT classes. More...
JRootClass	find (const char *const name, const bool option=true) const
	Find base class or data member with given name within current class. More...
void	print (std::ostream &out) const
	Print ROOT class information. More...

Static Public Member Functions
static bool	is_class (const char *const name)
	Check name of class against ROOT classes. 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...

Public Attributes
pointer_type	address

Protected Member Functions
	JRootAddressableClass (const JRootClass &rc, pointer_type address)
	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...

Detailed Description

template<class JPointer_t>
struct JROOT::JRootAddressableClass< JPointer_t >

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

This class augments the class JRootClass with addressing capabilities.

Definition at line 427 of file JRootClass.hh.

Member Typedef Documentation

template<class JPointer_t>

typedef JAddress<JPointer_t> JROOT::JRootAddressableClass< JPointer_t >::JAddress_t

Definition at line 431 of file JRootClass.hh.

template<class JPointer_t>

typedef JAddress_t::pointer_type JROOT::JRootAddressableClass< JPointer_t >::pointer_type

Definition at line 432 of file JRootClass.hh.

Constructor & Destructor Documentation

template<class JPointer_t>

template<class T >

JROOT::JRootAddressableClass< JPointer_t >::JRootAddressableClass ( T &  object )

inline

Constructor.

Parameters

object

template object

Definition at line 440 of file JRootClass.hh.

                                     :
      JRootClass(JType<T>()),
      JAddress_t((pointer_type) &object)
    {}

template<class JPointer_t>

JROOT::JRootAddressableClass< JPointer_t >::JRootAddressableClass ( const JRootClass &  rc, pointer_type  address  )

inlineprotected

Constructor.

Parameters

rc	ROOT class
address	address

Definition at line 523 of file JRootClass.hh.

                                                                      :
      JRootClass(rc),
      JAddress_t(address)
    {}

Member Function Documentation

template<class JPointer_t>

pointer_type JROOT::JRootAddressableClass< JPointer_t >::getAddress ( ) const

inline

Get address.

Returns

pointer to object

Definition at line 451 of file JRootClass.hh.

    {
      return this->address + getOffset();
    }

template<class JPointer_t>

bool JROOT::JRootAddressableClass< JPointer_t >::is_valid ( ) const

inline

Check validity of this addressable class.

Returns

true if valid addressable class; else false

Definition at line 462 of file JRootClass.hh.

    {
      return (JRootClass::is_valid() && this->address != NULL);
    }

template<class JPointer_t>

JRootAddressableClass JROOT::JRootAddressableClass< JPointer_t >::find ( const char *const  name ) const

inline

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

Parameters

name	name of base class or data member

Returns

ROOT addressable class

Definition at line 474 of file JRootClass.hh.

    {
      return JRootAddressableClass(JRootClass::find(name), this->address);
    }

template<class JPointer_t>

JRootAddressableClass JROOT::JRootAddressableClass< JPointer_t >::get ( const TDataMember &  data_member ) const

inline

Get addressable class of given data member.

Parameters

data_member

data member

Returns

ROOT addressable class

Definition at line 486 of file JRootClass.hh.

    {
      return JRootAddressableClass(JRootClass::get(data_member), this->address);
    }

template<class JPointer_t>

JRootAddressableClass JROOT::JRootAddressableClass< JPointer_t >::get ( const TBaseClass &  base_class ) const

inline

Get addressable class of given base class.

Parameters

base_class

base class

Returns

ROOT addressable class

Definition at line 498 of file JRootClass.hh.

    {
      return JRootAddressableClass(JRootClass::get(base_class), this->address);
    }

template<class JPointer_t>

JRootAddressableClass JROOT::JRootAddressableClass< JPointer_t >::operator[] ( const char *const  name ) const

inline

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

Parameters

name	name of base class or data member

Returns

ROOT addressable class

Definition at line 510 of file JRootClass.hh.

    {
      return this->find(name);
    }

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

inlinestaticinherited

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);
    }

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

inlinestaticinherited

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());
    }

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

inlinestaticinherited

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());
    }

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

inlinestaticinherited

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);
    }

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

inlinestaticinherited

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);
    }

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

inlinestaticinherited

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);
    }

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

inlinestaticinherited

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);
    }

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

inlineinherited

Get dictionary.

Returns

pointer to dictionary

Definition at line 163 of file JRootClass.hh.

    {
      return dictionary;
    }

int JROOT::JRootClass::getOffset ( ) const

inlineinherited

Get offset of this class with respect to parent class.

Returns

offset

Definition at line 174 of file JRootClass.hh.

    {
      return offset;
    }

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

inlineinherited

Get class.

Returns

pointer to class

Definition at line 185 of file JRootClass.hh.

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

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

inlineinherited

Get type name.

Returns

type name

Definition at line 196 of file JRootClass.hh.

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

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

inlineinherited

Test equality of ROOT classes.

Parameters

object

ROOT class

Returns

true if both ROOT classes are same type; else false

Definition at line 222 of file JRootClass.hh.

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

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

inlineinherited

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 237 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
    }

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

inlineinherited

Print ROOT class information.

Parameters

out	output stream

Definition at line 309 of file JRootClass.hh.

    {
      print(out, getTypename());
    }

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

inlineprotectedinherited

Print ROOT class information.

Parameters

out	output stream
prefix	prefix

Definition at line 349 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());
            }
          }
        }
      }
    }

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

inlinestaticprotectedinherited

Print ROOT class information.

Parameters

out	output stream
name	name
type	type

Definition at line 388 of file JRootClass.hh.

    {
      using namespace std; 

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

Member Data Documentation

TDictionary* JROOT::JRootClass::dictionary

protectedinherited

pointer to ROOT dictionary

Definition at line 317 of file JRootClass.hh.

int JROOT::JRootClass::offset

protectedinherited

offset with respect to data structure [B]

Definition at line 318 of file JRootClass.hh.

template<class JPointer_t>

pointer_type JROOT::JAddress< JPointer_t >::address

inherited

Definition at line 417 of file JRootClass.hh.

---

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

• JRootClass.hh