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 *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 *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...

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...

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

Member Typedef Documentation

◆ JAddress_t

template<class JPointer_t>

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

Definition at line 428 of file JRootClass.hh.

◆ pointer_type

template<class JPointer_t>

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

Definition at line 429 of file JRootClass.hh.

Constructor & Destructor Documentation

◆ JRootAddressableClass() [1/2]

template<class JPointer_t>

template<class T >

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

inline

Constructor.

Parameters

object template object

Definition at line 437 of file JRootClass.hh.

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

◆ JRootAddressableClass() [2/2]

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

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

Member Function Documentation

◆ getAddress()

template<class JPointer_t>

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

inline

Get address.

Returns: pointer to object

Definition at line 448 of file JRootClass.hh.

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

◆ is_valid()

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

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

◆ find()

template<class JPointer_t>

JRootAddressableClass JROOT::JRootAddressableClass< JPointer_t >::find ( const char * 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

Definition at line 470 of file JRootClass.hh.

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

◆ get() [1/2]

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

Definition at line 481 of file JRootClass.hh.

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

◆ get() [2/2]

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

Definition at line 492 of file JRootClass.hh.

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

◆ operator[]()

template<class JPointer_t>

JRootAddressableClass JROOT::JRootAddressableClass< JPointer_t >::operator[] ( const char * 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

Definition at line 503 of file JRootClass.hh.

     {
       return this->find(name);
     }

◆ is_class() [1/3]

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

inlinestaticinherited

Check class name against ROOT class names.

Parameters

class_name class name

Returns: true if valid class name; else false

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

◆ is_class() [2/3]

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

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

◆ is_class() [3/3]

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

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

◆ is_STLcontainer() [1/2]

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 87 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 )

inlinestaticinherited

Check if data member is STL container.

Parameters

data_member data member

Returns: true if STL congtainer; else false

Definition at line 99 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 )

inlinestaticinherited

Check if data member is STL string.

Parameters

data_member data member

Returns: true if STL string; else false

Definition at line 111 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 )

inlinestaticinherited

Check if data member is static.

Parameters

data_member data member

Returns: true if static; else false

Definition at line 124 of file JRootClass.hh.

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

◆ getDictionary()

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

inlineinherited

Get dictionary.

Returns: pointer to dictionary

Definition at line 159 of file JRootClass.hh.

     {
       return dictionary;
     }

◆ getOffset()

int JROOT::JRootClass::getOffset ( ) const

inlineinherited

Get offset of this class with respect to parent class.

Returns: offset

Definition at line 170 of file JRootClass.hh.

     {
       return offset;
     }

◆ getClass()

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

inlineinherited

Get class.

Returns: pointer to class

Definition at line 181 of file JRootClass.hh.

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

◆ getTypename()

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

inlineinherited

Get type name.

Returns: type name

Definition at line 192 of file JRootClass.hh.

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

◆ equals()

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

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

◆ print() [1/3]

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

inlineinherited

Print ROOT class information.

Parameters

out	output stream

Definition at line 302 of file JRootClass.hh.

     {
       print(out, getTypename());
     }

◆ print() [2/3]

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

◆ print() [3/3]

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

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

Member Data Documentation

◆ dictionary

TDictionary* JROOT::JRootClass::dictionary

protectedinherited

pointer to ROOT dictionary

Definition at line 310 of file JRootClass.hh.

◆ offset

int JROOT::JRootClass::offset

protectedinherited

offset with respect to data structure [B]

Definition at line 311 of file JRootClass.hh.

◆ address

template<class JPointer_t>

pointer_type JROOT::JAddress< JPointer_t >::address

inherited

Definition at line 414 of file JRootClass.hh.

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

JRootClass.hh

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

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

Member Typedef Documentation

◆ JAddress_t

◆ pointer_type

Constructor & Destructor Documentation

◆ JRootAddressableClass() [1/2]

◆ JRootAddressableClass() [2/2]

Member Function Documentation

◆ getAddress()

◆ is_valid()

◆ find()

◆ get() [1/2]

◆ get() [2/2]

◆ operator[]()

◆ is_class() [1/3]

◆ is_class() [2/3]

◆ is_class() [3/3]

◆ is_STLcontainer() [1/2]

◆ is_STLcontainer() [2/2]

◆ is_STLstring()

◆ is_static()

◆ getDictionary()

◆ getOffset()

◆ getClass()

◆ getTypename()

◆ equals()

◆ print() [1/3]

◆ print() [2/3]

◆ print() [3/3]

Member Data Documentation

◆ dictionary

◆ offset

◆ address

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