caf::Proxy< T > Class Template Reference

#include "/cvmfs/nova-development.opensciencegrid.org/novasoft/releases/N21-03-07/StandardRecord/Proxy/FwdDeclare.h"

Public Member Functions
	Proxy (TDirectory *d, TTree *tr, const std::string &name, const long &base, int offset)
	Proxy (const Proxy &)
	Proxy (const Proxy &&)
Proxy &	operator= (const Proxy &)=delete
	Proxy (T v)=delete
	~Proxy ()
	operator T () const
T	GetValue () const
Proxy< T > &	operator= (T x)
Proxy< T > &	operator+= (T x)
Proxy< T > &	operator*= (T x)
std::string	Name () const
void	CheckEquals (const T &x) const

Protected Types
typedef std::conditional_t< std::is_enum_v< T >, int, T >	U

Protected Member Functions
T	GetValueNested () const
T	GetValueFlatSingle () const
T	GetValueFlatMulti () const
void	SetShifted ()

Protected Attributes
std::string	fName
CAFType	fType
TLeaf *	fLeaf
U	fVal
TTree *	fTree
TDirectory *	fDir
const long &	fBase
int	fOffset
TFormLeafInfo *	fLeafInfo
TBranch *	fBranch
TTreeFormula *	fTTF
long	fEntry
int	fSubIdx

Friends
class	Restorer

Detailed Description

template<class T>
class caf::Proxy< T >

Definition at line 8 of file FwdDeclare.h.

Member Typedef Documentation

template<class T>

typedef std::conditional_t<std::is_enum_v<T>, int, T> caf::Proxy< T >::U

protected

Definition at line 92 of file BasicTypesProxy.h.

Constructor & Destructor Documentation

template<class T >

caf::Proxy< T >::Proxy	(	TDirectory *	d,
		TTree *	tr,
		const std::string &	name,
		const long &	base,
		int	offset
	)

Definition at line 101 of file BasicTypesProxy.cxx.

    : fName(name), fType(GetCAFType(d, tr)),
      fLeaf(0), fTree(tr), fDir(d),
      fBase(AdjustBase(base, fType, fName)), fOffset(offset),
      fLeafInfo(0), fBranch(0), fTTF(0), fEntry(-1), fSubIdx(0)
  {
  }

template<class T >

caf::Proxy< T >::Proxy

(

const Proxy< T > &

p

)

Definition at line 112 of file BasicTypesProxy.cxx.

References caf::Proxy< T >::fVal, and caf::Proxy< T >::GetValue().

    : fName("copy of "+p.fName), fType(kCopiedRecord),
      fLeaf(0), fTree(0), fDir(0),
      fBase(kDummyBase), fOffset(-1),
      fLeafInfo(0), fBranch(0), fTTF(0), fEntry(-1), fSubIdx(-1)
  {
    // Ensure that the value is evaluated and baked in in the parent object, so
    // that fTTF et al aren't re-evaluated in every single copy.
    fVal = p.GetValue();
  }

template<class T >

caf::Proxy< T >::Proxy

(

const Proxy< T > &&

p

)

Definition at line 124 of file BasicTypesProxy.cxx.

References caf::Proxy< T >::fVal.

    : fName("move of "+p.fName), fType(kCopiedRecord),
      fLeaf(0), fTree(0), fDir(0),
      fBase(kDummyBase), fOffset(-1),
      fLeafInfo(0), fBranch(0), fTTF(0), fEntry(-1), fSubIdx(-1)
  {
    // Ensure that the value is evaluated and baked in in the parent object, so
    // that fTTF et al aren't re-evaluated in every single copy.
    fVal = p.GetValue();
  }

template<class T>

caf::Proxy< T >::Proxy ( T  v )

delete

template<class T >

caf::Proxy< T >::~Proxy

(

)

Definition at line 136 of file BasicTypesProxy.cxx.

References caf::Proxy< T >::fTTF.

  {
    // The other pointers aren't ours
    delete fTTF;
  }

