Panda3D
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
Job Class Reference
Inheritance diagram for Job:
DirectObject CheckContainers ContainerLeakDetector FPTObjsNamed FPTObjsOfType FindContainers PruneObjectRefs ContainerReport GarbageReport TestJob _MessageListenerTypeLeakDetectorCreator _MessageTypeLeakDetectorCreator MessengerLeakDetector ReferrerSearch

Public Member Functions

 __init__ (self, name)
 
 destroy (self)
 
 finished (self)
 
 getFinishedEvent (self)
 
 getJobName (self)
 
 getPriority (self)
 
 isFinished (self)
 
 printingBegin (self)
 
 printingEnd (self)
 
 resume (self)
 
 run (self)
 
 setPriority (self, priority)
 
 suspend (self)
 
- Public Member Functions inherited from DirectObject
 accept (self, event, method, extraArgs=[])
 
 acceptOnce (self, event, method, extraArgs=[])
 
 addTask (self, *args, **kwargs)
 
 detectLeaks (self)
 
 doMethodLater (self, *args, **kwargs)
 
 getAllAccepting (self)
 
 ignore (self, event)
 
 ignoreAll (self)
 
 isAccepting (self, event)
 
 isIgnoring (self, event)
 
 removeAllTasks (self)
 
 removeTask (self, taskOrName)
 

Static Public Attributes

 Continue = None
 yield None is acceptable in place of yield Job.Continue
 
 Done = object()
 Yielded from the run() generator method when the job is done.
 
 Priorities = ScratchPad(Min=1, Low=100, Normal=1000, High=10000)
 
 Sleep = object()
 Yield any remaining time for this job until next frame.
 
- Static Public Attributes inherited from DirectObject
 accept_once = acceptOnce
 
 add_task = addTask
 
 detect_leaks = detectLeaks
 
 do_method_later = doMethodLater
 
 get_all_accepting = getAllAccepting
 
 ignore_all = ignoreAll
 
 is_accepting = isAccepting
 
 is_ignoring = isIgnoring
 
 remove_all_tasks = removeAllTasks
 
 remove_task = removeTask
 

Protected Member Functions

 _cleanupGenerator (self)
 
 _getGenerator (self)
 
 _getJobId (self)
 
 _setFinished (self)
 
- Protected Member Functions inherited from DirectObject
 _addTask (self, task)
 
 _clearTask (self, task)
 

Protected Attributes

 _finished
 
 _generator
 
 _id
 
 _name
 
 _printing
 
 _priority
 
 _pstats
 
- Protected Attributes inherited from DirectObject
 _taskList
 

Static Protected Attributes

 _SerialGen = SerialNumGen()
 

Detailed Description

Base class for cpu-intensive or non-time-critical operations that
are run through the :class:`.JobManager`.

To use, subclass and override the `run()` method.

Constructor & Destructor Documentation

◆ __init__()

__init__ ( self,
name )

Member Function Documentation

◆ _cleanupGenerator()

_cleanupGenerator ( self)
protected

◆ _getGenerator()

_getGenerator ( self)
protected

◆ _getJobId()

_getJobId ( self)
protected

◆ _setFinished()

_setFinished ( self)
protected

◆ destroy()

destroy ( self)

◆ finished()

finished ( self)

◆ getFinishedEvent()

getFinishedEvent ( self)

◆ getJobName()

getJobName ( self)

◆ getPriority()

getPriority ( self)

◆ isFinished()

isFinished ( self)

◆ printingBegin()

printingBegin ( self)

◆ printingEnd()

printingEnd ( self)

◆ resume()

resume ( self)
Called every time JobManager is going to start running this job.

◆ run()

run ( self)
This should be overridden with a generator that does the
needful processing.

yield `Job.Continue` when possible/reasonable, and try not to run
longer than the JobManager's timeslice between yields.

When done, yield `Job.Done`.

Reimplemented in FindContainers, CheckContainers, FPTObjsOfType, FPTObjsNamed, PruneObjectRefs, ContainerLeakDetector, ContainerReport, GarbageReport, TestJob, _MessageTypeLeakDetectorCreator, _MessageListenerTypeLeakDetectorCreator, MessengerLeakDetector, and ReferrerSearch.

◆ setPriority()

setPriority ( self,
priority )

◆ suspend()

suspend ( self)
Called when JobManager is going to stop running this job for a
while.

Member Data Documentation

◆ _finished

_finished
protected

◆ _generator

_generator
protected

◆ _id

_id
protected

◆ _name

_name
protected

◆ _printing

_printing
protected

◆ _priority

_priority
protected

◆ _pstats

_pstats
protected

◆ _SerialGen

_SerialGen = SerialNumGen()
staticprotected

◆ Continue

Continue = None
static

yield None is acceptable in place of yield Job.Continue

◆ Done

Done = object()
static

Yielded from the run() generator method when the job is done.

◆ Priorities

Priorities = ScratchPad(Min=1, Low=100, Normal=1000, High=10000)
static

◆ Sleep

Sleep = object()
static

Yield any remaining time for this job until next frame.