JROOT::JManager< JKey_t, JValue_t > Class Template Reference

Auxiliary class to manage set of compatible ROOT objects (e.g. histograms) using unique keys. More...

#include <JManager.hh>

Inheritance diagram for JROOT::JManager< JKey_t, JValue_t >:

Public Types
typedef JPointer< JValue_t >	ptr_type
typedef std::map< JKey_t, ptr_type >	map_type

Public Member Functions
	JManager ()
	Default constructor.
	JManager (JValue_t *master, char wildcard='%', JFormat_t format=JFormat_t())
	Constructor.
	JManager (JValue_t *master, const std::string &name, char wildcard='%', std::ios::fmtflags format=std::ios::fmtflags())
	Constructor.
	JManager (const JManager &manager)
	Copy constructor.
void	clear ()
	Clear client objects.
JValue_t *	operator[] (JKey_t key)
	Get pointer to object for given key.
void	Read (TDirectory &in)
	Read objects from file.
void	Write (TDirectory &out, const bool wm=false)
	Write objects to file.
void	Write (const char *file_name, const bool wm=false)
	Write objects to file.
virtual JClass_t *	get () const override
	Get pointer.
virtual void	set (JClass_t *p) override
	Set pointer.
template<class T >
void	set (const JPointer< T > &pointer)
	Set pointer.
virtual void	reset () override
	Reset pointer.
template<class T >
void	reset (const JPointer< T > &pointer)
	Reset pointer.
void	reset (JClass_t *p)
	Reset pointer.
JClass_t *const &	getReference () const
	Get rereference to internal pointer.
JClass_t *&	getReference ()
	Get rereference to internal pointer.
virtual bool	equals (const JAbstractPointer &object) const
	Equals.
bool	is_valid () const
	Check validity of pointer.
JClass_t *	operator-> () const
	Smart pointer operator.
	operator JClass_t * () const
	Type conversion operator.

Static Public Member Functions
static JManager	Read (TDirectory &in, const char *const master, const char wildcard)
	Read objects from file into manager.

Public Attributes
char	wc
JFormat_t	fmt

Protected Attributes
JClass_t *	__p
	pointer to object

Static Private Member Functions
static void	detach (...)
	Fall back for detaching object pointed to from ROOT I/O.
static void	detach (TH1 *p)
	Implementation for detaching of object pointed to from ROOT I/O.

Friends
TFile &	operator>> (TFile &file, JManager &object)
	Read manager from file.
TFile &	operator<< (TFile &file, JManager &object)
	Write manager to file.

Detailed Description

template<class JKey_t, class JValue_t>
class JROOT::JManager< JKey_t, JValue_t >

Auxiliary class to manage set of compatible ROOT objects (e.g. histograms) using unique keys.

For each use of the map operator [], it is checked whether the corresponding client object exists.
If the corresponding client object does not yet exists, a clone is made of the master object (i.e. the 'client').
The name of the newly created object is derived from the name of the master object by replacing the wild card character with the value of the key according the optional format specifier.

Definition at line 44 of file JManager.hh.

Member Typedef Documentation

ptr_type

template<class JKey_t , class JValue_t >

JPointer<JValue_t> JROOT::JManager< JKey_t, JValue_t >::ptr_type

Definition at line 50 of file JManager.hh.

map_type

template<class JKey_t , class JValue_t >

std::map<JKey_t, ptr_type> JROOT::JManager< JKey_t, JValue_t >::map_type

Definition at line 51 of file JManager.hh.

Constructor & Destructor Documentation

JManager() [1/4]

template<class JKey_t , class JValue_t >

JROOT::JManager< JKey_t, JValue_t >::JManager ( )

inline

Default constructor.

Definition at line 56 of file JManager.hh.

    {}

JManager() [2/4]

template<class JKey_t , class JValue_t >

JROOT::JManager< JKey_t, JValue_t >::JManager ( JValue_t * master, char wildcard = '%', JFormat_t format = JFormat_t() )

inline

Constructor.

Note that the manager owns the master object pointed to.
For saving the objects to file, use method JManager::Write (all objects are detached from the current ROOT directory).

Parameters

master	master object
wildcard	wild card character
format	format specifier for replacement of wildcard character by value of key

