Auxiliary class to manage set of compatible ROOT objects (e.g. More...

#include <JManager.hh>

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

Public Member Functions
	JManager (JValue_t *master, char wildcard= '%', std::ios::fmtflags format=std::ios::fmtflags())
	Constructor. More...

JValue_t *	operator[] (JKey_t key)
	Get pointer to object for given key. More...

void	Write (TDirectory &out, const bool wm=false)
	Write objects to file. More...

void	Write (const char *file_name, const bool wm=false)
	Write objects to file. More...

virtual JClass_t *	get () const
	Get pointer. More...

virtual void	set (JClass_t *p)
	Set pointer. More...

template<class T >
void	set (const JPointer< T > &pointer)
	Set pointer. More...

virtual void	reset ()
	Reset pointer. More...

template<class T >
void	reset (const JPointer< T > &pointer)
	Reset pointer. More...

void	reset (JClass_t *p)
	Reset pointer. More...

JClass_t *const &	getReference () const
	Get rereference to internal pointer. More...

JClass_t *&	getReference ()
	Get rereference to internal pointer. More...

virtual bool	equals (const JAbstractPointer &object) const
	Equals. More...

bool	is_valid () const
	Check validity of pointer. More...

JClass_t *	operator-> () const
	Smart pointer operator. More...

	operator JClass_t * () const
	Type conversion operator. More...

Protected Attributes
char	wc

std::ios::fmtflags	fmt

JClass_t *	__p
	pointer to object More...

Friends
TFile &	operator<< (TFile &file, JManager &object)
	Write manager to file. More...

Detailed Description

template<class JKey_t, class JValue_t = TObject>
class JGIZMO::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 38 of file JManager.hh.

Constructor & Destructor Documentation

template<class JKey_t, class JValue_t = TObject>

JGIZMO::JManager< JKey_t, JValue_t >::JManager	(	JValue_t *	master,
		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 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 54 of file JManager.hh.

                                                        :
       JPointer<JValue_t>(master),
       std::map<JKey_t, JValue_t*>(),
       wc (wildcard),
       fmt(format)
     {
       using namespace std;
       using namespace JLANG;
 
       if (master == NULL) {
         THROW(JException, "JManager: No master object.");
       }
 
       master->SetDirectory(0);
     
       if (string(master->GetName()).find(wc) == string::npos) {
         THROW(JException, "JManager: Missing wildcard " << master->GetName() << ' ' << wc);
       }
     }

Member Function Documentation

template<class JKey_t, class JValue_t = TObject>

JValue_t* JGIZMO::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 83 of file JManager.hh.

     {
       using namespace std;
 
       typename map<JKey_t, JValue_t*>::iterator i = this->find(key);
 
       if (i == this->end()) {
 
         string            buffer = this->get()->GetName();
         string::size_type ipos   = buffer.find(wc);
 
         ostringstream os;
 
         os.setf(fmt);
       
         os << key;
       
         buffer.replace(ipos, 1, os.str());
       
         JValue_t* p = (JValue_t*) this->get()->Clone(buffer.c_str());
 
         p->Reset();
         p->SetDirectory(0);
 
         this->insert(make_pair(key,p));
       
         return p;
 
       } else {
       
         return i->second;
       }
     }

template<class JKey_t, class JValue_t = TObject>

void JGIZMO::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 124 of file JManager.hh.

     {
       for (typename std::map<JKey_t, JValue_t*>::iterator i = this->begin(); i != this->end(); ++i) {
         out.WriteTObject(i->second);
       }
 
       if (wm) {
         out.WriteTObject(this->get());
       }
     }

template<class JKey_t, class JValue_t = TObject>

void JGIZMO::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 142 of file JManager.hh.

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

template<class JClass_t>

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

inlinevirtualinherited

Get pointer.

Returns: pointer to object

Implements JLANG::JAbstractPointer< JClass_t >.

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

Definition at line 64 of file JPointer.hh.

     {
       return this->__p;
     }

template<class JClass_t>

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

inlinevirtualinherited

Set pointer.

Parameters

p	pointer to object

Implements JLANG::JAbstractPointer< JClass_t >.

Definition at line 75 of file JPointer.hh.

     {
       this->__p = p;
     }

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

template<class JClass_t>

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

inlinevirtualinherited

Reset pointer.

Implements JLANG::JAbstractPointer< JClass_t >.

Definition at line 84 of file JPointer.hh.

     { 
       this->__p = NULL;
     }

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

template<class JClass_t>

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

inlineinherited

Reset pointer.

Parameters

p	pointer to object

Definition at line 92 of file JAbstractPointer.hh.

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

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

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

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 48 of file JAbstractPointer.hh.

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

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 81 of file JAbstractPointer.hh.

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

template<class JClass_t>

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

inlineinherited

Smart pointer operator.

Returns: pointer to object

Definition at line 110 of file JAbstractPointer.hh.

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

template<class JClass_t>

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

inlineinherited

Type conversion operator.

Returns: pointer to object

Definition at line 124 of file JAbstractPointer.hh.

     {
       return this->get();
     }

Friends And Related Function Documentation

template<class JKey_t, class JValue_t = TObject>

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 160 of file JManager.hh.

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

Member Data Documentation

template<class JKey_t, class JValue_t = TObject>

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

protected

Definition at line 168 of file JManager.hh.

template<class JKey_t, class JValue_t = TObject>

std::ios::fmtflags JGIZMO::JManager< JKey_t, JValue_t >::fmt

protected

Definition at line 169 of file JManager.hh.

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

Public Member Functions

Protected Attributes

Friends

Detailed Description

template<class JKey_t, class JValue_t = TObject> class JGIZMO::JManager< JKey_t, JValue_t >

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation

template<class JKey_t, class JValue_t = TObject>
class JGIZMO::JManager< JKey_t, JValue_t >