FWParameterSetterBase Class Reference

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

Inheritance diagram for FWParameterSetterBase:

Public Member Functions
void	attach (FWParameterBase *, FWParameterSetterEditorBase *)
virtual TGFrame *	build (TGFrame *iParent, bool labelBack=true)=0
	FWParameterSetterBase ()
virtual void	setEnabled (bool)
virtual	~FWParameterSetterBase ()

Static Public Member Functions
static std::shared_ptr< FWParameterSetterBase >	makeSetterFor (FWParameterBase *)

Protected Member Functions
FWParameterSetterEditorBase *	frame () const
void	update () const

Private Member Functions
virtual void	attach (FWParameterBase *)=0
	FWParameterSetterBase (const FWParameterSetterBase &)=delete
const FWParameterSetterBase &	operator= (const FWParameterSetterBase &)=delete

Private Attributes
FWParameterSetterEditorBase *	m_frame

Detailed Description

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

Usage: <usage>

Definition at line 31 of file FWParameterSetterBase.h.

Constructor & Destructor Documentation

FWParameterSetterBase::FWParameterSetterBase

(

)

Definition at line 40 of file FWParameterSetterBase.cc.

Referenced by frame().

                                             :
   m_frame(nullptr)
{
}

FWParameterSetterBase::~FWParameterSetterBase ( )

virtual

Definition at line 50 of file FWParameterSetterBase.cc.

{
}

FWParameterSetterBase::FWParameterSetterBase ( const FWParameterSetterBase &  )

privatedelete

Member Function Documentation

void FWParameterSetterBase::attach	(	FWParameterBase *	iBase,
		FWParameterSetterEditorBase *	iFrame
	)

Definition at line 71 of file FWParameterSetterBase.cc.

References m_frame.

Referenced by frame().

{
   m_frame=iFrame;
   attach(iBase);
}

virtual void FWParameterSetterBase::attach ( FWParameterBase *  )

privatepure virtual

Implemented in FWEnumParameterSetter, FWDoubleParameterSetter, FWBoolParameterSetter, FWLongParameterSetter, and FWStringParameterSetter.

virtual TGFrame* FWParameterSetterBase::build ( TGFrame *  iParent, bool  labelBack = true  )

pure virtual

Implemented in FWDoubleParameterSetter, FWEnumParameterSetter, FWBoolParameterSetter, FWLongParameterSetter, and FWStringParameterSetter.

FWParameterSetterEditorBase* FWParameterSetterBase::frame ( ) const

inlineprotected

Definition at line 52 of file FWParameterSetterBase.h.

References attach(), FWParameterSetterBase(), m_frame, and operator=().

Referenced by FWStringParameterSetter::build(), FWLongParameterSetter::build(), FWBoolParameterSetter::build(), FWEnumParameterSetter::build(), and FWDoubleParameterSetter::build().

{ return m_frame; }

std::shared_ptr< FWParameterSetterBase > FWParameterSetterBase::makeSetterFor ( FWParameterBase *  iParam )

static

Definition at line 94 of file FWParameterSetterBase.cc.

References edm::ObjectWithDict::address(), edm::TypeWithDict::byName(), edm::TypeWithDict::destruct(), fwLog, fwlog::kError, dataset::name, edm::TypeWithDict::name(), AlCaHLTBitMon_ParallelJobs::p, and AlCaHLTBitMon_QueryRunRegistry::string.

Referenced by FWViewEnergyScaleEditor::addParam(), ViewerParameterGUI::addParam(), FWGeometryTableView::FWGeometryTableView(), CmsShowCommonPopup::makeSetter(), and FWProxyBuilderConfiguration::makeSetter().