Definition at line 71 of file JManager.hh.

                                                        :
      ptr_type(master),
      map_type(),
      wc (wildcard),
      fmt(format)
    {
      using namespace std;
      using namespace JPP;
      
      if (!this->is_valid()) {
        THROW(JException, "No valid master");
      }
 
      if (string(this->get()->GetName()).find(wc) == string::npos) {
        THROW(JException, "Invalid wildcard <" << this->get()->GetName() << "> '" << wc << "'");
      }
 
      detach(this->get());
 
      resetObject(this->get(), true);
    }

JManager() [3/4]

template<class JKey_t , class JValue_t >

JROOT::JManager< JKey_t, JValue_t >::JManager ( JValue_t * master, const std::string & name, char wildcard = '%', std::ios::fmtflags format = std::ios::fmtflags() )

inline

Constructor.

Note that the manager owns the master object pointed to.
For saving the objects to file, use method JManager::Write (all objects are detached from the current ROOT directory).

Parameters

master	master object
name	name of master
wildcard	wild card character
format	format specifier for replacement of wildcard character by value of key

Definition at line 108 of file JManager.hh.

                                                         : 
      ptr_type(master),
      map_type(),
      wc (wildcard),
      fmt(format)
    {
      using namespace std;
      using namespace JPP;
      
      if (!this->is_valid()) {
        THROW(JException, "No valid master");
      }
 
      this->get()->SetName(name.c_str());
 
      if (string(this->get()->GetName()).find(wc) == string::npos) {
        THROW(JException, "Invalid wildcard <" << this->get()->GetName() << "> '" << wc << "'");
      }
 
      detach(this->get());
 
      resetObject(this->get(), true);
    }

JManager() [4/4]

template<class JKey_t , class JValue_t >

JROOT::JManager< JKey_t, JValue_t >::JManager ( const JManager< JKey_t, JValue_t > & manager )

inline

Copy constructor.

Note that the master object of the given manager is cloned and the wildcard copied.
The client objects are not copied.

Parameters

manager

manager

Definition at line 144 of file JManager.hh.

                                      :
      ptr_type(NULL),
      map_type(),
      wc (manager.wc),
      fmt(manager.fmt)
    {
      using namespace JPP;
 
      if (manager.is_valid()) {
 
        this->set((JValue_t*) manager.get()->Clone());
 
        detach(this->get());
 
        resetObject(this->get(), true);
      }
    }

Member Function Documentation

clear()

template<class JKey_t , class JValue_t >

void JROOT::JManager< JKey_t, JValue_t >::clear ( )

inline

Clear client objects.

Definition at line 166 of file JManager.hh.

    {
      for (typename map_type::iterator i = this->begin(); i != this->end(); ++i) {
        i->second.reset();
      }
 
      this->clear();
    }

operator[]()

template<class JKey_t , class JValue_t >

JValue_t * JROOT::JManager< JKey_t, JValue_t >::operator[] ( JKey_t key )

inline

Get pointer to object for given key.

Parameters

key

key

Returns

pointer to client object

Definition at line 182 of file JManager.hh.

    {
      using namespace std;
      using namespace JPP;
 
      typename map_type::iterator i = this->find(key);
 
      if (i == this->end()) {
 
        string            buffer = this->get()->GetName();
        string::size_type ipos   = buffer.find(wc);
 
        ostringstream os;
        
        fmt.put(os);
      
        os << key;
      
        buffer.replace(ipos, 1, os.str());
      
        JValue_t* p = (JValue_t*) this->get()->Clone(buffer.c_str());
 
        detach(p);
 
        resetObject(p, true);
 
        this->insert(make_pair(key,p));
      
        return p;
 
      } else {
      
        return i->second;
      }
    }

Read() [1/2]

template<class JKey_t , class JValue_t >

static JManager JROOT::JManager< JKey_t, JValue_t >::Read ( TDirectory & in, const char *const master, const char wildcard )

inlinestatic

Read objects from file into manager.

Parameters

in	input file or directory
master	master name
wildcard	wild card character

Returns

manager

