TranslationJob.TranslationJob Class Reference
Detailed Description
This class is used to store a translation job.
A translation job consists of the following information: a translation server instance an input (source) file an output (destination) file a journal file, used by Aruba to control the tessellation the import node's unique node identifier a translation job identifier, stored here as a string, can be treated as an opaque type. a status string
#include
<class_translation_job_1_1_translation_job.h>
Public Member Functions |
|
| __init__ () | |
| __eq__ () | |
| Equality test: returns True if self ==
other. |
|
| __ne__ () | |
| Inequality test: returns True if self !=
other. |
|
| clone () | |
| start () | |
| stop () | |
| Stops an active translation job. |
|
| getInputFileName () | |
| setInputFileName () | |
| getOutputFileName () | |
| getJournalFileName () | |
| getModelImport () | |
| getImportNodeID () | |
| getStatus () | |
| getOptions () | |
| getImportSettings () | |
| getTranslationServer () | |
| isActive () | |
| Returns True if this translation job has a
job identifier, but its status is currently unknown or the job is
idle/running. |
|
| isDone () | |
| Returns True if this translation job's
status shows that it's done. |
|
| isFailed () | |
| Returns True if this translation job's
status shows that it failed. |
|
| updateStatus () | |
| If this translation job is still active,
then query the Translation Server to find out how it's doing.
|
|
| getLog () | |
| Return the log for the specified translation
job. |
|
Member Function Documentation
| TranslationJob.TranslationJob.__init__ | ( | ) |
| TranslationJob.TranslationJob.__eq__ | ( | ) |
Equality test: returns True if self == other.
Uses the import node identifier as the basis for the comparison.
| TranslationJob.TranslationJob.__ne__ | ( | ) |
Inequality test: returns True if self != other.
Uses the import node identifier as the basis for the comparison.
| TranslationJob.TranslationJob.clone | ( | ) |
| TranslationJob.TranslationJob.start | ( | ) |
| TranslationJob.TranslationJob.stop | ( | ) |
Stops an active translation job.
| TranslationJob.TranslationJob.getInputFileName | ( | ) |
| TranslationJob.TranslationJob.setInputFileName | ( | ) |
| TranslationJob.TranslationJob.getOutputFileName | ( | ) |
| TranslationJob.TranslationJob.getJournalFileName | ( | ) |
| TranslationJob.TranslationJob.getModelImport | ( | ) |
| TranslationJob.TranslationJob.getImportNodeID | ( | ) |
| TranslationJob.TranslationJob.getStatus | ( | ) |
| TranslationJob.TranslationJob.getOptions | ( | ) |
| TranslationJob.TranslationJob.getImportSettings | ( | ) |
| TranslationJob.TranslationJob.getTranslationServer | ( | ) |
| TranslationJob.TranslationJob.isActive | ( | ) |
Returns True if this translation job has a job identifier, but its status is currently unknown or the job is idle/running.
| TranslationJob.TranslationJob.isDone | ( | ) |
Returns True if this translation job's status shows that it's done.
| TranslationJob.TranslationJob.isFailed | ( | ) |
Returns True if this translation job's status shows that it failed.
| TranslationJob.TranslationJob.updateStatus | ( | ) |
If this translation job is still active, then query the Translation Server to find out how it's doing.
| TranslationJob.TranslationJob.getLog | ( | ) |
Return the log for the specified translation job.
