Uranium
Application Framework
UM.FileHandler.WriteFileJob.WriteFileJob Class Reference

A Job subclass that performs writing. More...

Inheritance diagram for UM.FileHandler.WriteFileJob.WriteFileJob:
UM.Job.Job UM.Mesh.WriteMeshJob.WriteMeshJob

Public Member Functions

def __init__ (self, writer, stream, data, mode)
 Creates a new job for writing. More...
 
def setFileName (self, name)
 
def getFileName (self)
 
def getStream (self)
 
def setMessage (self, message)
 Set the message associated with this job.
 
def getMessage (self)
 
def run (self)
 Perform the actual task of this job. More...
 
- Public Member Functions inherited from UM.Job.Job
def __init__ (self)
 
def getResult (self)
 Get the result of the job. More...
 
def setResult (self, any result)
 Set the result of this job. More...
 
def setError (self, Exception error)
 Set an exception that was thrown while the job was being executed. More...
 
def start (self)
 Start the job. More...
 
def cancel (self)
 Cancel the job. More...
 
bool isRunning (self)
 Check whether the job is currently running. More...
 
bool isFinished (self)
 Check whether the job has finished processing. More...
 
bool hasError (self)
 Check whether the Job has encountered an error during execution. More...
 
Exception getError (self)
 Get the error that was encountered during execution. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from UM.Job.Job
def yieldThread ()
 Utility function that allows us to yield thread processing. More...
 
- Static Public Attributes inherited from UM.Job.Job
 finished = Signal()
 Emitted when the job has finished processing. More...
 
 progress = Signal()
 Emitted when the job processing has progressed. More...
 

Detailed Description

A Job subclass that performs writing.

The writer defines what the result of this job is.

Constructor & Destructor Documentation

◆ __init__()

def UM.FileHandler.WriteFileJob.WriteFileJob.__init__ (   self,
  writer,
  stream,
  data,
  mode 
)

Creates a new job for writing.

Parameters
writerThe file writer to use, with the correct MIME type.
streamThe output stream to write to.
dataWhatever it is what we want to write.
modeAdditional information to send to the writer, for example: such as whether to write in binary format or in ASCII format.

Reimplemented in UM.Mesh.WriteMeshJob.WriteMeshJob.

Member Function Documentation

◆ run()

def UM.FileHandler.WriteFileJob.WriteFileJob.run (   self)

Perform the actual task of this job.

Should be reimplemented by subclasses.

Exceptions
NotImplementedError

Reimplemented from UM.Job.Job.


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