FWConfiguration Class Reference

#include <Fireworks/Core/interface/FWConfiguration.h>

Public Types
typedef std::vector< std::pair< std::string, FWConfiguration > >	KeyValues
typedef KeyValues::const_iterator	KeyValuesIt
typedef std::vector< std::string >	StringValues
typedef StringValues::const_iterator	StringValuesIt

Public Member Functions
FWConfiguration &	addKeyValue (const std::string &, const FWConfiguration &)
FWConfiguration &	addKeyValue (const std::string &, FWConfiguration &, bool iDoSwap=false)
FWConfiguration &	addValue (const std::string &)
	FWConfiguration (const FWConfiguration &)
	FWConfiguration (const std::string &iValue)
	FWConfiguration (unsigned int iVersion=1)
const KeyValues *	keyValues () const
FWConfiguration &	operator= (const FWConfiguration &)
const StringValues *	stringValues () const
void	swap (FWConfiguration &)
const std::string &	value (unsigned int iIndex=0) const
const FWConfiguration *	valueForKey (const std::string &iKey) const
unsigned int	version () const
virtual	~FWConfiguration ()

Static Public Member Functions
static void	streamTo (std::ostream &oTo, const FWConfiguration &iConfig, const std::string &name)

Private Attributes
std::unique_ptr< std::vector< std::pair< std::string, FWConfiguration > > >	m_keyValues
std::unique_ptr< std::vector< std::string > >	m_stringValues
unsigned int	m_version

Detailed Description

Description: <one line="" class="" summary>="">

Usage: <usage>

Definition at line 31 of file FWConfiguration.h.

Member Typedef Documentation

KeyValues

typedef std::vector<std::pair<std::string, FWConfiguration> > FWConfiguration::KeyValues

Definition at line 40 of file FWConfiguration.h.

KeyValuesIt

typedef KeyValues::const_iterator FWConfiguration::KeyValuesIt

Definition at line 41 of file FWConfiguration.h.

StringValues

typedef std::vector<std::string> FWConfiguration::StringValues

Definition at line 43 of file FWConfiguration.h.

StringValuesIt

typedef StringValues::const_iterator FWConfiguration::StringValuesIt

Definition at line 44 of file FWConfiguration.h.

Constructor & Destructor Documentation

FWConfiguration() [1/3]

FWConfiguration::FWConfiguration ( unsigned int  iVersion = 1 )

inline

Definition at line 33 of file FWConfiguration.h.

: m_version(iVersion) {}

Referenced by addKeyValue().

FWConfiguration() [2/3]

FWConfiguration::FWConfiguration ( const std::string &  iValue )

inline

Definition at line 34 of file FWConfiguration.h.

: m_stringValues(new std::vector<std::string>(1, iValue)), m_version(0) {}

~FWConfiguration()

FWConfiguration::~FWConfiguration ( )

virtual

Definition at line 42 of file FWConfiguration.cc.

{}

FWConfiguration() [3/3]

FWConfiguration::FWConfiguration

(

const FWConfiguration &

rhs

)

Definition at line 37 of file FWConfiguration.cc.

    : m_stringValues(rhs.m_stringValues ? new std::vector<std::string>(*(rhs.m_stringValues)) : nullptr),
      m_keyValues(rhs.m_keyValues ? new KeyValues(*(rhs.m_keyValues)) : nullptr),
      m_version(rhs.m_version) {}

Member Function Documentation

addKeyValue() [1/2]

FWConfiguration & FWConfiguration::addKeyValue	(	const std::string &	iKey,
		const FWConfiguration &	iConfig
	)

Definition at line 58 of file FWConfiguration.cc.

                                                                                                   {
  if (m_stringValues) {
    throw std::runtime_error("adding key/value to configuration containing string values");
  }
  if (not m_keyValues) {
    m_keyValues = std::make_unique<KeyValues>(1, std::make_pair(iKey, iConfig));
  } else {
    m_keyValues->push_back(std::make_pair(iKey, iConfig));
  }
  return *this;
}

References m_keyValues, and m_stringValues.

Referenced by addAreaInfoTo(), FWEventAnnotation::addTo(), CmsAnnotation::addTo(), FWCompositeParameter::addTo(), FWTriggerTableView::addTo(), FWLegoViewBase::addTo(), FWGenericParameter< T >::addTo(), FWEventItemsManager::addTo(), FWProxyBuilderConfiguration::addTo(), FWTableView::addTo(), CmsShowNavigator::addTo(), FWGeometryTableViewBase::addTo(), FWGUIManager::addTo(), FWTableViewManager::addToImpl(), FWEveView::addToOrthoCamera(), FWEveView::addToPerspectiveCamera(), addWindowInfoTo(), FWEventItemsManager::setFrom(), and FWConfigurationManager::to().

addKeyValue() [2/2]

FWConfiguration & FWConfiguration::addKeyValue	(	const std::string &	iKey,
		FWConfiguration &	iConfig,
		bool	iDoSwap = false
	)