Definition at line 227 of file JManager.hh.

    {
      using namespace std;
      using namespace JPP;
 
      JManager manager;
 
      TString buffer = master;
 
      const Ssiz_t  pos = buffer.Index(wildcard);
 
      const TString a   = buffer(0,     pos); 
      const TString b   = buffer(pos+1, buffer.Length()); 
 
      buffer.ReplaceAll("[", "\\[");
      buffer.ReplaceAll("]", "\\]");
 
      buffer.ReplaceAll(wildcard, ".*");
 
      const TRegexp regexp(buffer);
 
      TIter iter(in.GetListOfKeys());
      
      for (TKey* key; (key = (TKey*) iter.Next()) != NULL; ) {
          
        const TString tag(key->GetName());
 
        // option match
 
        if (tag.Index(regexp) != -1) {
          
          JValue_t* p = dynamic_cast<JValue_t*>(key->ReadObj());
 
          if (p != NULL) {
 
            detach(p);
 
            string buffer = p->GetName();
 
            if (a.Length() != 0) { buffer.replace(buffer.find(a), a.Length(), ""); }
            if (b.Length() != 0) { buffer.replace(buffer.find(b), b.Length(), ""); }
 
            JKey_t key;
 
            istringstream(buffer) >> key;
 
            manager.insert(make_pair(key, p));
          }
        }
      }
 
      return manager;
    }

Read() [2/2]

template<class JKey_t , class JValue_t >

void JROOT::JManager< JKey_t, JValue_t >::Read ( TDirectory & in )

inline

Read objects from file.

Parameters

in	input file or directory

Definition at line 287 of file JManager.hh.

    {
      if (this->is_valid()) {
 
        JManager buffer = Read(in, this->get()->GetName(), this->wc);
 
        this->swap(buffer);
      }
    }

Write() [1/2]

template<class JKey_t , class JValue_t >

void JROOT::JManager< JKey_t, JValue_t >::Write ( TDirectory & out, const bool wm = false )

inline

Write objects to file.

Parameters

out	output file or directory
wm	write master

Definition at line 304 of file JManager.hh.

    {
      for (typename map_type::iterator i = this->begin(); i != this->end(); ++i) {
        out.WriteTObject(i->second);
      }
 
      if (wm) {
        out.WriteTObject(this->get());
      }
    }

Write() [2/2]

template<class JKey_t , class JValue_t >

void JROOT::JManager< JKey_t, JValue_t >::Write ( const char * file_name, const bool wm = false )

inline

Write objects to file.

Parameters

file_name	file name
wm	write master

Definition at line 322 of file JManager.hh.

    {
      TFile out(file_name, "RECREATE");
 
      this->Write(out, wm) ;
 
      out.Write();
      out.Close();
    }

detach() [1/2]

template<class JKey_t , class JValue_t >

static void JROOT::JManager< JKey_t, JValue_t >::detach ( ... )

inlinestaticprivate

Fall back for detaching object pointed to from ROOT I/O.

Definition at line 369 of file JManager.hh.

    {}

detach() [2/2]

template<class JKey_t , class JValue_t >

static void JROOT::JManager< JKey_t, JValue_t >::detach ( TH1 * p )

inlinestaticprivate

Implementation for detaching of object pointed to from ROOT I/O.

Parameters

p	pointer to object

Definition at line 378 of file JManager.hh.

    {
      if (p != NULL) {
        p->SetDirectory(0);
      }
    }

get()

template<class JClass_t >

virtual JClass_t * JLANG::JPointer< JClass_t >::get ( ) const

inlineoverridevirtualinherited

Get pointer.

Returns

pointer to object

Implements JLANG::JAbstractPointer< JClass_t >.

Reimplemented in JLANG::JMultiPointer< JClass_t >, JLANG::JMultiPointer< JHead_t >, JLANG::JMultiPointer< JTail_t >, JLANG::JMultiPointer< JTypeList< JDAQEvent, JNullType > >, JLANG::JMultiPointer< JTypeList< JHead_t, JTail_t > >, and JLANG::JMultiPointer< T >.

Definition at line 64 of file JPointer.hh.

    {
      return this->__p;
    }

set() [1/2]

template<class JClass_t >

virtual void JLANG::JPointer< JClass_t >::set ( JClass_t * p )

inlineoverridevirtualinherited

Set pointer.

Parameters

p	pointer to object

Implements JLANG::JAbstractPointer< JClass_t >.