{
   static std::map<edm::TypeID,edm::TypeWithDict> s_paramToSetterMap;
   edm::TypeID paramType( typeid(*iParam) );
   std::map<edm::TypeID,edm::TypeWithDict>::iterator itFind = s_paramToSetterMap.find(paramType);
   if (itFind == s_paramToSetterMap.end())
   {
      edm::TypeWithDict paramClass(typeid(*iParam));
      if (paramClass == edm::TypeWithDict())
      {
         fwLog(fwlog::kError) << " the type "<<typeid(*iParam).name()<< " is not known to Root" <<std::endl;
      }
      assert(paramClass != edm::TypeWithDict() );

      //the corresponding setter has the same name but with 'Setter' at the end
      std::string name = paramClass.name();
      // FIXME: there was a convention between parameter class names and associated
      //        setters. The following works around the problem introduced by
      //        the generic parameter class but it is clear that a better 
      //        way of doing the binding is required. Notice that there are only 5 
      //        different type of FW*Parameter.
      if (name == "FWGenericParameter<bool>")
         name = "FWBoolParameterSetter";
      else if (name == "FWGenericParameter<std::string>")
         name = "FWStringParameterSetter";
      else if (name == "FWGenericParameter<std::basic_string<char> >")
         name = "FWStringParameterSetter"; 
      else if (name == "FWGenericParameterWithRange<double>")
         name = "FWDoubleParameterSetter";
      else if (name == "FWGenericParameterWithRange<long int>")
         name = "FWLongParameterSetter";
      else if (name == "FWGenericParameterWithRange<long>")
         name = "FWLongParameterSetter";
      else
         name += "Setter";

      edm::TypeWithDict setterClass( edm::TypeWithDict::byName( name ) );
      if (setterClass == edm::TypeWithDict())
      {
         fwLog(fwlog::kError) << " the type "<<name<< " has no dictionary" <<std::endl;
      }
      assert(setterClass != edm::TypeWithDict());

      s_paramToSetterMap[paramType]=setterClass;
      itFind = s_paramToSetterMap.find(paramType);
   }
   //create the instance we want
   //NOTE: 'construct' will use 'malloc' to allocate the memory if the object is not of class type.
   // This means the object cannot be deleted using 'delete'!  So we must call destruct on the object.
   edm::ObjectWithDict setterObj = itFind->second.construct();

   //make it into the base class
   FWParameterSetterBase* p = static_cast<FWParameterSetterBase*>(setterObj.address());
   //Make a shared pointer to the base class that uses a destructor for the derived class, in order to match the above construct call.
   std::shared_ptr<FWParameterSetterBase> ptr(p, boost::bind(&edm::TypeWithDict::destruct,itFind->second,setterObj.address(),true));
   return ptr;
}

const FWParameterSetterBase& FWParameterSetterBase::operator= ( const FWParameterSetterBase &  )

privatedelete

Referenced by frame().

void FWParameterSetterBase::setEnabled ( bool  )

virtual

Reimplemented in FWDoubleParameterSetter, FWEnumParameterSetter, and FWBoolParameterSetter.

Definition at line 154 of file FWParameterSetterBase.cc.

Referenced by Vispa.Views.PropertyView.BooleanProperty::setReadOnly(), and Vispa.Views.PropertyView.DropDownProperty::setReadOnly().

{
}

void FWParameterSetterBase::update ( ) const

protected

Definition at line 83 of file FWParameterSetterBase.cc.

References m_frame, and FWParameterSetterEditorBase::updateEditor().

Referenced by progressbar.ProgressBar::__next__(), MatrixUtil.Matrix::__setitem__(), MatrixUtil.Steps::__setitem__(), Vispa.Gui.VispaWidget.VispaWidget::autosize(), Vispa.Views.LineDecayView.LineDecayContainer::createObject(), Vispa.Views.LineDecayView.LineDecayContainer::deselectAllObjects(), Vispa.Gui.VispaWidgetOwner.VispaWidgetOwner::deselectAllWidgets(), FWStringParameterSetter::doUpdate(), FWBoolParameterSetter::doUpdate(), FWLongParameterSetter::doUpdate(), FWEnumParameterSetter::doUpdate(), FWDoubleParameterSetter::doUpdate(), Vispa.Gui.VispaWidget.VispaWidget::enableAutosizing(), progressbar.ProgressBar::finish(), Vispa.Gui.MenuWidget.MenuWidget::leaveEvent(), Vispa.Gui.VispaWidgetOwner.VispaWidgetOwner::mouseMoveEvent(), Vispa.Gui.MenuWidget.MenuWidget::mouseMoveEvent(), Vispa.Views.LineDecayView.LineDecayContainer::mouseMoveEvent(), Vispa.Gui.VispaWidgetOwner.VispaWidgetOwner::mouseReleaseEvent(), Vispa.Views.LineDecayView.LineDecayContainer::objectMoved(), MatrixUtil.Steps::overwrite(), Vispa.Views.LineDecayView.LineDecayContainer::removeObject(), Vispa.Gui.ConnectableWidget.ConnectableWidget::removePorts(), Vispa.Gui.FindDialog.FindDialog::reset(), Vispa.Gui.PortConnection.PointToPointConnection::select(), Vispa.Gui.VispaWidget.VispaWidget::select(), Vispa.Views.LineDecayView.LineDecayContainer::select(), Vispa.Gui.VispaWidget.VispaWidget::setText(), Vispa.Gui.VispaWidget.VispaWidget::setTitle(), Vispa.Gui.ZoomableWidget.ZoomableWidget::setZoom(), Vispa.Views.LineDecayView.LineDecayContainer::setZoom(), and Vispa.Gui.PortConnection.PointToPointConnection::updateConnection().

{
   if (m_frame != nullptr)
      m_frame->updateEditor();
}

Member Data Documentation

FWParameterSetterEditorBase* FWParameterSetterBase::m_frame

private

Definition at line 62 of file FWParameterSetterBase.h.

Referenced by attach(), frame(), and update().