Member Function Documentation

template<class T>

void caf::Proxy< T >::CheckEquals

(

const T &

x

)

const

Definition at line 368 of file BasicTypesProxy.cxx.

References genie::utils::math::AreEqual(), om::cout, allTimeWatchdog::endl, caf::Proxy< T >::fName, and caf::Proxy< T >::GetValue().

Referenced by caf::Proxy< caf::SRShowerLID >::CheckEquals(), caf::Proxy< caf::SRKalmanTrack >::CheckEquals(), caf::Proxy< caf::SRBpfTrack >::CheckEquals(), and caf::Proxy< caf::SRFuzzyKProng >::CheckEquals().

  {
    if(!AreEqual(GetValue(), x)){
      std::cout << fName << " differs: "
                << GetValue() << " vs " << x << std::endl;
    }
  }

template<class T >

T caf::Proxy< T >::GetValue

(

)

const

Definition at line 143 of file BasicTypesProxy.cxx.

References caf::Proxy< T >::fType, caf::Proxy< T >::fVal, caf::Proxy< T >::GetValueFlatMulti(), caf::Proxy< T >::GetValueFlatSingle(), caf::Proxy< T >::GetValueNested(), caf::kCopiedRecord, caf::kFlatMultiTree, caf::kFlatSingleTree, caf::kNested, and T.

Referenced by caf::Restorer::Add(), caf::Proxy< T >::CheckEquals(), std::max(), std::min(), caf::Proxy< T >::operator*=(), caf::Proxy< T >::operator+=(), and caf::Proxy< T >::Proxy().

  {
    switch(fType){
    case kNested: return GetValueNested();
    case kFlatMultiTree: return GetValueFlatMulti();
    case kFlatSingleTree: return GetValueFlatSingle();
    case kCopiedRecord: return (T)fVal;
    default: abort();
    }
  }

template<class T >

T caf::Proxy< T >::GetValueFlatMulti ( ) const

protected

Definition at line 202 of file BasicTypesProxy.cxx.

References caf::SRBranchRegistry::AddBranch(), ana::assert(), om::cout, allTimeWatchdog::endl, caf::Proxy< T >::fBase, caf::Proxy< T >::fBranch, caf::Proxy< T >::fEntry, caf::Proxy< T >::fLeaf, caf::Proxy< T >::fName, caf::Proxy< T >::fOffset, caf::Proxy< T >::fTree, caf::Proxy< T >::fVal, caf::GetTypedValueWrapper(), string, caf::StripSubscripts(), and T.

Referenced by caf::Proxy< T >::GetValue().

  {
    // Valid cached or systematically-shifted value
    if(fEntry == fBase+fOffset) return (T)fVal;
    fEntry = fBase+fOffset;

    assert(fTree);

    if(!fLeaf){
      const std::string sname = StripSubscripts(fName);
      fLeaf = fTree->GetLeaf(sname.c_str());
      if(!fLeaf){
        std::cout << std::endl << "BasicTypeProxy: Branch '" << sname
                  << "' not found in tree '" << fTree->GetName() << "'."
                  << std::endl;
        abort();
      }

      fBranch = fLeaf->GetBranch();

      if(fName.find("_idx") == std::string::npos &&
         fName.find("_length") == std::string::npos &&
         fName.find(".size()") == std::string::npos){ // specific to "nested"
        SRBranchRegistry::AddBranch(sname);
      }
    }

    fBranch->GetEntry(fBase+fOffset);

    GetTypedValueWrapper(fLeaf, fVal, 0);

    return (T)fVal;
  }

template<class T >

T caf::Proxy< T >::GetValueFlatSingle ( ) const

protected

Definition at line 166 of file BasicTypesProxy.cxx.