Reimplemented in JLANG::JSharedPointer< JClass_t, JMemory_t >, JLANG::JSharedPointer< JAbstractAutoPointer< JBase_t > >, JLANG::JSharedPointer< JAccessibleObjectIterator< Evt > >, JLANG::JSharedPointer< JAccessibleObjectIterator< JDAQSummaryslice > >, JLANG::JSharedPointer< JAccessibleObjectIterator< JHead_t > >, JLANG::JSharedPointer< JAccessibleObjectIterator< JTail_t > >, JLANG::JSharedPointer< JAccessibleObjectIterator< JTypeList< JDAQEvent, JNullType > > >, JLANG::JSharedPointer< JAccessibleObjectIterator< KM3NETDAQ::JDAQEvent > >, JLANG::JSharedPointer< JAccessibleObjectIterator< T > >, JLANG::JSharedPointer< JAccessibleObjectOutput< T > >, JLANG::JSharedPointer< JBase_t >, JLANG::JSharedPointer< JFIT::JMEstimator >, JLANG::JSharedPointer< JLOGGER::JLogger >, JLANG::JSharedPointer< JNET::JControlHost >, JLANG::JSharedPointer< JObjectIterator< T > >, JLANG::JSharedPointer< JObjectOutput< JHead_t > >, JLANG::JSharedPointer< JObjectOutput< JTail_t > >, JLANG::JSharedPointer< JObjectOutput< T > >, JLANG::JSharedPointer< JParserElementInterface >, JLANG::JSharedPointer< JPropertiesElementInterface >, JLANG::JSharedPointer< JRadiation >, JLANG::JSharedPointer< JRewindableObjectIterator< const event_type > >, JLANG::JSharedPointer< JRewindableObjectIterator< JHead_t > >, JLANG::JSharedPointer< JRewindableObjectIterator< JTail_t > >, JLANG::JSharedPointer< JRewindableObjectIterator< T > >, JLANG::JSharedPointer< JTOOLS::JMultiMapTransformer >, JLANG::JSharedPointer< JTRIGGER::JDAQHitSelector >, JLANG::JSharedPointer< JTRIGGER::JMatch >, and JLANG::JSharedPointer< match_type >.

Definition at line 75 of file JPointer.hh.

    {
      this->__p = p;
    }

set() [2/2]

template<class JClass_t >

template<class T >

void JLANG::JPointer< JClass_t >::set ( const JPointer< T > & pointer )

inlineinherited

Set pointer.

Parameters

pointer

pointer to object

Definition at line 96 of file JPointer.hh.

    {
      this->set(pointer.get());
    }

reset() [1/3]

template<class JClass_t >

virtual void JLANG::JPointer< JClass_t >::reset ( )

inlineoverridevirtualinherited

Reset pointer.

Implements JLANG::JAbstractPointer< JClass_t >.

