TCS::ParameterSpace Class Reference

#include <ParameterSpace.h>

Collaboration diagram for TCS::ParameterSpace:

Public Types
typedef std::vector< TCS::Parameter >	data_t
typedef data_t::iterator	iterator
typedef data_t::const_iterator	const_iterator

Public Member Functions
	ParameterSpace (const std::string &algName)
	ParameterSpace ()
bool	isInitialized () const
const std::string &	algName () const
ParameterSpace &	addParameter (const Parameter &p)
ParameterSpace &	addParameter (const std::string &name, TCS::parType_t value)
ParameterSpace &	addParameter (const std::string &name, TCS::parType_t value, unsigned int selection)
ParameterSpace &	setParameter (const Parameter &p)
ParameterSpace &	setParameter (const std::string &name, TCS::parType_t value)
ParameterSpace &	setParameter (const std::string &name, TCS::parType_t value, unsigned int selection)
const Parameter &	parameter (const std::string &parameterName) const
const Parameter &	parameter (const std::string &parameterName, unsigned int selection) const
const std::vector< TCS::Parameter > &	parameters () const
bool	contains (const std::string &parameterName, unsigned int selection) const
void	clear ()
iterator	begin ()
const_iterator	begin () const
iterator	end ()
const_iterator	end () const
data_t &	operator() ()
const data_t &	operator() () const
unsigned	index () const
void	setIndex (unsigned int index)

Private Attributes
data_t	m_parameters
unsigned int	m_index
std::string	m_algName

Detailed Description

Definition at line 18 of file ParameterSpace.h.

Member Typedef Documentation

const_iterator

typedef data_t::const_iterator TCS::ParameterSpace::const_iterator

Definition at line 22 of file ParameterSpace.h.

data_t

typedef std::vector<TCS::Parameter> TCS::ParameterSpace::data_t

Definition at line 20 of file ParameterSpace.h.

iterator

typedef data_t::iterator TCS::ParameterSpace::iterator

Definition at line 21 of file ParameterSpace.h.

Constructor & Destructor Documentation

ParameterSpace() [1/2]

TCS::ParameterSpace::ParameterSpace ( const std::string &  algName )

inline

Definition at line 24 of file ParameterSpace.h.

                                                :
         m_index(0),
         m_algName(algName)
      {};

ParameterSpace() [2/2]

TCS::ParameterSpace::ParameterSpace ( )

inline

Definition at line 29 of file ParameterSpace.h.

                       :
         m_index(0),
         m_algName("NONE")
      {};

Member Function Documentation

addParameter() [1/3]

ParameterSpace & ParameterSpace::addParameter

(

const Parameter &

p

)

Definition at line 29 of file ParameterSpace.cxx.

                                                  {
   if( contains(p.name(), p.selection()) ) {
      TCS_EXCEPTION("ParameterSpace: parameter '" << p.name() << "|" << p.selection() <<
                    "' exists already in parameter space of '" << algName() << "' and can't be added");
   }
   m_parameters.push_back(p);
   m_parameters.back().setIsDefault(true);
   return *this;
}

addParameter() [2/3]

ParameterSpace & ParameterSpace::addParameter	(	const std::string &	name,
		TCS::parType_t	value
	)

Definition at line 16 of file ParameterSpace.cxx.

                                                                       {
   return addParameter( Parameter(name, value));
}

addParameter() [3/3]

ParameterSpace & ParameterSpace::addParameter	(	const std::string &	name,
		TCS::parType_t	value,
		unsigned int	selection
	)

Definition at line 22 of file ParameterSpace.cxx.

                                                                                               {
   return addParameter( Parameter(name, value, selection));
}

algName()

const std::string& TCS::ParameterSpace::algName ( ) const

inline

Definition at line 36 of file ParameterSpace.h.

{ return m_algName; }

begin() [1/2]

iterator TCS::ParameterSpace::begin ( )

inline

Definition at line 64 of file ParameterSpace.h.

{ return m_parameters.begin(); }

begin() [2/2]

const_iterator TCS::ParameterSpace::begin ( ) const

inline

Definition at line 65 of file ParameterSpace.h.

{ return m_parameters.begin(); }

clear()

void TCS::ParameterSpace::clear ( )

inline

Definition at line 62 of file ParameterSpace.h.

{ m_parameters.clear(); }

contains()

bool ParameterSpace::contains	(	const std::string &	parameterName,
		unsigned int	selection
	)		const

Definition at line 92 of file ParameterSpace.cxx.

                                                                                      {
   for(const Parameter& pa: m_parameters)
      if( (pa.name() == parameterName) && (pa.selection() == selection) ) return true;
   return false;
}

end() [1/2]

iterator TCS::ParameterSpace::end ( )

inline

Definition at line 67 of file ParameterSpace.h.