References caf::SRBranchRegistry::AddBranch(), ana::assert(), om::cout, allTimeWatchdog::endl, caf::Proxy< T >::fBase, caf::Proxy< T >::fBranch, caf::Proxy< T >::fEntry, caf::Proxy< T >::fLeaf, caf::Proxy< T >::fName, caf::Proxy< T >::fOffset, caf::Proxy< T >::fTree, caf::Proxy< T >::fVal, caf::GetTypedValueWrapper(), string, caf::StripSubscripts(), and T.

Referenced by caf::Proxy< T >::GetValue().

  {
    assert(fTree);

    // Valid cached or systematically-shifted value
    if(fEntry == fTree->GetReadEntry()) return (T)fVal;
    fEntry = fTree->GetReadEntry();

    assert(fTree);

    if(!fLeaf){
      const std::string sname = StripSubscripts(fName);
      fLeaf = fTree->GetLeaf(sname.c_str());
      if(!fLeaf){
        std::cout << std::endl << "BasicTypeProxy: Branch '" << sname
                  << "' not found in tree '" << fTree->GetName() << "'."
                  << std::endl;
        abort();
      }

      fBranch = fLeaf->GetBranch();

      if(fName.find("..idx") == std::string::npos &&
         fName.find("..length") == std::string::npos){
        SRBranchRegistry::AddBranch(sname);
      }
    }

    fBranch->GetEntry(fEntry);

    GetTypedValueWrapper(fLeaf, fVal, fBase+fOffset);

    return (T)fVal;
  }

template<class T >

T caf::Proxy< T >::GetValueNested ( ) const

protected

Definition at line 248 of file BasicTypesProxy.cxx.

References caf::SRBranchRegistry::AddBranch(), ana::assert(), om::cout, allTimeWatchdog::endl, caf::EvalInstanceWrapper(), caf::Proxy< T >::fBranch, caf::Proxy< T >::fEntry, caf::Proxy< T >::fLeaf, caf::Proxy< T >::fLeafInfo, caf::Proxy< T >::fName, caf::Proxy< T >::fSubIdx, caf::Proxy< T >::fTree, caf::Proxy< T >::fTTF, caf::Proxy< T >::fVal, caf::GetTypedValueWrapper(), string, and T.

Referenced by caf::Proxy< T >::GetValue().

  {
    assert(fTree);

    // Valid cached or systematically-shifted value
    if(fEntry == fTree->GetReadEntry()) return (T)fVal;
    fEntry = fTree->GetReadEntry();

    // First time calling, set up the branches etc
    if(!fTTF){
      SRBranchRegistry::AddBranch(fName);

      // Leaves are attached to the TTF, must keep it
      fTTF = new TTreeFormula(("TTFProxy-"+fName).c_str(), fName.c_str(), fTree);
      fLeafInfo = fTTF->GetLeafInfo(0); // Can fail (for a regular branch?)
      fLeaf = fTTF->GetLeaf(0);
      fBranch = fLeaf->GetBranch();

      if(!fLeaf || !fBranch){
        std::cout << "Couldn't find " << fName << " in tree. Abort."
                  << std::endl;

        abort();
      }

      // TODO - parsing the array indices out sucks - pass in as an int somehow
      const size_t open_idx = fName.find_first_of('[');
      // Do we have exactly one set of [] in the name?
      if(open_idx != std::string::npos && open_idx == fName.find_last_of('[')){
        const size_t close_idx = fName.find_first_of(']');

        std::string numPart = fName.substr(open_idx+1, close_idx-open_idx-1);
        fSubIdx = atoi(numPart.c_str());
      }
    }

    if(fLeafInfo){
      // Using TTreeFormula always works, and is sometimes necessary

      fTTF->GetNdata(); // for some reason this is necessary for fTTF to work
                        // in all cases.

      EvalInstanceWrapper(fTTF, fVal);
    }
    else{
      // But when this is possible the hope is it might be faster

      if(fBranch->GetReadEntry() != fEntry){
        fBranch->GetEntry(fEntry);
      }

      // This check is much quicker than what CheckIndex() does, which winds up
      // calling a TTF, but I can't figure out a safe way to automatically
      // elide that check.
      if(fSubIdx > fLeaf->GetLen()){
        std::cout << std::endl << fName << " out of range (size() == " << fLeaf->GetLen() << "). Aborting." << std::endl;
        abort();
      }

      GetTypedValueWrapper(fLeaf, fVal, fSubIdx);
    }

    return (T)fVal;
  }