Reimplemented in JLANG::JSharedPointer< JClass_t, JMemory_t >, JLANG::JSharedPointer< JAbstractAutoPointer< JBase_t > >, JLANG::JSharedPointer< JAccessibleObjectIterator< Evt > >, JLANG::JSharedPointer< JAccessibleObjectIterator< JDAQSummaryslice > >, JLANG::JSharedPointer< JAccessibleObjectIterator< JHead_t > >, JLANG::JSharedPointer< JAccessibleObjectIterator< JTail_t > >, JLANG::JSharedPointer< JAccessibleObjectIterator< JTypeList< JDAQEvent, JNullType > > >, JLANG::JSharedPointer< JAccessibleObjectIterator< KM3NETDAQ::JDAQEvent > >, JLANG::JSharedPointer< JAccessibleObjectIterator< T > >, JLANG::JSharedPointer< JAccessibleObjectOutput< T > >, JLANG::JSharedPointer< JBase_t >, JLANG::JSharedPointer< JFIT::JMEstimator >, JLANG::JSharedPointer< JLOGGER::JLogger >, JLANG::JSharedPointer< JNET::JControlHost >, JLANG::JSharedPointer< JObjectIterator< T > >, JLANG::JSharedPointer< JObjectOutput< JHead_t > >, JLANG::JSharedPointer< JObjectOutput< JTail_t > >, JLANG::JSharedPointer< JObjectOutput< T > >, JLANG::JSharedPointer< JParserElementInterface >, JLANG::JSharedPointer< JPropertiesElementInterface >, JLANG::JSharedPointer< JRadiation >, JLANG::JSharedPointer< JRewindableObjectIterator< const event_type > >, JLANG::JSharedPointer< JRewindableObjectIterator< JHead_t > >, JLANG::JSharedPointer< JRewindableObjectIterator< JTail_t > >, JLANG::JSharedPointer< JRewindableObjectIterator< T > >, JLANG::JSharedPointer< JTOOLS::JMultiMapTransformer >, JLANG::JSharedPointer< JTRIGGER::JDAQHitSelector >, JLANG::JSharedPointer< JTRIGGER::JMatch >, JLANG::JSharedPointer< match_type >, JLANG::JStorage< JClass_t, JMemory_t >, JLANG::JStorage< JAbstractAutoPointer< JBase_t >, JNew >, JLANG::JStorage< JAccessibleObjectIterator< Evt >, JNew >, JLANG::JStorage< JAccessibleObjectIterator< JDAQSummaryslice >, JNew >, JLANG::JStorage< JAccessibleObjectIterator< JHead_t >, JNew >, JLANG::JStorage< JAccessibleObjectIterator< JTail_t >, JNew >, JLANG::JStorage< JAccessibleObjectIterator< JTypeList< JDAQEvent, JNullType > >, JNew >, JLANG::JStorage< JAccessibleObjectIterator< KM3NETDAQ::JDAQEvent >, JNew >, JLANG::JStorage< JAccessibleObjectIterator< T >, JNew >, JLANG::JStorage< JAccessibleObjectOutput< T >, JNew >, JLANG::JStorage< JBase_t, JNew >, JLANG::JStorage< JClass_t, JNew >, JLANG::JStorage< JDETECTOR::JCLBDefaultSimulatorInterface::JStateMachine, JNew >, JLANG::JStorage< JDETECTOR::JCLBDefaultSimulatorInterface::JTDC, JNew >, JLANG::JStorage< JDETECTOR::JCLBSimulator, JNew >, JLANG::JStorage< JDETECTOR::JK40Simulator, JNew >, JLANG::JStorage< JDETECTOR::JModuleRouter, JNew >, JLANG::JStorage< JDETECTOR::JPMTSimulator, JNew >, JLANG::JStorage< JFIT::JMEstimator, JNew >, JLANG::JStorage< JIO::JReader, JNew >, JLANG::JStorage< JIO::JWriter, JNew >, JLANG::JStorage< JLANG::JMultiPipe< T, N >, JNew >, JLANG::JStorage< JLOGGER::JLogger, JNew >, JLANG::JStorage< JNET::JControlHost, JNew >, JLANG::JStorage< JNET::JControlHostObjectOutput, JNew >, JLANG::JStorage< JNET::JServerSocket, JNew >, JLANG::JStorage< JObjectIterator< T >, JNew >, JLANG::JStorage< JObjectOutput< JHead_t >, JNew >, JLANG::JStorage< JObjectOutput< JTail_t >, JNew >, JLANG::JStorage< JObjectOutput< T >, JNew >, JLANG::JStorage< JParserElementInterface, JNew >, JLANG::JStorage< JPropertiesElementInterface, JNew >, JLANG::JStorage< JRadiation, JNew >, JLANG::JStorage< JRewindableObjectIterator< const event_type >, JNew >, JLANG::JStorage< JRewindableObjectIterator< JHead_t >, JNew >, JLANG::JStorage< JRewindableObjectIterator< JTail_t >, JNew >, JLANG::JStorage< JRewindableObjectIterator< T >, JNew >, JLANG::JStorage< JTOOLS::JFunction1D, JNew >, JLANG::JStorage< JTOOLS::JMultiMapTransformer, JNew >, JLANG::JStorage< JTRIGGER::JBuildL1, JNew >, JLANG::JStorage< JTRIGGER::JBuildL2, JNew >, JLANG::JStorage< JTRIGGER::JDAQHitSelector, JNew >, JLANG::JStorage< JTRIGGER::JMatch, JNew >, JLANG::JStorage< JTRIGGER::JTimesliceRouter, JNew >, JLANG::JStorage< JTRIGGER::JTrigger3DMuon, JNew >, JLANG::JStorage< JTRIGGER::JTrigger3DShower, JNew >, JLANG::JStorage< JTRIGGER::JTriggerMXShower, JNew >, JLANG::JStorage< JTRIGGER::JTriggerNB, JNew >, JLANG::JStorage< match_type, JNew >, and JLANG::JStorage< TFile >.