{ return m_parameters.end(); }

end() [2/2]

const_iterator TCS::ParameterSpace::end ( ) const

inline

Definition at line 68 of file ParameterSpace.h.

{ return m_parameters.end(); }

index()

unsigned TCS::ParameterSpace::index ( ) const

inline

Definition at line 73 of file ParameterSpace.h.

{ return m_index; }

isInitialized()

bool TCS::ParameterSpace::isInitialized ( ) const

inline

Definition at line 34 of file ParameterSpace.h.

{ return m_algName != "NONE"; }

operator()() [1/2]

data_t& TCS::ParameterSpace::operator() ( )

inline

Definition at line 70 of file ParameterSpace.h.

{ return m_parameters; }

operator()() [2/2]

const data_t& TCS::ParameterSpace::operator() ( ) const

inline

Definition at line 71 of file ParameterSpace.h.

{ return m_parameters; }

parameter() [1/2]

const Parameter & ParameterSpace::parameter

(

const std::string &

parameterName

)

const

Definition at line 101 of file ParameterSpace.cxx.

                                                               {
   for(const Parameter & pa : m_parameters) {
      if( pa.isExtended() ) continue;
      if( pa.name() == parameterName ) 
         return pa;
   }
 
   TCS_EXCEPTION("Single parameter " << parameterName << " not found for algorithm " << algName());
   return m_parameters[0]; // doesn't make sense, but should never get here
}

parameter() [2/2]

const Parameter & ParameterSpace::parameter	(	const std::string &	parameterName,
		unsigned int	selection
	)		const

Definition at line 114 of file ParameterSpace.cxx.

                                                                                       {
   for(const Parameter & pa : m_parameters) {
      if( ! pa.isExtended() ) continue;
      if( (pa.name() == parameterName) && (pa.selection() == selection) ) 
         return pa;
   }
 
   TCS_EXCEPTION("Array parameter " << parameterName << "[" << selection << "] not found for algorithm " << algName());
   return m_parameters[0]; // doesn't make sense, but should never get here
}

parameters()

const std::vector<TCS::Parameter>& TCS::ParameterSpace::parameters ( ) const

inline

Definition at line 57 of file ParameterSpace.h.

{ return m_parameters; }

setIndex()

void TCS::ParameterSpace::setIndex ( unsigned int  index )

inline

Definition at line 74 of file ParameterSpace.h.

{ m_index = index; }

setParameter() [1/3]

ParameterSpace & ParameterSpace::setParameter

(

const Parameter &

p

)

Definition at line 49 of file ParameterSpace.cxx.

                                                {
 
   bool foundParameter = false;
 
   //cout << "Setting parameter " << p.name() << "[" << p.selection() << "]  for algorithm " << algName() << endl;
  
   for(TCS::Parameter& pa : m_parameters) {
      foundParameter =    
         ( !pa.isExtended() && pa.name()==p.name() ) || 
         ( pa.isExtended() && pa.name()==p.name() && pa.selection()==p.selection() );
 
      if(! foundParameter) continue;
 
      if( pa.isExtended() ) {
            pa.setValue(p.value());
            pa.setPosition(p.position());
            pa.setSelection(p.selection()); 
            pa.setIsExtended(true); // for parameters to print correctly
      } else { 
         pa.setValue(p.value());
         pa.setIsExtended(false);
      }
      pa.setIsDefault(false);
      break;
   }
 
   if( ! foundParameter ) {
      cout << "Parameter '" << p.name() << "' not found for algorithm " << algName() 
           << " and can't be set. Available parameters are" << endl;
 
      for(TCS::Parameter& pa : m_parameters) {
         cout << "   " << pa.name() << "   " << (pa.isExtended()?"array":"single") << endl;
      }
      TCS_EXCEPTION( "Parameter '" << p.name() << "' not found for algorithm " << algName() << " and can't be set." );
   }
   return *this;
}

setParameter() [2/3]

ParameterSpace& TCS::ParameterSpace::setParameter	(	const std::string &	name,
		TCS::parType_t	value
	)

setParameter() [3/3]

ParameterSpace & ParameterSpace::setParameter	(	const std::string &	name,
		TCS::parType_t	value,
		unsigned int	selection
	)

Definition at line 41 of file ParameterSpace.cxx.

                                                                                               {
   return setParameter(Parameter(name, value, selection));
}

Member Data Documentation

m_algName

std::string TCS::ParameterSpace::m_algName

private

Definition at line 81 of file ParameterSpace.h.

m_index

unsigned int TCS::ParameterSpace::m_index

private

Definition at line 78 of file ParameterSpace.h.

m_parameters

data_t TCS::ParameterSpace::m_parameters

private

Definition at line 77 of file ParameterSpace.h.

---

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

• ParameterSpace.h
• ParameterSpace.cxx