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 ()
	FWParameterSetterBase (const FWParameterSetterBase &)=delete
const FWParameterSetterBase &	operator= (const FWParameterSetterBase &)=delete
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

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() [1/2]

FWParameterSetterBase::FWParameterSetterBase

(

)

Definition at line 40 of file FWParameterSetterBase.cc.

: m_frame(nullptr) {}

~FWParameterSetterBase()

FWParameterSetterBase::~FWParameterSetterBase ( )

virtual

Definition at line 47 of file FWParameterSetterBase.cc.

{}

FWParameterSetterBase() [2/2]

FWParameterSetterBase::FWParameterSetterBase ( const FWParameterSetterBase &  )

delete

Member Function Documentation

attach() [1/2]

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

Definition at line 65 of file FWParameterSetterBase.cc.

References m_frame.

                                                                                              {
  m_frame = iFrame;
  attach(iBase);
}

attach() [2/2]

virtual void FWParameterSetterBase::attach ( FWParameterBase *  )

privatepure virtual

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

build()

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

pure virtual

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

frame()

FWParameterSetterEditorBase* FWParameterSetterBase::frame ( ) const

inlineprotected

Definition at line 51 of file FWParameterSetterBase.h.

References m_frame.

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

{ return m_frame; }

makeSetterFor()

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

static

Definition at line 83 of file FWParameterSetterBase.cc.

References edm::ObjectWithDict::address(), cms::cuda::assert(), edm::TypeWithDict::byName(), edm::TypeWithDict::destruct(), edm::TypeWithDict::friendlyClassName(), fwLog, fwlog::kError, fwlog::kWarning, Skims_PA_cff::name, FWParameterBase::name(), edm::TypeWithDict::name(), AlCaHLTBitMon_ParallelJobs::p, and AlCaHLTBitMon_QueryRunRegistry::string.

Referenced by ViewerParameterGUI::addParam(), FWViewEnergyScaleEditor::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 == "FWGenericParameterWithRange<double>")
      name = "FWDoubleParameterSetter";
    else if (name == "FWGenericParameterWithRange<long int>")
      name = "FWLongParameterSetter";
    else if (name == "FWGenericParameterWithRange<long>")
      name = "FWLongParameterSetter";
    else if (paramClass.friendlyClassName() == "StringFWGenericParameter")
      name = "FWStringParameterSetter";
    else {
      name += "Setter";
      fwLog(fwlog::kWarning) << "can't find setter type for " << iParam->name() << ", guessing to " << name << "\n";
    }
    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, std::bind(&edm::TypeWithDict::destruct, itFind->second, setterObj.address(), true));
  return ptr;
}

operator=()

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

delete

setEnabled()

void FWParameterSetterBase::setEnabled ( bool  )

virtual

Reimplemented in FWEnumParameterSetter, FWDoubleParameterSetter, and FWBoolParameterSetter.

Definition at line 139 of file FWParameterSetterBase.cc.

{}

update()

void FWParameterSetterBase::update ( ) const

protected

Definition at line 74 of file FWParameterSetterBase.cc.

References m_frame, and FWParameterSetterEditorBase::updateEditor().

Referenced by progressbar.ProgressBar::__next__(), MatrixUtil.Matrix::__setitem__(), MatrixUtil.Steps::__setitem__(), FWStringParameterSetter::doUpdate(), FWBoolParameterSetter::doUpdate(), FWLongParameterSetter::doUpdate(), FWDoubleParameterSetter::doUpdate(), FWEnumParameterSetter::doUpdate(), progressbar.ProgressBar::finish(), and MatrixUtil.Steps::overwrite().

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

Member Data Documentation

m_frame

FWParameterSetterEditorBase* FWParameterSetterBase::m_frame

private

Definition at line 62 of file FWParameterSetterBase.h.

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