Definition at line 69 of file FWConfiguration.cc.

                                                                                                           {
  if (m_stringValues) {
    throw std::runtime_error("adding key/value to configuration containing string values");
  }
  if (m_stringValues) {
    throw std::runtime_error("adding key/value to configuration containing string values");
  }
  if (not m_keyValues) {
    if (not iDoSwap) {
      m_keyValues = std::make_unique<KeyValues>(1, std::make_pair(iKey, iConfig));
    } else {
      m_keyValues = std::make_unique<KeyValues>(1, std::make_pair(iKey, FWConfiguration()));
      m_keyValues->back().second.swap(iConfig);
    }
  } else {
    if (not iDoSwap) {
      m_keyValues->push_back(std::make_pair(iKey, iConfig));
    } else {
      m_keyValues->push_back(std::make_pair(iKey, FWConfiguration()));
      m_keyValues->back().second.swap(iConfig);
    }
  }
  return *this;
}

References FWConfiguration(), m_keyValues, and m_stringValues.

addValue()

FWConfiguration & FWConfiguration::addValue

(

const std::string &

iValue

)

Definition at line 94 of file FWConfiguration.cc.

                                                                  {
  if (m_keyValues) {
    throw std::runtime_error("adding string value to configuration containing key/value pairs");
  }
  if (not m_stringValues) {
    m_stringValues = std::make_unique<std::vector<std::string>>(1, iValue);
  } else {
    m_stringValues->push_back(iValue);
  }
  return *this;
}

References m_keyValues, and m_stringValues.

keyValues()

const KeyValues* FWConfiguration::keyValues ( ) const

inline

Definition at line 51 of file FWConfiguration.h.

{ return m_keyValues.get(); }

References m_keyValues.

Referenced by FWProxyBuilderConfiguration::assertParam(), FWPartialConfigGUI::FWPartialConfigGUI(), FWConfigurationManager::guessAndReadFromFile(), FWPartialConfigLoadGUI::Load(), FWGeometryTableViewBase::populate3DViewsFromConfig(), FWConfigurationManager::setFrom(), FWCompositeParameter::setFrom(), FWEventItemsManager::setFrom(), CmsShowNavigator::setFrom(), FWGUIManager::setFrom(), streamTo(), and FWPartialConfigSaveGUI::WriteConfig().

operator=()

FWConfiguration & FWConfiguration::operator=

(

const FWConfiguration &

rhs

)

Definition at line 47 of file FWConfiguration.cc.

                                                                      {
  //An exception safe implementation is
  FWConfiguration temp(rhs);
  swap(temp);
 
  return *this;
}

References swap(), and groupFilesInBlocks::temp.

streamTo()

void FWConfiguration::streamTo ( std::ostream &  oTo, const FWConfiguration &  iConfig, const std::string &  name  )

static

Streaming FWConfiguration objects to xml.

Example of dump is:

<config name="top" version="1"> <string value="S1"> <string value="S2"> ... <string value="SN"> <config name="c1"> ... </configuration> <config name="c2"> ... </config> ... </config>

Streaming the top level configuration item will stream all its children.

Definition at line 196 of file FWConfiguration.cc.

                                                                                                     {
  static int recursionLevel = -1;
  recursionLevel += 1;
  std::string indentation(recursionLevel, ' ');
  oTo << indentation << "<config name=\"" << name << "\" version=\"" << iConfig.version() << "\">\n";
  if (iConfig.stringValues()) {
    for (FWConfiguration::StringValues::const_iterator it = iConfig.stringValues()->begin();
         it != iConfig.stringValues()->end();
         ++it) {
      oTo << indentation << "  <string>" << attrEscape(*it) << "</string>\n";
    }
  }
  if (iConfig.keyValues()) {
    for (FWConfiguration::KeyValues::const_iterator it = iConfig.keyValues()->begin(); it != iConfig.keyValues()->end();
         ++it) {
      FWConfiguration::streamTo(oTo, it->second, attrEscape(it->first));
    }
  }
  oTo << indentation << "</config>" << std::endl;
  recursionLevel -= 1;
}

References attrEscape(), printContent_cfi::indentation, keyValues(), Skims_PA_cff::name, AlCaHLTBitMon_QueryRunRegistry::string, stringValues(), and version().

Referenced by FWPartialConfigSaveGUI::WriteConfig(), and FWConfigurationManager::writeToFile().

stringValues()

const StringValues* FWConfiguration::stringValues ( ) const

inline

Definition at line 52 of file FWConfiguration.h.

{ return m_stringValues.get(); }

References m_stringValues.

Referenced by streamTo().

swap()

void FWConfiguration::swap

(

FWConfiguration &

iRHS

)

Definition at line 106 of file FWConfiguration.cc.

                                                {
  std::swap(m_version, iRHS.m_version);
  m_stringValues.swap(iRHS.m_stringValues);
  m_keyValues.swap(iRHS.m_keyValues);
}

