#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 (std::string_view name, TCS::parType_t value)
ParameterSpace &	addParameter (std::string_view name, TCS::parType_t value, unsigned int selection)
ParameterSpace &	setParameter (const Parameter &p)
ParameterSpace &	setParameter (std::string_view name, TCS::parType_t value)
ParameterSpace &	setParameter (std::string_view name, TCS::parType_t value, unsigned int selection)
const Parameter &	parameter (std::string_view parameterName) const
const Parameter &	parameter (std::string_view parameterName, unsigned int selection) const
const std::vector< TCS::Parameter > &	parameters () const
bool	contains (std::string_view 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 22 of file ParameterSpace.h.

Member Typedef Documentation

◆ const_iterator

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

Definition at line 26 of file ParameterSpace.h.

◆ data_t

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

Definition at line 24 of file ParameterSpace.h.

◆ iterator

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

Definition at line 25 of file ParameterSpace.h.

Constructor & Destructor Documentation

◆ ParameterSpace() [1/2]

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

inline

Definition at line 28 of file ParameterSpace.h.

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

◆ ParameterSpace() [2/2]

TCS::ParameterSpace::ParameterSpace ( )

inline

Definition at line 33 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 30 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	(	std::string_view	name,
		TCS::parType_t	value )

Definition at line 17 of file ParameterSpace.cxx.

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

◆ addParameter() [3/3]

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

Definition at line 23 of file ParameterSpace.cxx.

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

◆ algName()

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

inline

Definition at line 40 of file ParameterSpace.h.

40{ return m_algName; }

◆ begin() [1/2]

iterator TCS::ParameterSpace::begin ( )

inline

Definition at line 68 of file ParameterSpace.h.

68{ return m_parameters.begin(); }

◆ begin() [2/2]

const_iterator TCS::ParameterSpace::begin ( ) const

inline

Definition at line 69 of file ParameterSpace.h.

69{ return m_parameters.begin(); }

◆ clear()

void TCS::ParameterSpace::clear ( )

inline

Definition at line 66 of file ParameterSpace.h.

66{ m_parameters.clear(); }

◆ contains()

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

Definition at line 93 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 71 of file ParameterSpace.h.

71{ return m_parameters.end(); }

◆ end() [2/2]

const_iterator TCS::ParameterSpace::end ( ) const

inline

Definition at line 72 of file ParameterSpace.h.

72{ return m_parameters.end(); }

◆ index()

unsigned TCS::ParameterSpace::index ( ) const

inline

Definition at line 77 of file ParameterSpace.h.

77{ return m_index; }

◆ isInitialized()

bool TCS::ParameterSpace::isInitialized ( ) const

inline

Definition at line 38 of file ParameterSpace.h.

38{ return m_algName != "NONE"; }

◆ operator()() [1/2]

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

inline

Definition at line 74 of file ParameterSpace.h.

74{ return m_parameters; }

◆ operator()() [2/2]

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

inline

Definition at line 75 of file ParameterSpace.h.

75{ return m_parameters; }

◆ parameter() [1/2]

const Parameter & ParameterSpace::parameter ( std::string_view parameterName ) const

Definition at line 102 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());
}

◆ parameter() [2/2]

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

Definition at line 113 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());
}

◆ parameters()

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

inline

Definition at line 61 of file ParameterSpace.h.

61{ return m_parameters; }

◆ setIndex()

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

inline

Definition at line 78 of file ParameterSpace.h.

78{ m_index = index; }

TCS::ParameterSpace::index

unsigned index() const

Definition ParameterSpace.h:77

◆ setParameter() [1/3]

ParameterSpace & ParameterSpace::setParameter ( const Parameter & p )

Definition at line 50 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	(	std::string_view	name,
		TCS::parType_t	value )

◆ setParameter() [3/3]

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

Definition at line 42 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 85 of file ParameterSpace.h.

◆ m_index

unsigned int TCS::ParameterSpace::m_index {}

private

Definition at line 82 of file ParameterSpace.h.

82{};

◆ m_parameters

data_t TCS::ParameterSpace::m_parameters

private

Definition at line 81 of file ParameterSpace.h.

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

Public Types

Public Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ const_iterator

◆ data_t

◆ iterator

Constructor & Destructor Documentation

◆ ParameterSpace() [1/2]

◆ ParameterSpace() [2/2]

Member Function Documentation

◆ addParameter() [1/3]

◆ addParameter() [2/3]

◆ addParameter() [3/3]

◆ algName()

◆ begin() [1/2]

◆ begin() [2/2]

◆ clear()

◆ contains()

◆ end() [1/2]

◆ end() [2/2]

◆ index()

◆ isInitialized()

◆ operator()() [1/2]

◆ operator()() [2/2]

◆ parameter() [1/2]

◆ parameter() [2/2]

◆ parameters()

◆ setIndex()

◆ setParameter() [1/3]

◆ setParameter() [2/3]

◆ setParameter() [3/3]

Member Data Documentation

◆ m_algName

◆ m_index

◆ m_parameters