Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

ObjCryst::WXOptimizationObj Class Reference

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

Inheritance diagram for ObjCryst::WXOptimizationObj:

Inheritance graph
[legend]
Collaboration diagram for ObjCryst::WXOptimizationObj:

Collaboration graph
[legend]
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 OptimizationObjGetOptimizationObj ()=0
virtual const OptimizationObjGetOptimizationObj () 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.


Protected Attributes

WXCrystMenuBarmpMenuBar
WXGlobalOptimRunThreadmpGlobalOptimRunThread
WXFieldPar< long > * mpWXFieldNbTrial
RefinableObjClock mClockParamSetWindow
 Record when the window giving the list of recorded parameter set was created.


Detailed Description

WX Class for a Global Optimization objects.


Constructor & Destructor Documentation

ObjCryst::WXOptimizationObj::WXOptimizationObj wxWindow *  parent,
OptimizationObj
 


Member Function Documentation

virtual void ObjCryst::WXOptimizationObj::AddRefinedObject RefinableObj obj  )  [virtual]
 

Added by the library.

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 const OptimizationObj& ObjCryst::WXOptimizationObj::GetOptimizationObj  )  const [pure virtual]
 

Implemented in ObjCryst::WXMonteCarloObj.

virtual OptimizationObj& ObjCryst::WXOptimizationObj::GetOptimizationObj  )  [pure virtual]
 

Implemented in ObjCryst::WXMonteCarloObj.

virtual void ObjCryst::WXOptimizationObj::OnAddRefinedObject wxCommandEvent &  WXUNUSED(event)  )  [virtual]
 

From the menu.

virtual void ObjCryst::WXOptimizationObj::OnBrowseParamSet wxCommandEvent &  WXUNUSED(event)  )  [virtual]
 

Opens a window where the stored parameter set can be selected.

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::OnLoad  )  [virtual]
 

virtual void ObjCryst::WXOptimizationObj::OnRemoveRefinedObject wxCommandEvent &  WXUNUSED(event)  )  [virtual]
 

From the menu.

virtual void ObjCryst::WXOptimizationObj::OnRunOptimization wxCommandEvent &  WXUNUSED(event)  )  [pure virtual]
 

Launches the optimization run.

virtual void ObjCryst::WXOptimizationObj::OnSave  )  [virtual]
 

virtual void ObjCryst::WXOptimizationObj::OnSelectParamSet wxCommandEvent &  WXUNUSED(event)  )  [virtual]
 

Restore one parameter set.

virtual void ObjCryst::WXOptimizationObj::OnStopOptimization wxCommandEvent &  WXUNUSED(event)  )  [virtual]
 

virtual void ObjCryst::WXOptimizationObj::OnUpdateUI wxUpdateUIEvent &  event  )  [virtual]
 

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.


Member Data Documentation

RefinableObjClock ObjCryst::WXOptimizationObj::mClockParamSetWindow [protected]
 

Record when the window giving the list of recorded parameter set was created.

WXGlobalOptimRunThread* ObjCryst::WXOptimizationObj::mpGlobalOptimRunThread [protected]
 

WXCrystMenuBar* ObjCryst::WXOptimizationObj::mpMenuBar [protected]
 

WXFieldPar<long>* ObjCryst::WXOptimizationObj::mpWXFieldNbTrial [protected]
 

Reimplemented in ObjCryst::WXMonteCarloObj.


The documentation for this class was generated from the following file:
Generated on Tue Nov 14 15:06:47 2006 for ObjCryst++ by doxygen 1.3.6