Hide menu
Loading...
Searching...
No Matches
manufacturingtoolkit.CadExMTK.ProgressStatus_Observer Class Reference

ProgressStatus.Observer ProgressStatus.hxx cadex/Base/ProgressStatus.hxx. More...

Inheritance diagram for manufacturingtoolkit.CadExMTK.ProgressStatus_Observer:

Public Member Functions

 __init__ (self)
 Constructor.
 
 ChangedValue (self, theStatus)
 A callback called when the progress status has changed its value.
 
 Completed (self, theStatus)
 A callback called when the progress status object is being destructed.
 
 Canceled (self, theStatus)
 
 SetNotifyingThread (self, *args)
 Overload 1: Sets the current thread as the only thread sending notifications.
 
 SetAllNotifyingThreads (self)
 Enables sending notifications from any thread.
 
 CanBeNotifiedFromThisThread (self)
 Returns true if notifications can be send from the current thread.
 
 __disown__ (self)
 

Detailed Description

ProgressStatus.Observer ProgressStatus.hxx cadex/Base/ProgressStatus.hxx.

Base abstract class for observers registered in ProgressStatus.

Subclasses must redefined virtual functions ChangedValue() and Completed(). User-defined observers must be registered in the progress status object with the help of ProgressStatus.Register().

By default the observer will only be notified in the same thread it was created. This is to minimize a risk of data race in multi-threaded applications if the user-defined observer is not thread-safe. To enable notifications from other threads use SetAllNotifyingThreads() to allow notifications from any thread or different syntaxes of SetNotifyingThread() to enable notifications from single thread.

Constructor & Destructor Documentation

◆ __init__()

manufacturingtoolkit.CadExMTK.ProgressStatus_Observer.__init__ ( self)

Constructor.

Default constructor.

Member Function Documentation

◆ ChangedValue()

manufacturingtoolkit.CadExMTK.ProgressStatus_Observer.ChangedValue ( self,
theStatus )

A callback called when the progress status has changed its value.

Subclasses must redefine this method to process this event.

◆ Completed()

manufacturingtoolkit.CadExMTK.ProgressStatus_Observer.Completed ( self,
theStatus )

A callback called when the progress status object is being destructed.

Subclasses must redefine this method to process this event.

◆ SetNotifyingThread()

manufacturingtoolkit.CadExMTK.ProgressStatus_Observer.SetNotifyingThread ( self,
* args )

Overload 1: Sets the current thread as the only thread sending notifications.

|

Overload 2: Sets the same notification thread as used by theOther observer.


The documentation for this class was generated from the following file:
  • CadExMTK.py