template<class T>

std::string caf::Proxy< T >::Name ( void  ) const

inline

Definition at line 79 of file BasicTypesProxy.h.

Referenced by caf::VectorProxyBase::size().

{return fName;}

template<class T>

caf::Proxy< T >::operator T ( ) const

inline

Definition at line 70 of file BasicTypesProxy.h.

{return GetValue();}

template<class T>

Proxy< T > & caf::Proxy< T >::operator*=

(

T

x

)

Definition at line 347 of file BasicTypesProxy.cxx.

References om::cout, allTimeWatchdog::endl, caf::Proxy< T >::GetValue(), T, and void().

  {
    if constexpr(std::is_same_v<T, std::string>){
      std::cout << "Proxy<std::string>::operator*=() is meaningless" << std::endl;
      (void)x;
      abort();
    }
    else if constexpr(std::is_same_v<T, bool>){
      std::cout << "Proxy<bool>::operator*=() is meaningless" << std::endl;
      (void)x;
      abort();
    }
    else{
      // Do it this way to re-use the systematics logic in operator=
      *this = T(GetValue() * x);
    }

    return *this;
  }

template<class T>

Proxy< T > & caf::Proxy< T >::operator+=

(

T

x

)

Definition at line 331 of file BasicTypesProxy.cxx.

References om::cout, allTimeWatchdog::endl, caf::Proxy< T >::GetValue(), T, and void().

  {
    if constexpr(!std::is_same_v<T, bool>){
      // Do it this way to re-use the systematics logic in operator=
      *this = T(GetValue() + x);
    }
    else{
      std::cout << "Proxy<bool>::operator+=() is meaningless" << std::endl;
      (void)x;
      abort();
    }

    return *this;
  }

template<class T>

Proxy& caf::Proxy< T >::operator= ( const Proxy< T > &  )

delete

Referenced by caf::Proxy< caf::SRShowerLID >::operator=(), caf::Proxy< caf::SRKalmanTrack >::operator=(), caf::Proxy< caf::SRBpfTrack >::operator=(), and caf::Proxy< caf::SRFuzzyKProng >::operator=().

template<class T>

Proxy< T > & caf::Proxy< T >::operator=

(

T

x

)

Definition at line 314 of file BasicTypesProxy.cxx.

References caf::SRProxySystController::Backup(), caf::Proxy< T >::fBase, caf::Proxy< T >::fEntry, caf::Proxy< T >::fOffset, caf::Proxy< T >::fTree, caf::Proxy< T >::fType, caf::Proxy< T >::fVal, caf::SRProxySystController::InTransaction(), caf::kCopiedRecord, caf::kFlatMultiTree, caf::kFlatSingleTree, caf::kNested, and submit_syst::x.

  {
    if(SRProxySystController::InTransaction()) SRProxySystController::Backup(*this);
    fVal = x;

    switch(fType){
    case kNested:         fEntry = fTree->GetReadEntry(); break;
    case kFlatMultiTree:  fEntry = fBase+fOffset;         break;
    case kFlatSingleTree: fEntry = fTree->GetReadEntry(); break;
    case kCopiedRecord: break;
    default: abort();
    }

    return *this;
  }

template<class T>

void caf::Proxy< T >::SetShifted ( )

protected

Friends And Related Function Documentation

template<class T>

friend class Restorer

friend

Definition at line 51 of file BasicTypesProxy.h.

Member Data Documentation

template<class T>

const long& caf::Proxy< T >::fBase

protected

Definition at line 103 of file BasicTypesProxy.h.

