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 (unsigned int iVersion=1)
	FWConfiguration (const std::string &iValue)
	FWConfiguration (const FWConfiguration &)
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
boost::scoped_ptr< std::vector< std::pair< std::string, FWConfiguration > > >	m_keyValues
boost::scoped_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

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

Definition at line 45 of file FWConfiguration.h.

typedef KeyValues::const_iterator FWConfiguration::KeyValuesIt

Definition at line 46 of file FWConfiguration.h.

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

Definition at line 48 of file FWConfiguration.h.

typedef StringValues::const_iterator FWConfiguration::StringValuesIt

Definition at line 49 of file FWConfiguration.h.

Constructor & Destructor Documentation

FWConfiguration::FWConfiguration ( unsigned int  iVersion = 1 )

inline

Definition at line 35 of file FWConfiguration.h.

Referenced by addKeyValue(), and FWConfiguration().

                                            : m_version(iVersion) {
   }

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

inline

Definition at line 37 of file FWConfiguration.h.

References FWConfiguration(), operator=(), and ~FWConfiguration().

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

FWConfiguration::~FWConfiguration ( )

virtual

Definition at line 44 of file FWConfiguration.cc.

Referenced by FWConfiguration().

{
}

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

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

Definition at line 64 of file FWConfiguration.cc.

References m_keyValues, and m_stringValues.

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

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

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

Definition at line 77 of file FWConfiguration.cc.

References FWConfiguration(), m_keyValues, and m_stringValues.

{
   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.reset(new KeyValues(1, std::make_pair(iKey,iConfig) ) );
      } else {
         m_keyValues.reset(new 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;
}

FWConfiguration & FWConfiguration::addValue

(

const std::string &

iValue

)

Definition at line 104 of file FWConfiguration.cc.

References m_keyValues, and m_stringValues.

Referenced by FWTableViewManager::addToImpl(), and stringValues().

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

const KeyValues* FWConfiguration::keyValues ( ) const

inline

Definition at line 58 of file FWConfiguration.h.

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().

                                      {
      return m_keyValues.get();
   }

FWConfiguration & FWConfiguration::operator=

(

const FWConfiguration &

rhs

)

Definition at line 51 of file FWConfiguration.cc.

References swap(), and groupFilesInBlocks::temp.

Referenced by FWConfiguration().

{
   //An exception safe implementation is
   FWConfiguration temp(rhs);
   swap(temp);

   return *this;
}

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 214 of file FWConfiguration.cc.

References attrEscape(), keyValues(), AlCaHLTBitMon_QueryRunRegistry::string, stringValues(), and version().

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

{
   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;
}

const StringValues* FWConfiguration::stringValues ( ) const

inline

Definition at line 61 of file FWConfiguration.h.

References addKeyValue(), addValue(), m_stringValues, dataset::name, streamTo(), AlCaHLTBitMon_QueryRunRegistry::string, and swap().

Referenced by FWTableViewManager::setFrom(), and streamTo().

                                            {
      return m_stringValues.get();
   }

void FWConfiguration::swap

(

FWConfiguration &

iRHS

)

Definition at line 118 of file FWConfiguration.cc.

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

Referenced by FWPartialConfigGUI::FWPartialConfigGUI(), operator=(), stringValues(), and FWPartialConfigSaveGUI::WriteConfig().

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

const std::string & FWConfiguration::value

(

unsigned int

iIndex = 0

)

const

Definition at line 129 of file FWConfiguration.cc.

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__(), attrEscape(), average.Average::average(), Vispa.Views.PropertyView.FileProperty::buttonClicked(), Types.string::configValue(), Types.FileInPath::configValue(), Mixins.UsingBlock::dumpPython(), Types.int32::insertInto(), Types.uint32::insertInto(), Types.int64::insertInto(), Types.uint64::insertInto(), Types.double::insertInto(), Mixins.UsingBlock::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(), Vispa.Views.PropertyView.FileProperty::labelDoubleClicked(), CmsAnnotation::setFrom(), FWEventAnnotation::setFrom(), FWLegoViewBase::setFrom(), FWRPZView::setFrom(), FW3DViewBase::setFrom(), CmsShowCommon::setFrom(), FWTriggerTableView::setFrom(), FWTableView::setFrom(), CmsShowNavigator::setFrom(), FWGUIManager::setFrom(), FWEveView::setFromOrthoCamera(), FWEveView::setFromPerspectiveCamera(), CmsShowCommon::setGeomTransparency(), FWGeometryTableViewBase::setTopNodePathFromConfig(), and FWGUIManager::setWindowInfoFrom().

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

const FWConfiguration * FWConfiguration::valueForKey

(

const std::string &

iKey

)

const

Definition at line 138 of file FWConfiguration.cc.

References plotBeamSpotDB::first, m_keyValues, m_stringValues, and AlCaHLTBitMon_QueryRunRegistry::string.

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

{
   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(),
                                             boost::bind(&std::pair<std::string,FWConfiguration>::first,_1) == iKey);
   if(itFind == m_keyValues->end()) {
      return nullptr;
   }
   return &(itFind->second);
}

unsigned int FWConfiguration::version ( ) const

inline

Definition at line 54 of file FWConfiguration.h.

References m_version.

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

                                {
      return m_version;
   }

Member Data Documentation

boost::scoped_ptr<std::vector<std::pair< std::string, FWConfiguration> > > FWConfiguration::m_keyValues

private

Definition at line 80 of file FWConfiguration.h.

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

boost::scoped_ptr<std::vector<std::string> > FWConfiguration::m_stringValues

private

Definition at line 79 of file FWConfiguration.h.

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

unsigned int FWConfiguration::m_version

private

Definition at line 81 of file FWConfiguration.h.

Referenced by swap(), and version().