SFrame 3.6
Public Member Functions | Protected Member Functions
SInputVariables< ParentType > Class Template Reference

Base class for classes holding input variables. More...

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

List of all members.

Public Member Functions

 SInputVariables (ParentType *parent)
 Constructor that specifies the parent cycle.

Protected Member Functions

template<typename T >
bool ConnectVariable (const char *treeName, const char *branchName, T &variable) throw ( SError )
 Connect an input variable.

Detailed Description

template<class ParentType>
class SInputVariables< ParentType >

Base class for classes holding input variables.

This class can be used to serve as a base class for classes whose only purpose is to collect input variables. By collecting input variables into objects, it's quite convenient to pass them around between objects that process their information.

Version:
Revision:
155

Definition at line 31 of file SInputVariables.h.

Constructor & Destructor Documentation

template<class ParentType >
SInputVariables< ParentType >::SInputVariables ( ParentType *  parent)

Constructor that specifies the parent cycle.

Definition at line 18 of file SInputVariables.icc.

Member Function Documentation

template<class ParentType >
template<typename T >
bool SInputVariables< ParentType >::ConnectVariable ( const char *  treeName,
const char *  branchName,
T &  variable 
) throw ( SError ) [protected]

Connect an input variable.

Only one such function is needed, even though there are 3 different specializations of this function in SCycleBaseNTuple. But the specialization step only happens at SCycleBaseNTuple, GCC would actually just get confused (rightfully so) if we defined multiple specializations for this particular function.

Definition at line 31 of file SInputVariables.icc.

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