Referenced by caf::Proxy< T >::GetValueFlatMulti(), caf::Proxy< T >::GetValueFlatSingle(), and caf::Proxy< T >::operator=().

template<class T>

TBranch* caf::Proxy< T >::fBranch

mutableprotected

Definition at line 108 of file BasicTypesProxy.h.

Referenced by caf::Proxy< T >::GetValueFlatMulti(), caf::Proxy< T >::GetValueFlatSingle(), and caf::Proxy< T >::GetValueNested().

template<class T>

TDirectory* caf::Proxy< T >::fDir

protected

Definition at line 102 of file BasicTypesProxy.h.

template<class T>

long caf::Proxy< T >::fEntry

mutableprotected

Definition at line 110 of file BasicTypesProxy.h.

Referenced by caf::Proxy< T >::GetValueFlatMulti(), caf::Proxy< T >::GetValueFlatSingle(), caf::Proxy< T >::GetValueNested(), and caf::Proxy< T >::operator=().

template<class T>

TLeaf* caf::Proxy< T >::fLeaf

mutableprotected

Definition at line 97 of file BasicTypesProxy.h.

Referenced by caf::Proxy< T >::GetValueFlatMulti(), caf::Proxy< T >::GetValueFlatSingle(), and caf::Proxy< T >::GetValueNested().

template<class T>

TFormLeafInfo* caf::Proxy< T >::fLeafInfo

mutableprotected

Definition at line 107 of file BasicTypesProxy.h.

Referenced by caf::Proxy< T >::GetValueNested().

template<class T>

std::string caf::Proxy< T >::fName

protected

Definition at line 95 of file BasicTypesProxy.h.

Referenced by caf::Proxy< T >::CheckEquals(), caf::Proxy< T >::GetValueFlatMulti(), caf::Proxy< T >::GetValueFlatSingle(), and caf::Proxy< T >::GetValueNested().

template<class T>

int caf::Proxy< T >::fOffset

protected

Definition at line 104 of file BasicTypesProxy.h.

Referenced by caf::Proxy< T >::GetValueFlatMulti(), caf::Proxy< T >::GetValueFlatSingle(), and caf::Proxy< T >::operator=().

template<class T>

int caf::Proxy< T >::fSubIdx

mutableprotected

Definition at line 111 of file BasicTypesProxy.h.

Referenced by caf::Proxy< T >::GetValueNested().

template<class T>

TTree* caf::Proxy< T >::fTree

protected

Definition at line 99 of file BasicTypesProxy.h.

Referenced by caf::Proxy< T >::GetValueFlatMulti(), caf::Proxy< T >::GetValueFlatSingle(), caf::Proxy< T >::GetValueNested(), and caf::Proxy< T >::operator=().

template<class T>

TTreeFormula* caf::Proxy< T >::fTTF

mutableprotected

Definition at line 109 of file BasicTypesProxy.h.

Referenced by caf::Proxy< T >::GetValueNested(), and caf::Proxy< T >::~Proxy().

template<class T>

CAFType caf::Proxy< T >::fType

protected

Definition at line 96 of file BasicTypesProxy.h.

Referenced by caf::Proxy< T >::GetValue(), and caf::Proxy< T >::operator=().

template<class T>

U caf::Proxy< T >::fVal

mutableprotected

Definition at line 98 of file BasicTypesProxy.h.

Referenced by caf::Restorer::Add(), caf::Proxy< T >::GetValue(), caf::Proxy< T >::GetValueFlatMulti(), caf::Proxy< T >::GetValueFlatSingle(), caf::Proxy< T >::GetValueNested(), caf::Proxy< T >::operator=(), and caf::Proxy< T >::Proxy().

---

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

• /cvmfs/nova-development.opensciencegrid.org/novasoft/releases/N21-03-07/StandardRecord/Proxy/FwdDeclare.h
• SRProxy/BasicTypesProxy.h
• SRProxy/BasicTypesProxy.cxx