Definition at line 84 of file JPointer.hh.

    { 
      this->__p = NULL;
    }

reset() [2/3]

template<class JClass_t >

template<class T >

void JLANG::JPointer< JClass_t >::reset ( const JPointer< T > & pointer )

inlineinherited

Reset pointer.

Parameters

pointer

pointer to object

Definition at line 108 of file JPointer.hh.

    {
      this->reset(pointer.get());
    }

reset() [3/3]

template<class JClass_t >

void JLANG::JAbstractPointer< JClass_t >::reset ( JClass_t * p )

inlineinherited

Reset pointer.

Parameters

p	pointer to object

Definition at line 94 of file JAbstractPointer.hh.

    {
      if (this->get() != p) {
 
        this->reset();
 
        if (p != NULL) {
          this->set(p);
        }
      }
    }

getReference() [1/2]

template<class JClass_t >

JClass_t *const & JLANG::JPointer< JClass_t >::getReference ( ) const

inlineinherited

Get rereference to internal pointer.

Returns

reference to internal pointer

Definition at line 119 of file JPointer.hh.

    {
      return __p;
    }

getReference() [2/2]

template<class JClass_t >

JClass_t *& JLANG::JPointer< JClass_t >::getReference ( )

inlineinherited

Get rereference to internal pointer.

Returns

reference to internal pointer

Definition at line 130 of file JPointer.hh.

    {
      return __p;
    }

equals()

template<class JClass_t >

virtual bool JLANG::JAbstractPointer< JClass_t >::equals ( const JAbstractPointer< JClass_t > & object ) const

inlinevirtualinherited

Equals.

The equality is evaluated by comparison of the internal pointers.

Parameters

object

abstract pointer

Returns

true if equals; else false

Definition at line 50 of file JAbstractPointer.hh.

    {
      return this->get() == object.get();
    }

is_valid()

template<class JClass_t >

bool JLANG::JAbstractPointer< JClass_t >::is_valid ( ) const

inlineinherited

Check validity of pointer.

Returns

true if pointer not null; else false

Definition at line 83 of file JAbstractPointer.hh.

    { 
      return this->get() != NULL; 
    }

operator->()

template<class JClass_t >

JClass_t * JLANG::JAbstractPointer< JClass_t >::operator-> ( ) const

inlineinherited

Smart pointer operator.

Returns

pointer to object

Definition at line 112 of file JAbstractPointer.hh.

    { 
      if (!is_valid())
        THROW(JNullPointerException, "JAbstractPointer::operator->()");
      else
        return this->get();
    }

operator JClass_t *()

template<class JClass_t >

JLANG::JAbstractPointer< JClass_t >::operator JClass_t * ( ) const

inlineinherited

Type conversion operator.

Returns

pointer to object

Definition at line 126 of file JAbstractPointer.hh.

    {
      return this->get();
    }

Friends And Related Symbol Documentation

operator>>

template<class JKey_t , class JValue_t >

TFile & operator>> ( TFile & file, JManager< JKey_t, JValue_t > & object )

friend

Read manager from file.

Parameters

file	file
object	manager

Returns

file

Definition at line 340 of file JManager.hh.

    {
      object.Read(file);
 
      return file;
    }

operator<<

template<class JKey_t , class JValue_t >

TFile & operator<< ( TFile & file, JManager< JKey_t, JValue_t > & object )

friend

Write manager to file.

Parameters

file	file
object	manager

Returns

file

Definition at line 355 of file JManager.hh.

    {
      object.Write(file);
 
      return file;
    }

Member Data Documentation

wc

template<class JKey_t , class JValue_t >

char JROOT::JManager< JKey_t, JValue_t >::wc

Definition at line 362 of file JManager.hh.

fmt

template<class JKey_t , class JValue_t >

JFormat_t JROOT::JManager< JKey_t, JValue_t >::fmt

Definition at line 363 of file JManager.hh.

__p

template<class JClass_t >

JClass_t* JLANG::JPointer< JClass_t >::__p

protectedinherited

pointer to object

Definition at line 136 of file JPointer.hh.

---

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

• JManager.hh