BCParameterSet Class Reference

#include <BCParameterSet.h>

Public Member Functions
bool	Add (BCParameter *par)
void	Clear (bool)
BCParameter *	operator[] (unsigned index) const
BCParameter *	Get (unsigned index) const
BCParameter *	Get (const std::string &name) const
unsigned	Index (const std::string &name) const
unsigned	Size () const
bool	ValidIndex (unsigned index, const std::string caller="CheckIndex") const

Private Attributes
std::vector< BCParameter * >	fPars
	Don't own parameters. More...

Detailed Description

allow access by name into list of BCParameter.

Author

Frederik Beaujean

Daniel Greenwald

Note

Parameters are not owned, and will not be deleted by BCParameterSet.

Definition at line 28 of file BCParameterSet.h.

Member Function Documentation

bool BCParameterSet::Add

(

BCParameter *

par)

Add a parameter if no parameter of same name exists yet.

Parameters

par

Parameter

Returns

True if successful.

Definition at line 19 of file BCParameterSet.cxx.

{
   if ( !parameter)
      return false;
   // check if parameter with same name exists
   for (unsigned int i = 0; i < fPars.size() ; ++i)
      if ( parameter->GetName() == fPars[i]->GetName() ) {
         BCLog::OutError(TString::Format("BCParameterSet::Add : Parameter with name %s exists already. ",
               parameter->GetName().data()));
         return false;
      }

   // add parameter to parameter container
   fPars.push_back(parameter);
   return true;
}

void BCParameterSet::Clear

(

bool

hard)

Definition at line 37 of file BCParameterSet.cxx.

{
   if (hard) {
      for (unsigned int i = 0; i < fPars.size() ; ++i)
         delete fPars[i];
   }

   fPars.clear();
}

BCParameter* BCParameterSet::Get ( unsigned  index) const

inline

Safe access, but slightly less efficient access to parameter.

Parameters

index

Index gets checked.

Returns

The pointer at index position or NULL if invalid index.

Definition at line 58 of file BCParameterSet.h.

   {
      return ValidIndex(index, "Get") ? fPars[index] : NULL;
   }

BCParameter* BCParameterSet::Get ( const std::string &  name) const

inline

Safe access, but slightly less efficient access to parameter.

Parameters

name	Look up name in list

Returns

The pointer at index position or NULL if invalid index.

Definition at line 69 of file BCParameterSet.h.

   {
      return Get(Index(name));
   }

unsigned BCParameterSet::Index

(

const std::string &

name)

const

Find index of parameter identified by name

Definition at line 59 of file BCParameterSet.cxx.

{
   for (unsigned int i=0; i < fPars.size() ; ++i)
      if (name == fPars[i]->GetName())
         return i;

   BCLog::OutWarning(TString::Format("BCParameterSet::Index: no parameter named '%s'", name.c_str()));
   return fPars.size();
}

BCParameter* BCParameterSet::operator[] ( unsigned  index) const

inline

Raw and fast access.

Parameters

index

Index

Returns

Parameter

Definition at line 47 of file BCParameterSet.h.

   {
      return fPars[index];
   }

unsigned BCParameterSet::Size ( ) const

inline

Number of parameters contained

Definition at line 82 of file BCParameterSet.h.

   {    return fPars.size(); }

bool BCParameterSet::ValidIndex	(	unsigned	index,
		const std::string	caller = "CheckIndex"
	)		const

Check if indes is in range

Parameters

index	Index
caller	Optional string to identify caller for debug output

Returns

Definition at line 48 of file BCParameterSet.cxx.

{
   if (index >= fPars.size()) {
      BCLog::OutError(TString::Format("BCParameterSet::%s : Parameter index %u out of range", caller.c_str(), index));
      return false;
   }
   else
      return true;
}

Member Data Documentation

std::vector<BCParameter*> BCParameterSet::fPars

private

Don't own parameters.

Definition at line 95 of file BCParameterSet.h.

---

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

• BCParameterSet.h
• BCParameterSet.cxx