ObjCryst::WXOptimizationObj Class Reference

WX Class for a Global Optimization objects. More...

Inheritance diagram for ObjCryst::WXOptimizationObj:

List of all members.

Public Member Functions
	WXOptimizationObj (wxWindow *parent, OptimizationObj *)
virtual void	CrystUpdate (const bool updateUI=false, const bool mutexlock=false)
	Get new values to be displayed from the underlying object, and raise flag if an UI update is necessary.
virtual bool	OnChangeName (const int id)
	When a WXFieldName has been changed by the user, it is handled here.
virtual void	OnSave ()
virtual void	OnLoad ()
virtual void	OnAddRefinedObject (wxCommandEvent &WXUNUSED(event))
	From the menu.
virtual void	AddRefinedObject (RefinableObj &obj)
	Added by the library.
virtual void	OnRemoveRefinedObject (wxCommandEvent &WXUNUSED(event))
	From the menu.
virtual void	OnRunOptimization (wxCommandEvent &WXUNUSED(event))=0
	Launches the optimization run.
virtual void	OnStopOptimization (wxCommandEvent &WXUNUSED(event))
virtual OptimizationObj &	GetOptimizationObj ()=0
virtual const OptimizationObj &	GetOptimizationObj () const =0
virtual void	OnUpdateUI (wxUpdateUIEvent &event)
virtual void	UpdateUI (const bool mutexlock=false)
	Update the User Interface, if necessary.
virtual void	OnBrowseParamSet (wxCommandEvent &WXUNUSED(event))
	Opens a window where the stored parameter set can be selected.
virtual void	OnSelectParamSet (wxCommandEvent &WXUNUSED(event))
	Restore one parameter set.
Public Member Functions inherited from ObjCryst::WXCrystObj
	WXCrystObj (wxWindow *parent, int orient=wxHORIZONTAL, bool showName=true)
	Constructor, with a.
void	OnToggleCollapse (wxCommandEvent &WXUNUSED(event))
	Only display the title, and collapse everything else.
virtual void	OnEnable (wxUpdateUIEvent &event)
virtual bool	Enable (bool enable)
virtual void	BottomLayout (WXCrystObjBasic *pChild)
	Ask for a new Layout with recalculated size hints, because a child has been changed or added.
virtual void	AddChild (WXCrystObjBasic *pChild, bool doBottomLayout=true)
	Notify that a new children has been added, also adding it to the correct sizer (which can be the top sizer or not).
Public Member Functions inherited from ObjCryst::WXCrystObjBasic
	WXCrystObjBasic (wxWindow *parent)
	Constructor.
virtual	~WXCrystObjBasic ()
	Destructor.
void	AddedToList (WXCrystObjBasicList *list)
void	RemovedFromList (WXCrystObjBasicList *list)
virtual bool	Layout ()
virtual void	SetToolTip (const wxString &tip)
	Set tooltip for this window.

Protected Attributes
WXCrystMenuBar *	mpMenuBar
WXGlobalOptimRunThread *	mpGlobalOptimRunThread
WXFieldPar< long > *	mpWXFieldNbTrial
RefinableObjClock	mClockParamSetWindow
	Record when the window giving the list of recorded parameter set was created.
wxListBox *	mpwxParamSetList
	Window giving the list of recorded parameter sets.
Protected Attributes inherited from ObjCryst::WXCrystObj
wxBoxSizer *	mpTopSizer
	Top sizer including the title and WXCrystObj::mpSizer.
wxBoxSizer *	mpSizer
	Sizer including all sub-objects.
WXFieldName *	mpWXTitle
	The title.
bool	mIsExpanded
	To be used for collapsing the sub-objects.
WXCrystObjBasicList	mList
	All windows but the title and collapse button are in this list.
wxButton *	mpCollapseButton
	The collapse button.
Protected Attributes inherited from ObjCryst::WXCrystObjBasic
WXCrystObjBasic *	mWXCrystParent
	Parent, if a WXCrystObjBasic itself.
bool	mIsShown
	Is the the window currently shown ?
bool	mNeedUpdateUI
	Do we need to update the display ?
CrystMutex	mMutex
	Mutex used to lock data when preparing to update the UI in non-main thread.
std::set< WXCrystObjBasicList * >	mvpList
	WXCrystObjBasicList which are aware of this object, and which should be told on destruction.

---

Detailed Description

WX Class for a Global Optimization objects.

---

Member Function Documentation

virtual void ObjCryst::WXOptimizationObj::CrystUpdate ( const bool  updateUI = false, const bool  mutexlock = false  )

virtual

Get new values to be displayed from the underlying object, and raise flag if an UI update is necessary.

The actual GUI update is not made here. UpdateUI() should be called separately, from the main thread.

Parameters:

updateUI,:	if true, this will call UpdateUI, either directly (if in the main thread), or by sending a message.
mutexlock,:	if true, a Mutex will be used to lock the data shared between main and background thread. The idea is to only use a few Mutexes to lock data from the top objects (wxRefinableObj,...), when calling CrystUpdate() and UpdateUI(). As sub-objects (WXField,...) are only updated from within a top object, the mutex lock in the top object will also lock the data in the sub-objects.

Reimplemented from ObjCryst::WXCrystObj.

virtual bool ObjCryst::WXOptimizationObj::OnChangeName ( const int  id )

virtual

When a WXFieldName has been changed by the user, it is handled here.

This returns true if the value has been handled (for inheritance purposes).

Implements ObjCryst::WXCrystObj.

virtual void ObjCryst::WXOptimizationObj::UpdateUI ( const bool  mutexlock = false )

virtual

Update the User Interface, if necessary.

Parameters:

mutexlock,:

if true, a Mutex will be used to lock the data shared between main and background thread.

The idea is to only use a few Mutexes to lock data from the top objects (wxRefinableObj,...), when calling CrystUpdate() and UpdateUI(). As sub-objects (WXField,...) are only updated from within a top object, the mutex lock in the top object will also lock the data in the sub-objects.

Reimplemented from ObjCryst::WXCrystObj.

---

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

• wxGlobalOptimObj.h