References m_keyValues, m_stringValues, m_version, and std::swap().

Referenced by FWPartialConfigGUI::FWPartialConfigGUI(), and operator=().

value()

const std::string & FWConfiguration::value

(

unsigned int

iIndex = 0

)

const

Definition at line 115 of file FWConfiguration.cc.

                                                                 {
  if (not m_stringValues) {
    throw std::runtime_error("no string values set");
  }
  return m_stringValues->at(iIndex);
}

References m_stringValues.

Referenced by Types.int32::__nonzero__(), Types.uint32::__nonzero__(), Types.int64::__nonzero__(), Types.uint64::__nonzero__(), Types.double::__nonzero__(), Types.bool::__nonzero__(), Types.string::__nonzero__(), average.Average::average(), Types.string::configValue(), Types.FileInPath::configValue(), Mixins.UsingBlock::dumpPython(), Mixins.UsingBlock::insertInto(), Types.int32::insertInto(), Types.uint32::insertInto(), Types.int64::insertInto(), Types.uint64::insertInto(), Types.double::insertInto(), Types.bool::insertInto(), Types.string::insertInto(), Types.FileInPath::insertInto(), Types.vint32::insertInto(), Types.vuint32::insertInto(), Types.vint64::insertInto(), Types.vuint64::insertInto(), Types.vdouble::insertInto(), Types.vbool::insertInto(), Types.vstring::insertInto(), FWLegoViewBase::setFrom(), FWTriggerTableView::setFrom(), FW3DViewBase::setFrom(), CmsShowCommon::setFrom(), CmsShowNavigator::setFrom(), FWGUIManager::setFrom(), FWEveView::setFromOrthoCamera(), and FWGUIManager::setWindowInfoFrom().

valueForKey()

const FWConfiguration * FWConfiguration::valueForKey

(

const std::string &

iKey

)

const

Definition at line 122 of file FWConfiguration.cc.

                                                                               {
  if (m_stringValues) {
    throw std::runtime_error("valueFoKey fails because configuration containing string values");
  }
  if (not m_keyValues) {
    throw std::runtime_error("valueForKey fails becuase no key/values set");
  }
  KeyValues::iterator itFind =
      std::find_if(m_keyValues->begin(),
                   m_keyValues->end(),
                   std::bind(std::equal_to<void>(),
                             std::bind(&std::pair<std::string, FWConfiguration>::first, std::placeholders::_1),
                             iKey));
  if (itFind == m_keyValues->end()) {
    return nullptr;
  }
  return &(itFind->second);
}

References dqmdumpme::first, m_keyValues, and m_stringValues.

Referenced by FWProxyBuilderConfiguration::assertParam(), FWEventAnnotation::setFrom(), CmsAnnotation::setFrom(), FWCompositeParameter::setFrom(), FWOverlapTableView::setFrom(), FWLegoViewBase::setFrom(), FWTriggerTableView::setFrom(), FWRPZView::setFrom(), FWEventItemsManager::setFrom(), FWGeometryTableView::setFrom(), FW3DViewBase::setFrom(), CmsShowCommon::setFrom(), FWGenericParameter< T >::setFrom(), FWTableView::setFrom(), FWTableViewManager::setFrom(), CmsShowNavigator::setFrom(), FWGUIManager::setFrom(), FWEveView::setFromOrthoCamera(), FWEveView::setFromPerspectiveCamera(), FWGeometryTableViewBase::setTopNodePathFromConfig(), and FWGUIManager::setWindowInfoFrom().

version()

unsigned int FWConfiguration::version ( ) const

inline

Definition at line 49 of file FWConfiguration.h.

{ return m_version; }

References m_version.

Referenced by validation.Sample::datasetpattern(), validation.Sample::filename(), FWCompositeParameter::setFrom(), FWConfigurableParameterizable::setFrom(), FWLegoViewBase::setFrom(), FWTriggerTableView::setFrom(), FWRPZView::setFrom(), FWEventItemsManager::setFrom(), FW3DViewBase::setFrom(), FWEveView::setFrom(), FWTableView::setFrom(), FWGUIManager::setFrom(), and streamTo().

Member Data Documentation

m_keyValues

std::unique_ptr<std::vector<std::pair<std::string, FWConfiguration> > > FWConfiguration::m_keyValues

private

Definition at line 68 of file FWConfiguration.h.

Referenced by addKeyValue(), addValue(), keyValues(), swap(), and valueForKey().

m_stringValues

std::unique_ptr<std::vector<std::string> > FWConfiguration::m_stringValues

private

Definition at line 67 of file FWConfiguration.h.

Referenced by addKeyValue(), addValue(), stringValues(), swap(), value(), and valueForKey().

m_version

unsigned int FWConfiguration::m_version

private

Definition at line 69 of file FWConfiguration.h.

Referenced by swap(), and version().