SFrame 3.6
SSummedVar< Type > Class Template Reference

Class to be used when counting something on PROOF. More...

#include <plug-ins/include/SSummedVar.h>

Collaboration diagram for SSummedVar< Type >:

List of all members.

Public Types

typedef Type ValueType
 Declaration of the used type.

Public Member Functions

 SSummedVar (const char *name, ISCycleBaseHist *parent)
 Constructor.
 operator Type & ()
 Automatic conversion operator.
 operator const Type & () const
 Constant automatic conversion operator.
Type & operator* ()
 Operator for accessing the wrapped object as a reference.
Type * operator-> ()
 Operator for accessing the wrapped object as a pointer.
Type & GetReference ()
 Function for accessing the wrapped object as a reference.
Type * GetPointer ()
 Function for accessing the wrapped object as a pointer.
const Type & operator* () const
 Constant operator for accessing the wrapped object as a reference.
const Type * operator-> () const
 Constant operator for accessing the wrapped object as a pointer.
const Type & GetReference () const
 Constant function for accessing the wrapped object as a reference.
const Type * GetPointer () const
 Constant function for accessing the wrapped object as a pointer.

Detailed Description

template<class Type>
class SSummedVar< Type >

Class to be used when counting something on PROOF.

This class should make it quite simple to count various things when executing an analysis on a PROOF cluster. After instantiating it, one just has to use it like the variable that it wrapps. The inner workings of the class make sure that the values assigned to it on the worker nodes are added up and are visible on the master node.

Note that when you add such a variable as a member to your cycle, you should hide the variable from the dictionary generation in the newer ROOT releases. (5.28 and the development releases leading up to it.) This is done the easiest by putting "//!" after the variable declaration. See the FirstCycle example.

Version:
Revision:
229
Examples:

FirstCycle.h.

Definition at line 79 of file SSummedVar.h.


Member Typedef Documentation

template<class Type >
typedef Type SSummedVar< Type >::ValueType

Declaration of the used type.

Definition at line 83 of file SSummedVar.h.


Constructor & Destructor Documentation

template<class Type >
SSummedVar< Type >::SSummedVar ( const char *  name,
ISCycleBaseHist parent 
)

Constructor.

Definition at line 198 of file SSummedVar.icc.


Member Function Documentation

template<class Type >
Type * SSummedVar< Type >::GetPointer ( )

Function for accessing the wrapped object as a pointer.

Definition at line 234 of file SSummedVar.icc.

template<class Type >
const Type * SSummedVar< Type >::GetPointer ( ) const

Constant function for accessing the wrapped object as a pointer.

Definition at line 258 of file SSummedVar.icc.

template<class Type >
const Type & SSummedVar< Type >::GetReference ( ) const

Constant function for accessing the wrapped object as a reference.

Definition at line 252 of file SSummedVar.icc.

template<class Type >
Type & SSummedVar< Type >::GetReference ( )

Function for accessing the wrapped object as a reference.

Definition at line 228 of file SSummedVar.icc.

template<class Type >
SSummedVar< Type >::operator const Type & ( ) const

Constant automatic conversion operator.

Definition at line 210 of file SSummedVar.icc.

template<class Type >
SSummedVar< Type >::operator Type & ( )

Automatic conversion operator.

Definition at line 204 of file SSummedVar.icc.

template<class Type >
const Type & SSummedVar< Type >::operator* ( ) const

Constant operator for accessing the wrapped object as a reference.

Definition at line 240 of file SSummedVar.icc.

template<class Type >
Type & SSummedVar< Type >::operator* ( )

Operator for accessing the wrapped object as a reference.

Definition at line 216 of file SSummedVar.icc.

template<class Type >
Type * SSummedVar< Type >::operator-> ( )

Operator for accessing the wrapped object as a pointer.

Definition at line 222 of file SSummedVar.icc.

template<class Type >
const Type * SSummedVar< Type >::operator-> ( ) const

Constant operator for accessing the wrapped object as a pointer.

Definition at line 246 of file SSummedVar.icc.


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